public interface ProvidesStackInput extends InputFromManager
Modifier and Type | Method and Description |
---|---|
default void |
addToStoreInferNames(NamedProviderStore<Stack> store,
Logger logger)
Adds the current object to a named-store of stacks (using the default series).
|
void |
addToStoreInferNames(NamedProviderStore<TimeSeries> stacks,
int seriesIndex,
Logger logger)
Adds any stacks exposed by the current element to a named-store of stacks - inferring the
names of the
Stack s. |
void |
addToStoreWithName(String name,
NamedProviderStore<TimeSeries> stacks,
int seriesIndex,
Logger logger)
Adds any stacks exposed by the current element to a named-store of stacks - with a particular
name.
|
default NamedStacks |
asSet(Logger logger)
Exposes the input as a set of named stacks (inferring the names).
|
default Stack |
asStack(Logger logger)
Exposes the input as a single
Stack throw an error if more than one exists. |
int |
numberFrames()
The number of time-frames in the underlying input image.
|
allAssociatedPaths, asFile, close, identifier, identifierAsPath, pathForBinding, pathForBindingRequired
default Stack asStack(Logger logger) throws OperationFailedException
Stack
throw an error if more than one exists.logger
- a logger for any non-fatal errors. Fatal errors throw an exception.OperationFailedException
- if more than one stack exists, or otherwise a fatal error
occurs loading the stacks.default NamedStacks asSet(Logger logger) throws OperationFailedException
logger
- a logger for any non-fatal errors. Fatal errors throw an exception.OperationFailedException
- if a fatal error occurs loading the stack.default void addToStoreInferNames(NamedProviderStore<Stack> store, Logger logger) throws OperationFailedException
store
- the store.logger
- a logger for any non-fatal errors. Fatal errors throw an exception.OperationFailedException
- if the operation cannot successfully complete.int numberFrames() throws OperationFailedException
OperationFailedException
- if the operation cannot successfully complete.void addToStoreInferNames(NamedProviderStore<TimeSeries> stacks, int seriesIndex, Logger logger) throws OperationFailedException
Stack
s.stacks
- the named-store of stacks.seriesIndex
- the index of the series (beginning at 0) to retrieve stacks from the
TimeSeries
.logger
- a logger for any non-fatal errors. Fatal errors throw an exception.OperationFailedException
- if the operation cannot successfully complete.void addToStoreWithName(String name, NamedProviderStore<TimeSeries> stacks, int seriesIndex, Logger logger) throws OperationFailedException
name
- the name to use for the added stack.stacks
- the named-store of stacks.seriesIndex
- the index of the series (beginning at 0) to retrieve stacks from the
TimeSeries
.logger
- a logger for any non-fatal errors. Fatal errors throw an exception.OperationFailedException
- if the operation cannot successfully complete.Copyright © 2010–2023 Owen Feehan, ETH Zurich, University of Zurich, Hoffmann-La Roche. All rights reserved.