Class ChannelSpec

java.lang.Object
org.micromanager.acquisition.ChannelSpec

public final class ChannelSpec extends Object
A ChannelSpec is a description of how a specific channel will be used in an MDA (multi-dimensional acquisition). It contains fields corresponding to each of the columns in the Channels section of the MDA dialog. ChannelSpecs are used by the SequenceSettings object to set up channels for acquisitions.

Maintainer note: This should be an interface, but kept as a class for backward compatibility.

  • Field Details

    • channelGroup

      @Deprecated public String channelGroup
      Deprecated.
      Use Builder and getters instead
      Channel group this channel config belongs to.
    • config

      @Deprecated public String config
      Deprecated.
      Use Builder and getters instead
      Name of the channel.
    • exposure

      @Deprecated public double exposure
      Deprecated.
      Use Builder and getters instead
      Exposure time, in milliseconds.
    • zOffset

      @Deprecated public double zOffset
      Deprecated.
      Use Builder and getters instead
      Z-offset, in microns.
    • doZStack

      @Deprecated public Boolean doZStack
      Deprecated.
      Use Builder and getters instead
      Whether this channel should be imaged in each Z slice of the stack.
    • color

      @Deprecated public Color color
      Deprecated.
      Use Builder and getters instead
      Color to use when displaying this channel.
    • skipFactorFrame

      @Deprecated public int skipFactorFrame
      Deprecated.
      Use Builder and getters instead
      Number of frames to skip between each time this channel is imaged.
    • useChannel

      @Deprecated public boolean useChannel
      Deprecated.
      Use Builder and getters instead
      Whether the channel is enabled for imaging at all.
    • camera

      @Deprecated public String camera
      Deprecated.
      Use Builder and getters instead
      Name of the camera to use.
  • Constructor Details

    • ChannelSpec

      @Deprecated public ChannelSpec()
      Deprecated.
      Use Builder.build() instead for a default ChannelSpec
      Deprecated.
  • Method Details

    • copyBuilder

      public ChannelSpec.Builder copyBuilder()
    • channelGroup

      public String channelGroup()
    • config

      public String config()
    • exposure

      public double exposure()
    • zOffset

      public double zOffset()
    • doZStack

      public boolean doZStack()
    • color

      public Color color()
    • skipFactorFrame

      public int skipFactorFrame()
    • useChannel

      public boolean useChannel()
    • camera

      public String camera()
    • toJSONStream

      public static String toJSONStream(ChannelSpec cs)
      Serialize to JSON encoded string.
    • fromJSONStream

      public static ChannelSpec fromJSONStream(String stream)
      De-serialize from JSON encoded string.
    • toString

      public String toString()
      Overrides:
      toString in class Object