Package org.anchoranalysis.experiment.arguments

Class TaskArguments

Object

org.anchoranalysis.experiment.arguments.TaskArguments

public class TaskArguments
extends Object

Arguments that can further specify an experiment's task in addition to its bean specification.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
TaskArguments()	Creates with no initial size.
TaskArguments(Optional<org.anchoranalysis.image.core.dimensions.size.suggestion.ImageSizeSuggestion> size)	Creates with a specific initial size-suggestion.

Method Summary

Modifier and Type	Method	Description
void	assignGroup(String groupRange)	Assigns an index-range to use to form groups, by subsetting components from each input's identifier.
void	assignMaxNumberProcessors(String numberProcessors)	Assigns a suggested maximum number of processors (CPUs) for a task.
void	assignSize(String size)	Assign dimensions or scaling factor or size for an image, as may be used by a task.
void	assignTaskName(Optional<String> taskName)	Assigns a name for the task.
Optional<IndexRangeNegative>	getGroupIndexRange()	An index-range to use for grouping, by subsetting components from each input's identifier.
Optional<Integer>	getMaxNumberProcessors()	Suggests a maximum number of processors (CPUs) for a task.
Optional<org.anchoranalysis.image.core.dimensions.size.suggestion.ImageSizeSuggestion>	getSize()	Suggests dimensions or a scaling-factor to resize an image to.
Optional<String>	getTaskName()	A name to describe the ongoing task.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TaskArguments

public TaskArguments()

Creates with no initial size.

TaskArguments

public TaskArguments(Optional<org.anchoranalysis.image.core.dimensions.size.suggestion.ImageSizeSuggestion> size)

Creates with a specific initial size-suggestion.

Parameters:

size - the size-suggestion.

Method Details

assignTaskName

public void assignTaskName(Optional<String> taskName)

Assigns a name for the task.

Parameters:

taskName - the name to assign.

assignSize

public void assignSize(String size) throws ExperimentExecutionException

Assign dimensions or scaling factor or size for an image, as may be used by a task.

Parameters:

size - a string describing the size in a format compatible with ImageSizeSuggestionFactory.create(String).

Throws:

ExperimentExecutionException - if the format of size is invalid.

assignGroup

public void assignGroup(String groupRange) throws ExperimentExecutionException

Assigns an index-range to use to form groups, by subsetting components from each input's identifier.

Parameters:

groupRange - a string in the format expected by IndexRangeNegativeFactory.parse(java.lang.String), or an empty-string which is considered as "0".

Throws:

ExperimentExecutionException - if groupRange does have the expected format.

assignMaxNumberProcessors

public void assignMaxNumberProcessors(String numberProcessors) throws ExperimentExecutionException

Assigns a suggested maximum number of processors (CPUs) for a task.

Parameters:

numberProcessors - the maximum number of processors.

Throws:

ExperimentExecutionException - if the string doesn't describe a positive integer.

getTaskName

public Optional<String> getTaskName()

A name to describe the ongoing task.

getSize

public Optional<org.anchoranalysis.image.core.dimensions.size.suggestion.ImageSizeSuggestion> getSize()

Suggests dimensions or a scaling-factor to resize an image to.

getMaxNumberProcessors

public Optional<Integer> getMaxNumberProcessors()

Suggests a maximum number of processors (CPUs) for a task.

getGroupIndexRange

public Optional<IndexRangeNegative> getGroupIndexRange()

An index-range to use for grouping, by subsetting components from each input's identifier.