ome.formats.model

Class ChannelData

java.lang.Object

ome.formats.model.ChannelData

public class ChannelData
extends Object

Represents all the metadata required to make accurate decisions about channel colour and name.

Author:

Chris Allan , Jean-Marie

Constructor Summary

Constructors

Constructor and Description
ChannelData()

Method Summary

Modifier and Type	Method and Description
static ChannelData	fromObjectContainerStore(IObjectContainerStore store, int imageIndex, int channelIndex) Retrieves channel data from an object container store.
omero.model.Channel	getChannel() Returns the channel this channel data is for.
int	getChannelIndex() Returns the index of the channel this channel data is for.
omero.model.FilterSet	getFilterSet() Returns the filter set for the logical channel of this channel data.
omero.model.Filter	getFilterSetEmissionFilter() Returns the filter set's emission filter for the logical channel of this channel data.
omero.model.Filter	getFilterSetExcitationFilter() Returns the filter set's excitation filter for the logical channel of this channel data.
List<omero.model.Filter>	getLightPathEmissionFilters() Returns the collection of emission filters in the light path.
List<omero.model.Filter>	getLightPathExcitationFilters() Returns the collection of excitation filters in the light path.
omero.model.LightSource	getLightSource() Returns the light source for the light source settings of this channel data.
omero.model.LightSettings	getLightSourceSettings() Returns the light source settings for the logical channel of this channel data.
omero.model.LogicalChannel	getLogicalChannel() Returns the logical channel for this channel data.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelData

public ChannelData()

Method Detail

fromObjectContainerStore

public static ChannelData fromObjectContainerStore(IObjectContainerStore store,
                                                   int imageIndex,
                                                   int channelIndex)

Retrieves channel data from an object container store.

Parameters:

store - Store to retrieve the channel data from.

imageIndex - Index of the image to retrieve channel data for.

channelIndex - Index of the channel to retrieve channel data for.

Returns:

Populated channel data for the specified channel.

getChannel

public omero.model.Channel getChannel()

Returns the channel this channel data is for.

Returns:

See above.

getChannelIndex

public int getChannelIndex()

Returns the index of the channel this channel data is for.

Returns:

See above.

getLogicalChannel

public omero.model.LogicalChannel getLogicalChannel()

Returns the logical channel for this channel data.

Returns:

See above.

getFilterSet

public omero.model.FilterSet getFilterSet()

Returns the filter set for the logical channel of this channel data.

Returns:

See above.

getFilterSetEmissionFilter

public omero.model.Filter getFilterSetEmissionFilter()

Returns the filter set's emission filter for the logical channel of this channel data.

Returns:

See above.

getFilterSetExcitationFilter

public omero.model.Filter getFilterSetExcitationFilter()

Returns the filter set's excitation filter for the logical channel of this channel data.

Returns:

See above.

getLightPathEmissionFilters

public List<omero.model.Filter> getLightPathEmissionFilters()

Returns the collection of emission filters in the light path.

Returns:

See above.

getLightPathExcitationFilters

public List<omero.model.Filter> getLightPathExcitationFilters()

Returns the collection of excitation filters in the light path.

Returns:

See above.

getLightSourceSettings

public omero.model.LightSettings getLightSourceSettings()

Returns the light source settings for the logical channel of this channel data.

Returns:

See above.

getLightSource

public omero.model.LightSource getLightSource()

Returns the light source for the light source settings of this channel data.

Returns:

See above.