org.micromanager.display

Interface ChannelDisplaySettings.Builder

Enclosing interface:

ChannelDisplaySettings

public static interface ChannelDisplaySettings.Builder

Builder for ChannelDisplaySettings.

Method Summary

Modifier and Type	Method and Description
ChannelDisplaySettings	build()
ChannelDisplaySettings.Builder	color(java.awt.Color color)
ChannelDisplaySettings.Builder	colorBlue()
ChannelDisplaySettings.Builder	colorColorBlindFriendly(int number)
ChannelDisplaySettings.Builder	colorCyan()
ChannelDisplaySettings.Builder	colorGreen()
ChannelDisplaySettings.Builder	colorMagenta()
ChannelDisplaySettings.Builder	colorRed()
ChannelDisplaySettings.Builder	colorWhite()
ChannelDisplaySettings.Builder	colorYellow()
ChannelDisplaySettings.Builder	component(int component)
ChannelDisplaySettings.Builder	component(int component, ComponentDisplaySettings settings)
default ChannelDisplaySettings.Builder	floatHistoRange(double min, double max) Sets the histogram axis range for floating point images, as pixel values.
default ChannelDisplaySettings.Builder	floatHistoRangePinned(boolean pinned) Marks the float histogram axis as chosen by the user.
ComponentDisplaySettings	getComponentSettings(int component)
int	getNumberOfComponents()
ChannelDisplaySettings.Builder	groupName(java.lang.String groupName)
ChannelDisplaySettings.Builder	hide()
ChannelDisplaySettings.Builder	histoRangeBits(int bits)
ChannelDisplaySettings.Builder	intensityScaling(ChannelIntensityRanges ranges) Sets the intensity scaling (min/max) for all components of this channel in one call.
ChannelDisplaySettings.Builder	name(java.lang.String name)
ChannelDisplaySettings.Builder	show()
ChannelDisplaySettings.Builder	uniformComponentScaling(boolean enable)
ChannelDisplaySettings.Builder	useCameraHistoRange(boolean use)
ChannelDisplaySettings.Builder	visible(boolean visible)

Method Detail

color

ChannelDisplaySettings.Builder color(java.awt.Color color)

colorWhite

ChannelDisplaySettings.Builder colorWhite()

colorColorBlindFriendly

ChannelDisplaySettings.Builder colorColorBlindFriendly(int number)

colorRed

ChannelDisplaySettings.Builder colorRed()

colorGreen

ChannelDisplaySettings.Builder colorGreen()

colorBlue

ChannelDisplaySettings.Builder colorBlue()

colorCyan

ChannelDisplaySettings.Builder colorCyan()

colorMagenta

ChannelDisplaySettings.Builder colorMagenta()

colorYellow

ChannelDisplaySettings.Builder colorYellow()

uniformComponentScaling

ChannelDisplaySettings.Builder uniformComponentScaling(boolean enable)

histoRangeBits

ChannelDisplaySettings.Builder histoRangeBits(int bits)

useCameraHistoRange

ChannelDisplaySettings.Builder useCameraHistoRange(boolean use)

floatHistoRange

default ChannelDisplaySettings.Builder floatHistoRange(double min,
                                                       double max)

Sets the histogram axis range for floating point images, as pixel values.

Only meaningful for float images, whose axis is a real value range rather than a bit depth. Pass Double.NaN for both to clear it.

The default implementation ignores the values, so that builders written before the float axis existed keep compiling; they simply carry no axis range.

Parameters:

min - low end of the axis

max - high end of the axis

Returns:

this builder

floatHistoRangePinned

default ChannelDisplaySettings.Builder floatHistoRangePinned(boolean pinned)

Marks the float histogram axis as chosen by the user.

When set, the axis is left exactly as given instead of being widened to take in each newly displayed image.

Parameters:

pinned - true to stop the axis adapting to the data

Returns:

this builder

name

ChannelDisplaySettings.Builder name(java.lang.String name)

groupName

ChannelDisplaySettings.Builder groupName(java.lang.String groupName)

visible

ChannelDisplaySettings.Builder visible(boolean visible)

show

ChannelDisplaySettings.Builder show()

hide

ChannelDisplaySettings.Builder hide()

component

ChannelDisplaySettings.Builder component(int component)

component

ChannelDisplaySettings.Builder component(int component,
                                         ComponentDisplaySettings settings)

intensityScaling

ChannelDisplaySettings.Builder intensityScaling(ChannelIntensityRanges ranges)

Sets the intensity scaling (min/max) for all components of this channel in one call.

This is a convenience alternative to calling component(int, ComponentDisplaySettings) once per component. Only min and max are transferred; any gamma values already set on existing component settings are preserved.

Parameters:

ranges - per-component intensity ranges for this channel

Returns:

this builder

getNumberOfComponents

int getNumberOfComponents()

getComponentSettings

ComponentDisplaySettings getComponentSettings(int component)

build

ChannelDisplaySettings build()