Package org.anchoranalysis.mpp.io.input

Class MultiInput

Object

org.anchoranalysis.mpp.io.input.MultiInput

All Implemented Interfaces:

ProvidesStackInput, org.anchoranalysis.io.input.InputFromManager, ExportSharedObjects

public class MultiInput
extends Object
implements ProvidesStackInput, ExportSharedObjects

An input to an experiment that combines a particular Stack with other types of entities.

These entities each have a unique name, and must be one of the following types:

1. Stack (in addition to the primary stack that forms the input).
2. MarkCollection.
3. ObjectCollection.
4. Dictionary.
5. Histogram.
6. Path.

Author:

Owen Feehan

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_IMAGE_INPUT_NAME	The default name for the input image stack.

Constructor Summary

Constructors

Constructor	Description
MultiInput(String mainObjectName, ProvidesStackInput mainInputObject)	Creates a new MultiInput with a specified name for the main input object.
MultiInput(ProvidesStackInput mainInputObject)	Creates a new MultiInput with a default name for the main input object.

Method Summary

Modifier and Type	Method	Description
void	addToStoreInferNames(NamedProviderStore<TimeSeries> stacks, int seriesIndex, Logger logger)
void	addToStoreWithName(String name, NamedProviderStore<TimeSeries> stacks, int seriesIndex, Logger logger)
void	close(ErrorReporter errorReporter)
void	copyTo(SharedObjects target, Logger logger)	Adds any exported shared objects to the target container.
MultiInputSubMap<Dictionary>	dictionary()	Gets the map of Dictionarys.
MultiInputSubMap<Path>	filePath()	Gets the map of Paths.
String	getMainObjectName()	Gets the name of the main input object.
MultiInputSubMap<org.anchoranalysis.math.histogram.Histogram>	histogram()	Gets the map of Histograms.
String	identifier()
MultiInputSubMap<MarkCollection>	marks()	Gets the map of MarkCollections.
int	numberFrames()
MultiInputSubMap<org.anchoranalysis.image.voxel.object.ObjectCollection>	objects()	Gets the map of ObjectCollections.
Optional<Path>	pathForBinding()
MultiInputSubMap<TimeSeries>	stack()	Gets the map of TimeSeries (stacks).

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.anchoranalysis.io.input.InputFromManager

allAssociatedPaths, asFile, identifierAsPath, pathForBindingRequired

Methods inherited from interface org.anchoranalysis.image.io.stack.input.ProvidesStackInput

addToStoreInferNames, asSet, asStack

Field Details

DEFAULT_IMAGE_INPUT_NAME

public static final String DEFAULT_IMAGE_INPUT_NAME

The default name for the input image stack.

See Also:

Constant Field Values

Constructor Details

MultiInput

public MultiInput(ProvidesStackInput mainInputObject)

Creates a new MultiInput with a default name for the main input object.

Parameters:

mainInputObject - the main input object that provides the stack

MultiInput

public MultiInput(String mainObjectName, ProvidesStackInput mainInputObject)

Creates a new MultiInput with a specified name for the main input object.

Parameters:

mainObjectName - the name for the main input object

mainInputObject - the main input object that provides the stack

Method Details

addToStoreInferNames

public void addToStoreInferNames(NamedProviderStore<TimeSeries> stacks, int seriesIndex, Logger logger) throws OperationFailedException

Specified by:

addToStoreInferNames in interface ProvidesStackInput

Throws:

OperationFailedException

addToStoreWithName

public void addToStoreWithName(String name, NamedProviderStore<TimeSeries> stacks, int seriesIndex, Logger logger) throws OperationFailedException

Specified by:

addToStoreWithName in interface ProvidesStackInput

Throws:

OperationFailedException

copyTo

public void copyTo(SharedObjects target, Logger logger) throws OperationFailedException

Description copied from interface: ExportSharedObjects

Adds any exported shared objects to the target container.

This method is responsible for copying the relevant shared objects from the implementing class to the provided target container. Non-fatal errors should be logged using the provided logger, while fatal errors should throw an OperationFailedException.

Specified by:

copyTo in interface ExportSharedObjects

Parameters:

target - the SharedObjects container where the exported objects will be added

logger - a Logger for reporting non-fatal errors

Throws:

OperationFailedException - if a fatal error occurs during the export process

identifier

public String identifier()

Specified by:

identifier in interface org.anchoranalysis.io.input.InputFromManager

pathForBinding

public Optional<Path> pathForBinding()

Specified by:

pathForBinding in interface org.anchoranalysis.io.input.InputFromManager

close

public void close(ErrorReporter errorReporter)

Specified by:

close in interface org.anchoranalysis.io.input.InputFromManager

marks

public MultiInputSubMap<MarkCollection> marks()

Gets the map of MarkCollections.

Returns:

the MultiInputSubMap of MarkCollections

objects

public MultiInputSubMap<org.anchoranalysis.image.voxel.object.ObjectCollection> objects()

Gets the map of ObjectCollections.

Returns:

the MultiInputSubMap of ObjectCollections

dictionary

public MultiInputSubMap<Dictionary> dictionary()

Gets the map of Dictionarys.

Returns:

the MultiInputSubMap of Dictionarys

histogram

public MultiInputSubMap<org.anchoranalysis.math.histogram.Histogram> histogram()

Gets the map of Histograms.

Returns:

the MultiInputSubMap of Histograms

filePath

public MultiInputSubMap<Path> filePath()

Gets the map of Paths.

Returns:

the MultiInputSubMap of Paths

stack

public MultiInputSubMap<TimeSeries> stack()

Gets the map of TimeSeries (stacks).

Returns:

the MultiInputSubMap of TimeSeries

getMainObjectName

public String getMainObjectName()

Gets the name of the main input object.

Returns:

the name of the main input object

numberFrames

public int numberFrames() throws OperationFailedException

Specified by:

numberFrames in interface ProvidesStackInput

Throws:

OperationFailedException