Package ome.formats.model
Class ChannelData
- java.lang.Object
-
- ome.formats.model.ChannelData
-
public class ChannelData extends java.lang.Object
Represents all the metadata required to make accurate decisions about channel colour and name.
-
-
Constructor Summary
Constructors Constructor Description ChannelData()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ChannelData
fromObjectContainerStore(IObjectContainerStore store, int imageIndex, int channelIndex)
Retrieves channel data from an object container store.Channel
getChannel()
Returns the channel this channel data is for.int
getChannelIndex()
Returns the index of the channel this channel data is for.FilterSet
getFilterSet()
Returns the filter set for the logical channel of this channel data.Filter
getFilterSetEmissionFilter()
Returns the filter set's emission filter for the logical channel of this channel data.Filter
getFilterSetExcitationFilter()
Returns the filter set's excitation filter for the logical channel of this channel data.java.util.List<Filter>
getLightPathEmissionFilters()
Returns the collection of emission filters in the light path.java.util.List<Filter>
getLightPathExcitationFilters()
Returns the collection of excitation filters in the light path.LightSource
getLightSource()
Returns the light source for the light source settings of this channel data.LightSettings
getLightSourceSettings()
Returns the light source settings for the logical channel of this channel data.LogicalChannel
getLogicalChannel()
Returns the logical channel for this channel data.
-
-
-
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 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 LogicalChannel getLogicalChannel()
Returns the logical channel for this channel data.- Returns:
- See above.
-
getFilterSet
public FilterSet getFilterSet()
Returns the filter set for the logical channel of this channel data.- Returns:
- See above.
-
getFilterSetEmissionFilter
public Filter getFilterSetEmissionFilter()
Returns the filter set's emission filter for the logical channel of this channel data.- Returns:
- See above.
-
getFilterSetExcitationFilter
public Filter getFilterSetExcitationFilter()
Returns the filter set's excitation filter for the logical channel of this channel data.- Returns:
- See above.
-
getLightPathEmissionFilters
public java.util.List<Filter> getLightPathEmissionFilters()
Returns the collection of emission filters in the light path.- Returns:
- See above.
-
getLightPathExcitationFilters
public java.util.List<Filter> getLightPathExcitationFilters()
Returns the collection of excitation filters in the light path.- Returns:
- See above.
-
getLightSourceSettings
public LightSettings getLightSourceSettings()
Returns the light source settings for the logical channel of this channel data.- Returns:
- See above.
-
getLightSource
public LightSource getLightSource()
Returns the light source for the light source settings of this channel data.- Returns:
- See above.
-
-