DisplaySettings

```
public interface DisplaySettings
```
This class defines the parameters that control how a given DisplayWindow displays data from the Datastore. It is immutable; construct it with a DisplaySettings.Builder. You are not expected to implement this interface; it is here to describe how you can interact with DisplaySettings created by Micro-Manager itself. If you need a DisplaySettings.Builder, you can generate one via the DisplayManager displaySettingsBuilder() method or by using one of the copy() methods of an existing DisplaySettings instance. This class uses a Builder pattern. Please see https://micro-manager.org/wiki/Using_Builders for more information.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`DisplaySettings.Builder` Builder for DisplaySettings.
`static class`	`DisplaySettings.ColorMode` ColorMode enums.
`static interface`	`DisplaySettings.ContrastSettings` Deprecated. TODO: explain
`static interface`	`DisplaySettings.DisplaySettingsBuilder` Deprecated. Use DisplaySettings.Builder instead

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String FILENAME
Deprecated.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`FILENAME` Deprecated.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`DisplaySettings.DisplaySettingsBuilder`	`copy()` Deprecated.
`DisplaySettings.Builder`	`copyBuilder()`
`DisplaySettings.Builder`	`copyBuilderWithChannelSettings(int channel, ChannelDisplaySettings settings)`
`DisplaySettings.Builder`	`copyBuilderWithComponentSettings(int channel, int component, ComponentDisplaySettings settings)`
`java.util.List<java.awt.Color>`	`getAllChannelColors()`
`java.util.List<ChannelDisplaySettings>`	`getAllChannelSettings()`
`java.util.List<java.lang.Boolean>`	`getAllChannelVisibilities()`
`double`	`getAutoscaleIgnoredPercentile()` When autoscaling, the minimum value will have this fraction of pixels with lower intensities, and the maximum value will have this fraction of pixels with higher intensities.
`double`	`getAutoscaleIgnoredQuantile()` When autoscaling, the minimum value will have this fraction of pixels with lower intensities, and the maximum value will have this fraction of pixels with higher intensities.
`java.awt.Color`	`getChannelColor(int channel)`
`DisplaySettings.ColorMode`	`getChannelColorMode()` Deprecated. - use getColorMode() instead
`DisplaySettings.ContrastSettings[]`	`getChannelContrastSettings()` Deprecated.
`ChannelDisplaySettings`	`getChannelSettings(int channel)`
`DisplaySettings.ColorMode`	`getColorMode()` Color mode or lookup table for displaying the image.
`int`	`getNumberOfChannels()` Returns the number of channels in these DisplaySettings Note that this number may be different from the number of the channels in the image being shown.
`double`	`getPlaybackFPS()`
`java.lang.Double`	`getSafeContrastGamma(int index, int component, java.lang.Double defaultVal)` Deprecated.
`java.lang.Integer`	`getSafeContrastMax(int index, int component, java.lang.Integer defaultVal)` Deprecated.
`java.lang.Integer`	`getSafeContrastMin(int index, int component, java.lang.Integer defaultVal)` Deprecated.
`DisplaySettings.ContrastSettings`	`getSafeContrastSettings(int index, DisplaySettings.ContrastSettings defaultVal)` Deprecated.
`java.lang.Boolean`	`getSafeIsVisible(int index, java.lang.Boolean defaultVal)` Deprecated.
`java.lang.Boolean`	`getShouldSyncChannels()` Deprecated.
`double`	`getZoomRatio()` Zoom level expressed as a ratio (i.e.
`boolean`	`isAutoscaleIgnoringZeros()` When autoscaling, take zero values into account or not? This can be useful for images that contain artificial zero values.
`boolean`	`isAutostretchEnabled()` Whether to continuously apply autoscale.
`boolean`	`isChannelVisible(int channel)`
`boolean`	`isHistogramLogarithmic()` Whether the y-axis of the histogram uses a logarithmic or linear scale.
`boolean`	`isROIAutoscaleEnabled()` Whether to only look at the ROI when autoscaling.
`boolean`	`isUniformChannelScalingEnabled()` Whether to use the same intensity scaling for every channel.

- Field Detail
  - FILENAME
```
@Deprecated
static final java.lang.String FILENAME
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getZoomRatio
```
double getZoomRatio()
```
    Zoom level expressed as a ratio (i.e. 1.0 denotes that each pixel in the image occupies 1 pixel on the screen, 0.5 indicates that 4 image pixels are combined in 1 screen pixel.
    
    Returns:
    
    Zoom ratio
  - getPlaybackFPS
```
double getPlaybackFPS()
```
  - getColorMode
```
DisplaySettings.ColorMode getColorMode()
```
    Color mode or lookup table for displaying the image.
    
    Returns:
    
    ColorMode used by these DisplaySettings
  - isUniformChannelScalingEnabled
```
boolean isUniformChannelScalingEnabled()
```
    Whether to use the same intensity scaling for every channel.
    
    Returns:
    
    true if all channels use the same intensity scaling
  - isAutostretchEnabled
```
boolean isAutostretchEnabled()
```
    Whether to continuously apply autoscale.
    
    Returns:
    
    true if AutoStretch is enabled
  - isROIAutoscaleEnabled
```
boolean isROIAutoscaleEnabled()
```
    Whether to only look at the ROI when autoscaling.
    
    Returns:
    
    true if only the ROI should be taken into account when autoscaling
  - getAutoscaleIgnoredQuantile
```
double getAutoscaleIgnoredQuantile()
```
    When autoscaling, the minimum value will have this fraction of pixels with lower intensities, and the maximum value will have this fraction of pixels with higher intensities.
    
    Returns:
    
    Number used in Autostretch mode to determine where to set the white and black points. Expressed as fraction.
  - getAutoscaleIgnoredPercentile
```
double getAutoscaleIgnoredPercentile()
```
    When autoscaling, the minimum value will have this fraction of pixels with lower intensities, and the maximum value will have this fraction of pixels with higher intensities.
    
    Returns:
    
    Number used in Autostretch mode to determine where to set the white and black points. Expressed as percentage.
  - isAutoscaleIgnoringZeros
```
boolean isAutoscaleIgnoringZeros()
```
    When autoscaling, take zero values into account or not? This can be useful for images that contain artificial zero values.
    
    Returns:
    
    Whether zero pixel values are ignored when autoscaling
  - isHistogramLogarithmic
```
boolean isHistogramLogarithmic()
```
    Whether the y-axis of the histogram uses a logarithmic or linear scale.
    
    Returns:
    
    Logarithmic scale when true.
  - getNumberOfChannels
```
int getNumberOfChannels()
```
    Returns the number of channels in these DisplaySettings Note that this number may be different from the number of the channels in the image being shown.
    
    Returns:
    
    number of channels in these DisplaySettings
  - getChannelSettings
```
ChannelDisplaySettings getChannelSettings(int channel)
```
  - getAllChannelSettings
```
java.util.List<ChannelDisplaySettings> getAllChannelSettings()
```
  - getAllChannelColors
```
java.util.List<java.awt.Color> getAllChannelColors()
```
  - getChannelColor
```
java.awt.Color getChannelColor(int channel)
```
  - getAllChannelVisibilities
```
java.util.List<java.lang.Boolean> getAllChannelVisibilities()
```
  - isChannelVisible
```
boolean isChannelVisible(int channel)
```
  - copyBuilder
```
DisplaySettings.Builder copyBuilder()
```
  - copyBuilderWithChannelSettings
```
DisplaySettings.Builder copyBuilderWithChannelSettings(int channel,
                                                       ChannelDisplaySettings settings)
```
  - copyBuilderWithComponentSettings
```
DisplaySettings.Builder copyBuilderWithComponentSettings(int channel,
                                                         int component,
                                                         ComponentDisplaySettings settings)
```
  - copy
```
@Deprecated
DisplaySettings.DisplaySettingsBuilder copy()
```
    Deprecated.
    
    Generate a new DisplaySettingsBuilder whose values are initialized to be the values of this DisplaySettings.
    
    Returns:
    
    Copy of the DisplaySettingsBuilder
  - getChannelContrastSettings
```
@Deprecated
DisplaySettings.ContrastSettings[] getChannelContrastSettings()
```
    Deprecated.
    
    The object containing contrast information for each channel.
    
    Returns:
    
    An array of ContrastSettings objects, one per channel. May potentially be null or of inadequate length.
  - getSafeContrastSettings
```
@Deprecated
DisplaySettings.ContrastSettings getSafeContrastSettings(int index,
                                                                     DisplaySettings.ContrastSettings defaultVal)
```
    Deprecated.
    
    Safely retrieve the ContrastSettings object for the specified channel. If the contrastSettings property is null, is too small to have a value for the given index, or has a value of null for that index, then the provided default value will be returned instead.
    
    Parameters:
    
    index - Channel index to get the ContrastSettings for
    
    defaultVal - Default value to return if no contrast setting is available.
    
    Returns:
    
    Contrast settings for the specified channel
  - getSafeContrastMin
```
@Deprecated
java.lang.Integer getSafeContrastMin(int index,
                                                 int component,
                                                 java.lang.Integer defaultVal)
```
    Deprecated.
    
    Safely extract the channel contrast min property from the contrast settings for the specified channel and component. If the contrastSettings property is null, is too small to have a value for the given index, has a value of null for the given index, or has a ContrastSettings object whose contrastMin property is null, then the provided default value will be returned instead.
    
    Parameters:
    
    index - Channel index to get the contrast min for.
    
    component - Component index to get the contrast min for.
    
    defaultVal - Default value to return if no contrast min is available.
    
    Returns:
    
    Black point for the specified channel/component
  - getSafeContrastMax
```
@Deprecated
java.lang.Integer getSafeContrastMax(int index,
                                                 int component,
                                                 java.lang.Integer defaultVal)
```
    Deprecated.
    
    Safely extract the channel contrast max property from the contrast settings for the specified channel and component. If the contrastSettings property is null, is too small to have a value for the given index, has a value of null for the given index, or has a ContrastSettings object whose contrastMax property is null, then the provided default value will be returned instead.
    
    Parameters:
    
    index - Channel index to get the contrast max for.
    
    component - Component index to get the contrast max for.
    
    defaultVal - Default value to return if no contrast max is available.
    
    Returns:
    
    White point for the specified channel/component
  - getSafeContrastGamma
```
@Deprecated
java.lang.Double getSafeContrastGamma(int index,
                                                  int component,
                                                  java.lang.Double defaultVal)
```
    Deprecated.
    
    Safely extract the channel contrast gamma property from the contrast settings for the specified channel and component. If the contrastSettings property is null, is too small to have a value for the given index, has a value of null for the given index, or has a ContrastSettings object whose contrastGamma property is null, then the provided default value will be returned instead.
    
    Parameters:
    
    index - Channel index to get the contrast gamma for.
    
    component - Component index to get the contrast gamma for.
    
    defaultVal - Default value to return if no contrast gamma is available.
    
    Returns:
    
    Gamma for the specified channel/component
  - getSafeIsVisible
```
@Deprecated
java.lang.Boolean getSafeIsVisible(int index,
                                               java.lang.Boolean defaultVal)
```
    Deprecated.
    
    Safely determine if the specified channel is visible when in composite view mode. If the contrastSettings property is null, is too small to have a value for the given index, has a value of null for the given index, or has a ContrastSettings object whose isVisible property is null, then the provided default value will be returned instead.
    
    Parameters:
    
    index - Channel index to get visibility for.
    
    defaultVal - Default value to return if no visibility is available.
    
    Returns:
    
    Flag indicating visibility of the specified channel
  - getChannelColorMode
```
@Deprecated
DisplaySettings.ColorMode getChannelColorMode()
```
    Deprecated. - use getColorMode() instead
    
    The index into the "Display mode" control.
    
    Returns:
    
    index into the "Display mode" control
  - getShouldSyncChannels
```
@Deprecated
java.lang.Boolean getShouldSyncChannels()
```
    Deprecated.
    
    Whether histogram settings should be synced across channels.
    
    Returns:
    
    True if histograms should sync between channels

Interface DisplaySettings

Nested Class Summary

Field Summary

Method Summary

Field Detail

FILENAME

Method Detail

getZoomRatio

getPlaybackFPS

getColorMode

isUniformChannelScalingEnabled

isAutostretchEnabled

isROIAutoscaleEnabled

getAutoscaleIgnoredQuantile

getAutoscaleIgnoredPercentile

isAutoscaleIgnoringZeros

isHistogramLogarithmic

getNumberOfChannels

getChannelSettings

getAllChannelSettings

getAllChannelColors

getChannelColor

getAllChannelVisibilities

isChannelVisible

copyBuilder

copyBuilderWithChannelSettings

copyBuilderWithComponentSettings

copy

getChannelContrastSettings

getSafeContrastSettings

getSafeContrastMin

getSafeContrastMax

getSafeContrastGamma

getSafeIsVisible

getChannelColorMode

getShouldSyncChannels