org.micromanager.acquisition

Class ChannelSpec

java.lang.Object

org.micromanager.acquisition.ChannelSpec

public final class ChannelSpec
extends java.lang.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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChannelSpec.Builder ChannelSpec Builder.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	camera Deprecated. Use Builder and getters instead
java.lang.String	channelGroup Deprecated. Use Builder and getters instead
java.awt.Color	color Deprecated. Use Builder and getters instead
java.lang.String	config Deprecated. Use Builder and getters instead
java.lang.Boolean	doZStack Deprecated. Use Builder and getters instead
double	exposure Deprecated. Use Builder and getters instead
int	skipFactorFrame Deprecated. Use Builder and getters instead
boolean	useChannel Deprecated. Use Builder and getters instead
double	zOffset Deprecated. Use Builder and getters instead

Constructor Summary

Constructors

Constructor and Description
ChannelSpec() Deprecated. Use Builder.build() instead for a default ChannelSpec

Method Summary

Modifier and Type	Method and Description
java.lang.String	camera()
java.lang.String	channelGroup()
java.awt.Color	color()
java.lang.String	config()
ChannelSpec.Builder	copyBuilder()
boolean	doZStack()
double	exposure()
static ChannelSpec	fromJSONStream(java.lang.String stream) De-serialize from JSON encoded string.
int	skipFactorFrame()
static java.lang.String	toJSONStream(ChannelSpec cs) Serialize to JSON encoded string.
boolean	useChannel()
double	zOffset()

Methods inherited from class java.lang.Object

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

Field Detail

channelGroup

@Deprecated
public java.lang.String channelGroup

Deprecated. Use Builder and getters instead

Channel group this channel config belongs to.

config

@Deprecated
public java.lang.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 java.lang.Boolean doZStack

Deprecated. Use Builder and getters instead

Whether this channel should be imaged in each Z slice of the stack.

color

@Deprecated
public java.awt.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 java.lang.String camera

Deprecated. Use Builder and getters instead

Name of the camera to use.

Constructor Detail

ChannelSpec

@Deprecated
public ChannelSpec()

Deprecated. Use Builder.build() instead for a default ChannelSpec

Deprecated.

Method Detail

copyBuilder

public ChannelSpec.Builder copyBuilder()

channelGroup

public java.lang.String channelGroup()

config

public java.lang.String config()

exposure

public double exposure()

zOffset

public double zOffset()

doZStack

public boolean doZStack()

color

public java.awt.Color color()

skipFactorFrame

public int skipFactorFrame()

useChannel

public boolean useChannel()

camera

public java.lang.String camera()

toJSONStream

public static java.lang.String toJSONStream(ChannelSpec cs)

Serialize to JSON encoded string.

fromJSONStream

public static ChannelSpec fromJSONStream(java.lang.String stream)

De-serialize from JSON encoded string.