org.micromanager.display

Interface DisplaySettings.Builder

All Known Subinterfaces:

DisplaySettings.DisplaySettingsBuilder

Enclosing interface:

DisplaySettings

public static interface DisplaySettings.Builder

Builder for DisplaySettings. Get an instance using the DisplayManager displaySettingsBuilder() method or by using one of the copy() methods of an existing DisplaySettings instance.

Method Summary

Modifier and Type	Method and Description
DisplaySettings.Builder	autoscaleIgnoredPercentile(double percentile)
DisplaySettings.Builder	autoscaleIgnoredQuantile(double quantile)
DisplaySettings.Builder	autoscaleIgnoringZeros(boolean ignoreZeros)
DisplaySettings.Builder	autostretch(boolean enable) Whether to continuously apply autoscale.
DisplaySettings	build()
DisplaySettings.Builder	channel(int channel) Increases the number of ChannelDisplaySettings in this Builder to the given number.
DisplaySettings.Builder	channel(int channel, ChannelDisplaySettings settings) Sets the ChannelDisplaySettings for the given channel.
DisplaySettings.Builder	channels(java.lang.Iterable<ChannelDisplaySettings> channelSettings) Replaces ChannelDisplaySettings with those given.
DisplaySettings.Builder	colorMode(DisplaySettings.ColorMode mode) Color mode or lookup table for displaying the image.
DisplaySettings.Builder	colorModeComposite()
DisplaySettings.Builder	colorModeGrayscale()
DisplaySettings.Builder	colorModeHighlightSaturated()
DisplaySettings.Builder	colorModeSingleColor()
ChannelDisplaySettings	getChannelSettings(int channel) Returns the ChannelDisplaySettings for the given channel number.
int	getNumberOfChannels() Number of ChannelDisplaySettings in this builder.
DisplaySettings.Builder	histogramLogarithmic(boolean histogramLogarithmic) Whether the histogram should be shown with a logarithmic (true) or linear (false) y-axis.
DisplaySettings.Builder	playbackFPS(double fps)
DisplaySettings.Builder	roiAutoscale(boolean enable)
DisplaySettings.Builder	uniformChannelScaling(boolean enable) Whether to use the same intensity scaling for every channel.
DisplaySettings.Builder	zoomRatio(double ratio)

Method Detail

zoomRatio

DisplaySettings.Builder zoomRatio(double ratio)

playbackFPS

DisplaySettings.Builder playbackFPS(double fps)

colorMode

DisplaySettings.Builder colorMode(DisplaySettings.ColorMode mode)

Color mode or lookup table for displaying the image.

Parameters:

mode - ColorMode to appply

Returns:

Builder

colorModeComposite

DisplaySettings.Builder colorModeComposite()

colorModeGrayscale

DisplaySettings.Builder colorModeGrayscale()

colorModeSingleColor

DisplaySettings.Builder colorModeSingleColor()

colorModeHighlightSaturated

DisplaySettings.Builder colorModeHighlightSaturated()

uniformChannelScaling

DisplaySettings.Builder uniformChannelScaling(boolean enable)

Whether to use the same intensity scaling for every channel.

Parameters:

enable - flag

Returns:

Builder

autostretch

DisplaySettings.Builder autostretch(boolean enable)

Whether to continuously apply autoscale.

Parameters:

enable - flag

Returns:

Builder

roiAutoscale

DisplaySettings.Builder roiAutoscale(boolean enable)

autoscaleIgnoredQuantile

DisplaySettings.Builder autoscaleIgnoredQuantile(double quantile)

autoscaleIgnoredPercentile

DisplaySettings.Builder autoscaleIgnoredPercentile(double percentile)

autoscaleIgnoringZeros

DisplaySettings.Builder autoscaleIgnoringZeros(boolean ignoreZeros)

histogramLogarithmic

DisplaySettings.Builder histogramLogarithmic(boolean histogramLogarithmic)

Whether the histogram should be shown with a logarithmic (true) or linear (false) y-axis.

Parameters:

histogramLogarithmic - true when y-axis should be logarithmic.

Returns:

builder instance

channel

DisplaySettings.Builder channel(int channel)

Increases the number of ChannelDisplaySettings in this Builder to the given number. DefaultSettings for each channel will be added.

Parameters:

channel - Final number of ChannelDisplaySettings

Returns:

builder instance to enable chaining commands

channel

DisplaySettings.Builder channel(int channel,
                                ChannelDisplaySettings settings)

Sets the ChannelDisplaySettings for the given channel. If the number of ChannelDisplaySettings is smaller than the given channel number, "missing" channels will be added (using Default Display Settings).

Parameters:

channel - Indicates the number of the channel for which to set the DisplaySettings

Returns:

builder instance to enable chaining commands

channels

DisplaySettings.Builder channels(java.lang.Iterable<ChannelDisplaySettings> channelSettings)

Replaces ChannelDisplaySettings with those given. If provided with null or an empty list, current ChannelDisplaySettings will be removed.

Parameters:

channelSettings - iterable with ChannelDisplaySettings to replace the current ones. Can be empty or null, in which case ChannelDisplaySettings will be removed from this builder.

Returns:

builder instance to enable chaining commands

getNumberOfChannels

int getNumberOfChannels()

Number of ChannelDisplaySettings in this builder. Not sure why a builder needs this...

Returns:

Number of ChannelDisplaySettings in this Builder.

getChannelSettings

ChannelDisplaySettings getChannelSettings(int channel)

Returns the ChannelDisplaySettings for the given channel number. If this, or any channel with lower number, does not exist, it will be created, and filled with DefaultChannelDisplaySettings.

Parameters:

channel - Number (index) of the requested channel

Returns:

ChannelDisplaySettings for the requested channel.

build

DisplaySettings build()