public abstract class NamedChannelsInput extends Object implements ProvidesStackInput
Only the first time-point is considered from each series.
Constructor and Description |
---|
NamedChannelsInput() |
Modifier and Type | Method and Description |
---|---|
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.
|
abstract int |
bitDepth(Logger logger)
Bit-depth of image.
|
abstract NamedChannelsMap |
createChannelsForSeries(int seriesIndex,
Logger logger)
Creates a
NamedChannelsMap representing the channels for a particular series in this
input. |
abstract Dimensions |
dimensions(int seriesIndex,
Logger logger)
Dimensions of a particular series.
|
abstract ImageMetadata |
metadata(int seriesIndex,
Logger logger)
The image-metadata associated with a particular series.
|
abstract int |
numberChannels(Logger logger)
Number of channels.
|
int |
numberFrames()
The number of time-frames in the underlying input image.
|
abstract int |
numberSeries()
Number of series that exist.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addToStoreInferNames, asSet, asStack
allAssociatedPaths, asFile, close, identifier, identifierAsPath, pathForBinding, pathForBindingRequired
public abstract int numberSeries() throws ImageIOException
ImageIOException
- if the information cannot be successfully retrieved from the
underlying image.public abstract Dimensions dimensions(int seriesIndex, Logger logger) throws ImageIOException
seriesIndex
- the index of the series.logger
- a logger for any non-fatal errors. Fatal errors throw an exception.ImageIOException
- if the information cannot be successfully retrieved from the
underlying image.public abstract int numberChannels(Logger logger) throws ImageIOException
logger
- a logger for any non-fatal errors. Fatal errors throw an exception.ImageIOException
- if the information cannot be successfully retrieved from the
underlying image.public abstract int bitDepth(Logger logger) throws ImageIOException
logger
- a logger for any non-fatal errors. Fatal errors throw an exception.ImageIOException
- if the information cannot be successfully retrieved from the
underlying image.public abstract NamedChannelsMap createChannelsForSeries(int seriesIndex, Logger logger) throws ImageIOException
NamedChannelsMap
representing the channels for a particular series in this
input.seriesIndex
- the index of the series to use (beginning at 0).logger
- the logger where informative or non-fatal error messages amy be written.NamedChannelsMap
bound to seriesIndex
.ImageIOException
- if the operation cannot successfully complete.public abstract ImageMetadata metadata(int seriesIndex, Logger logger) throws ImageIOException
seriesIndex
- the index of the series.logger
- the logger.ImageIOException
- if the metadata cannot be calculated.public void addToStoreInferNames(NamedProviderStore<TimeSeries> stacks, int seriesIndex, Logger logger) throws OperationFailedException
ProvidesStackInput
Stack
s.addToStoreInferNames
in interface ProvidesStackInput
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.public void addToStoreWithName(String name, NamedProviderStore<TimeSeries> stacks, int seriesIndex, Logger logger) throws OperationFailedException
ProvidesStackInput
addToStoreWithName
in interface ProvidesStackInput
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.public int numberFrames()
ProvidesStackInput
numberFrames
in interface ProvidesStackInput
Copyright © 2010–2023 Owen Feehan, ETH Zurich, University of Zurich, Hoffmann-La Roche. All rights reserved.