Package org.anchoranalysis.experiment.arguments

Class OutputArguments

Object
org.anchoranalysis.experiment.arguments.OutputArguments
public class OutputArguments
extends Object
Arguments that can further specify an experiment's output in addition to its bean specification.
Author:
Owen Feehan

  • Constructor Details

  • Method Details

    • assignSuggestedImageOutputFormat

      public void assignSuggestedImageOutputFormat​(ImageFileFormat format)
      Assigns a suggestion for a preferred image-output format.
      Parameters:
      format - the preferred format.

    • requestOutputIncrementingNumberSequence

      public void requestOutputIncrementingNumberSequence()
      Requests outputting with an incrementing number sequence, rather than the usual outputter (normally based upon input filenames).

    • requestOutputSuppressDirectories

      public void requestOutputSuppressDirectories()
      Requests suppressing directories (replacing subdirectory separators with an underscore) in the identifiers that are outputted.

    • requestOmitExperimentIdentifier

      public void requestOmitExperimentIdentifier​(String argument)
      Requests that the experiment-identifier (name and index) is not included in the output-directory path.

      Note that argument is ignored, and retained so as to have a compatible interface with other code.

      Parameters:
      argument - the arguments to the command-line (which are ignored).

    • isOmitExperimentIdentifier

      public boolean isOmitExperimentIdentifier()
      Has a request occurred that the experiment-identifier is omitted?

      i.e. the name and index are not included in the output-directory path.

      Returns:
      true when the experiment-identifier has been requested to be omitted.

    • getPrefixer

      public OutputPrefixerSettings getPrefixer()
      Where outputs are written, and how identifiers are styled.

    • getOutputEnabledDelta

      public OutputEnabledDelta getOutputEnabledDelta()
      Additions/subtractions of outputs for the experiment supplied by the user.

      These are applied to an existing source of output-enabled rules (e.g. defaults from a task, or rules defined in the experiment's OutputManager.