Package org.anchoranalysis.image.io.channel.input

Interface ChannelGetter

All Known Subinterfaces:

NamedChannelsMap

All Known Implementing Classes:

NamedChannelsConcatenate, OpenedNamedChannels

public interface ChannelGetter

Retrieves a Channel by name from a particular time-point.

Author:

Owen Feehan

Method Summary

Modifier and Type	Method	Description
Channel	getChannel(String channelName, int timeIndex, Logger logger)	Retrieve the Channel corresponding to channelName at a particular time-frame.
boolean	hasChannel(String channelName)	Does a particular channel-name exist?

Method Details

hasChannel

boolean hasChannel(String channelName)

Does a particular channel-name exist?

Parameters:

channelName - the name of the channel to check.

Returns:

true iff the channel-name exists.

getChannel

Channel getChannel(String channelName,
 int timeIndex,
 Logger logger)
            throws GetOperationFailedException

Retrieve the Channel corresponding to channelName at a particular time-frame.

Parameters:

channelName - the name of the Channel.

timeIndex - the index (beginning at 0) of the frame.

logger - logger to write informative messes or non-fatal errors.

Returns:

the retrieved Channel.

Throws:

GetOperationFailedException - if no channel exists with channelName at time-point timeIndex.