org.micromanager.display

Interface ChannelDisplaySettings

public interface ChannelDisplaySettings

Stores the display settings for individual channels Coords of image to be displayed. Maintains the state of things like channel color, visibility, min, max, gamma, and histogram range.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ChannelDisplaySettings.Builder Builder for ChannelDisplaySettings.

Method Summary

Modifier and Type	Method and Description
ChannelDisplaySettings.Builder	copyBuilder()
ChannelDisplaySettings.Builder	copyBuilderWithComponentSettings(int component, ComponentDisplaySettings settings)
java.util.List<ComponentDisplaySettings>	getAllComponentSettings()
java.awt.Color	getColor() Color used to represent this channel, i.e., brightest color of the LUT used to display this channel
ComponentDisplaySettings	getComponentSettings(int component)
java.lang.String	getGroupName() Name of the channelgroup this channel belongs to.
int	getHistoRangeBits() Range of this histogram displayed for this channel For now, histogram always starts at zero, so this represents the maximum value on the x-axis of the histogram.
java.lang.String	getName() Returns name of the channel that is displayed.
int	getNumberOfComponents()
boolean	isUniformComponentScalingEnabled()
boolean	isVisible() Indicates whether this is visible.
boolean	useCameraRange() Returns whether the camera range is used as histogram range.

Method Detail

getColor

java.awt.Color getColor()

Color used to represent this channel, i.e., brightest color of the LUT used to display this channel

Returns:

Color for this channel

isUniformComponentScalingEnabled

boolean isUniformComponentScalingEnabled()

getHistoRangeBits

int getHistoRangeBits()

Range of this histogram displayed for this channel For now, histogram always starts at zero, so this represents the maximum value on the x-axis of the histogram.

Returns:

Maximum value on the x-axis of the histogram expressed as a factor of 2

useCameraRange

boolean useCameraRange()

Returns whether the camera range is used as histogram range.

Returns:

True when historangebits is equal to the maximum intensity coming from the camera

isVisible

boolean isVisible()

Indicates whether this is visible.

Returns:

True when this channel is visible to the user, false otherwise

getName

java.lang.String getName()

Returns name of the channel that is displayed.

Returns:

Name of the channel being displayed.

getGroupName

java.lang.String getGroupName()

Name of the channelgroup this channel belongs to.

Returns:

Name of the channelGroup this channel belongs to

getNumberOfComponents

int getNumberOfComponents()

getComponentSettings

ComponentDisplaySettings getComponentSettings(int component)

getAllComponentSettings

java.util.List<ComponentDisplaySettings> getAllComponentSettings()

copyBuilder

ChannelDisplaySettings.Builder copyBuilder()

copyBuilderWithComponentSettings

ChannelDisplaySettings.Builder copyBuilderWithComponentSettings(int component,
                                                                ComponentDisplaySettings settings)