Package org.anchoranalysis.plugin.image.task.feature

Class FeatureExporterContext

Object
org.anchoranalysis.plugin.image.task.feature.FeatureExporterContext
public final class FeatureExporterContext
extends Object
Context for exporting features, containing configuration and output settings.

  • Constructor Summary

    Constructors 
    Constructor Description
    FeatureExporterContext​(org.anchoranalysis.io.output.outputter.InputOutputContext context, boolean removeNaNColumns, boolean visuallyShortenDecimals, boolean suppressErrors)  

  • Method Summary

    Modifier and Type Method Description
    Optional<org.anchoranalysis.feature.io.csv.FeatureCSVWriter> csvWriter​(org.anchoranalysis.feature.io.csv.metadata.FeatureCSVMetadata metadata)
    Creates a FeatureCSVWriter for the non-aggregated results.
    boolean equals​(Object o)  
    org.anchoranalysis.io.output.outputter.InputOutputContext getContext()
    Context for reading from or writing outputs to the file-system.
    int hashCode()  
    boolean isRemoveNaNColumns()
    When true, columns containing all Double.NaN values are removed before outputting.
    boolean isSuppressErrors()
    If false, an image is reported as errored, if any exception is thrown during calculation.
    boolean isVisuallyShortenDecimals()
    When true double values are printed to be as short as possible without losing precision.
    String toString()  

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • FeatureExporterContext

      public FeatureExporterContext​(org.anchoranalysis.io.output.outputter.InputOutputContext context, boolean removeNaNColumns, boolean visuallyShortenDecimals, boolean suppressErrors)

  • Method Details

    • csvWriter

      public Optional<org.anchoranalysis.feature.io.csv.FeatureCSVWriter> csvWriter​(org.anchoranalysis.feature.io.csv.metadata.FeatureCSVMetadata metadata) throws org.anchoranalysis.io.output.error.OutputWriteFailedException
      Creates a FeatureCSVWriter for the non-aggregated results.
      Parameters:
      metadata - the metadata for the CSV file
      Returns:
      an optional FeatureCSVWriter if creation is successful, empty otherwise
      Throws:
      org.anchoranalysis.io.output.error.OutputWriteFailedException - if there's an error creating the CSV writer

    • getContext

      public org.anchoranalysis.io.output.outputter.InputOutputContext getContext()
      Context for reading from or writing outputs to the file-system.

    • isRemoveNaNColumns

      public boolean isRemoveNaNColumns()
      When true, columns containing all Double.NaN values are removed before outputting.

    • isVisuallyShortenDecimals

      public boolean isVisuallyShortenDecimals()
      When true double values are printed to be as short as possible without losing precision.

    • isSuppressErrors

      public boolean isSuppressErrors()
      If false, an image is reported as errored, if any exception is thrown during calculation. If true, then a value of Double.NaN is returned, and a message is written to the error-log.

    • equals

      public boolean equals​(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object