public class OutputPrefixerSettings extends Object
Constructor and Description |
---|
OutputPrefixerSettings() |
Modifier and Type | Method and Description |
---|---|
void |
assignOutputDirectory(Path outputDirectory) |
void |
assignSuggestedImageOutputFormat(ImageFileFormat format)
Assigns a suggestion for a preferred image-output format.
|
void |
checkAbsolutePath() |
Optional<Path> |
getOutputDirectory()
A directory indicating where inputs can be located
|
Optional<ImageFileFormat> |
getSuggestedImageOutputFormat()
A file format suggested for writing images to the file system.
|
boolean |
isOmitExperimentIdentifier()
When true, Requests that the experiment-identifier (name and index) is not included in the
output-directory path.
|
boolean |
isOutputIncrementingNumberSequence()
When true, requests outputting with an incrementing number sequence, rather than the usual
outputter (normally based upon input filenames).
|
String |
maybeSuppressDirectories(String identifier,
boolean forceSuppressDirectories)
Derives an identifier that maybe has its directories suppressed.
|
void |
requestOmitExperimentIdentifier()
Requests that the experiment-identifier (name and index) is not included in the
output-directory path.
|
void |
requestOutputIncrementingNumberSequence()
Requests outputting with an incrementing number sequence, rather than the usual outputter
(normally based upon input filenames).
|
void |
requestOutputSuppressDirectories()
Requests suppressing directories (replacing subdirectory separators with an underscore) in
the identifiers that are outputted.
|
public String maybeSuppressDirectories(String identifier, boolean forceSuppressDirectories)
This can leave identifier
unchanged, or suppress the subdirectories in identifier
by replacing them with underscores.
identifier
- the identifier whose directories are maybe suppressed.forceSuppressDirectories
- if true, forces the suppression of directories, regardless of
outputSuppressDirectories
public void assignOutputDirectory(Path outputDirectory)
public void assignSuggestedImageOutputFormat(ImageFileFormat format)
format
- the preferred format.public void requestOutputIncrementingNumberSequence()
public void requestOutputSuppressDirectories()
public void requestOmitExperimentIdentifier()
public void checkAbsolutePath() throws PathPrefixerException
PathPrefixerException
public Optional<Path> getOutputDirectory()
public Optional<ImageFileFormat> getSuggestedImageOutputFormat()
public boolean isOutputIncrementingNumberSequence()
public boolean isOmitExperimentIdentifier()
Copyright © 2010–2023 Owen Feehan, ETH Zurich, University of Zurich, Hoffmann-La Roche. All rights reserved.