S
- shared-statepublic class QuickExperiment<S> extends Experiment
InputOutputExperiment
where several assumptions are made.Constructor and Description |
---|
QuickExperiment() |
Modifier and Type | Method and Description |
---|---|
void |
checkMisconfigured(BeanInstanceMap defaultInstances)
Checks that a bean's properties conform to expectations.
|
Optional<Path> |
executeExperiment(ExecutionArguments arguments)
Executes the experiment.
|
String |
getDirectoryOutput() |
String |
getFileInput()
A string indicating the input file(s)
|
String |
getInputName() |
OutputWriteSettings |
getOutputWriteSettings() |
Task<MultiInput,S> |
getTask() |
void |
setDirectoryOutput(String directoryOutput) |
void |
setFileInput(String fileInput)
A string indicating the input file(s)
|
void |
setInputName(String inputName) |
void |
setOutputWriteSettings(OutputWriteSettings outputWriteSettings) |
void |
setTask(Task<MultiInput,S> task) |
boolean |
useDetailedLogging()
Whether to log in more or less detail.
|
associateXML, getXMLConfiguration
describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString
public void checkMisconfigured(BeanInstanceMap defaultInstances) throws BeanMisconfiguredException
AnchorBean
checkMisconfigured
in class AnchorBean<Experiment>
defaultInstances
- all available default instances if the DefaultInstance
annotation is usedBeanMisconfiguredException
- if the bean has not been configured properly as XMLpublic Optional<Path> executeExperiment(ExecutionArguments arguments) throws ExperimentExecutionException
Experiment
executeExperiment
in class Experiment
arguments
- arguments that may influence how the experiment is run.ExperimentExecutionException
- if an error occurs executing the experiment.public boolean useDetailedLogging()
Experiment
It's appropriate to perform more detailed logging for a lengthier experiment, but something quick and simple is preferable for a short job, which may only be outputted to the console.
useDetailedLogging
in class Experiment
public String getFileInput()
Either: 1. a file-path to a single image 2. a file glob matching several images (e.g. /somedir/somefile*.png) 3. a file-path ending in .xml or .XML. This is then interpreted treated a a paths to BeanXML describing a NamedMultiCollectionInputManager
public void setFileInput(String fileInput)
Either: 1. a file-path to a single image 2. a file glob matching several images (e.g. /somedir/somefile*.png) 3. a file-path ending in .xml or .XML. This is then interpreted treated a a paths to BeanXML describing a NamedMultiCollectionInputManager
public String getDirectoryOutput()
public void setDirectoryOutput(String directoryOutput)
public Task<MultiInput,S> getTask()
public void setTask(Task<MultiInput,S> task)
public String getInputName()
public void setInputName(String inputName)
public OutputWriteSettings getOutputWriteSettings()
public void setOutputWriteSettings(OutputWriteSettings outputWriteSettings)
Copyright © 2010–2023 Owen Feehan, ETH Zurich, University of Zurich, Hoffmann-La Roche. All rights reserved.