Package org.anchoranalysis.feature.io.results

Class FeatureOutputNames

Object
FeatureOutputNames
public class FeatureOutputNames extends Object
The customizable output names used by LabelledResultsCollector, which all follow a pattern based on a prefix.

The group and aggregated outputs can be toggled on and off.

Author:
Owen Feehan

  • Field Details

    • OUTPUT_DEFAULT_NON_AGGREGATED

      public static final String OUTPUT_DEFAULT_NON_AGGREGATED
      If not otherwise specified, the output name for a non-aggregated CSV of the results.
      See Also:

    • OUTPUT_SUFFIX_AGGREGATED

      public static final String OUTPUT_SUFFIX_AGGREGATED
      Suffix appended to csvFeaturesNonAggregated to form an output-name for aggregated features.
      See Also:

    • OUTPUT_SUFFIX_GROUP

      public static final String OUTPUT_SUFFIX_GROUP
      Suffix appended to csvFeaturesNonAggregated to form an output-name for grouped features.
      See Also:

    • OUTPUT_SUFFIX_AGGREGATED_GROUP

      public static final String OUTPUT_SUFFIX_AGGREGATED_GROUP
      Suffix appended to csvFeaturesNonAggregated to form an output-name for aggregated grouped features.
      See Also:

  • Constructor Details

    • FeatureOutputNames

      public FeatureOutputNames()
      Creates using default names, equivalent to a prefix of features.

      All outputs are enabled.

    • FeatureOutputNames

      public FeatureOutputNames(String prefix, boolean enableAggregated, boolean enableGroup)
      Creates output-names based upon a prefix.
      Parameters:
      prefix - prefix used to determine the output-names.
      enableAggregated - whether to enable the aggregated outputs.
      enableGroup - whether to enable the group outputs.

  • Method Details

    • calculationResultsNeeded

      public boolean calculationResultsNeeded(MultiLevelOutputEnabled outputEnabled)
      If any output is enabled that requires calculation of feature results?
      Parameters:
      outputEnabled - which outputs are enabled or not.
      Returns:
      true if at least one output is enabled that requires calculation of results, false if none do.

    • getCsvFeaturesNonAggregated

      public String getCsvFeaturesNonAggregated()
      The CSV of non-aggregated feature-results.

    • getCsvFeaturesAggregated

      public Optional<String> getCsvFeaturesAggregated()
      The CSV of aggregated feature-results, if enabled.

    • getCsvFeaturesGroup

      public Optional<String> getCsvFeaturesGroup()
      The CSV individually written for each group, if enabled.

    • getXmlAggregatedGroup

      public Optional<String> getXmlAggregatedGroup()
      The name of the XML file outputted with aggregated values for each group, if enabled.