Class Channel

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    Channel

    public class Channel
    extends ch.systemsx.cisd.common.reflection.AbstractHashable
    implements java.io.Serializable
    A channel in which the image has been acquired.

    Each channel has its code which uniquely identifies it in one experiment or dataset.

    See Also:
    Serialized Form
    • Constructor Detail

      • Channel

        public Channel​(java.lang.String code,
                       java.lang.String label)
        Constructs a channel with a specified code and label. The channel will be presented in a default color.
      • Channel

        public Channel​(java.lang.String code,
                       java.lang.String label,
                       ChannelColor channelColorOrNull)
        Constructs a channel with a specified code and label. The channel will be presented in a specified color.
      • Channel

        public Channel​(java.lang.String code,
                       java.lang.String label,
                       ChannelColorRGB channelColorOrNull)
        Constructs a channel with a specified code and label. The channel will be presented in a specified color.
    • Method Detail

      • getCode

        public java.lang.String getCode()
      • tryGetDescription

        public java.lang.String tryGetDescription()
      • tryGetWavelength

        public java.lang.Integer tryGetWavelength()
      • getLabel

        public java.lang.String getLabel()
      • tryGetChannelColor

        public ChannelColorRGB tryGetChannelColor()
        Returns:
        color for the specified channel which will be used to display merged channels images. null only during dataset registration when default color should be used, afterwards never null.
      • setDescription

        public void setDescription​(java.lang.String description)
        Sets the description of the channel. Optional.
      • setWavelength

        public void setWavelength​(java.lang.Integer wavelength)
        Sets the wavelength of the light (in nanometers) used to acquire this channel. Optional.
      • setWavelengthAndColor

        public void setWavelengthAndColor​(java.lang.Integer wavelength)
        Sets the wavelength of the light (in nanometers) used to acquire this channel.
        Additionally sets the channel color. The color is calculated for display on a computer monitor on the basis of the given wavelength using Bruton's algorithm. See COLOR SCIENCE web page for details.

        Optional.

      • setChannelColor

        public void setChannelColor​(ChannelColor channelColor)
        Sets the plain color in which this channel will be displayed.
      • setChannelColorRGB

        public void setChannelColorRGB​(ChannelColorRGB channelColor)
        Sets RGB color in which this channel will be displayed.
      • setAvailableTransformations

        public void setAvailableTransformations​(ImageTransformation[] transformations)
        Sets available transformations which can be applied to images of this channel on request.