org.micromanager.display

Interface ComponentIntensityRange

public interface ComponentIntensityRange

The intensity (brightness/contrast) scaling range for a single image component.

A "component" is one scalar channel within a pixel: for a grayscale image there is one component; for an RGB image there are three (red, green, blue).

This interface is a simple min/max pair. It is used as a data-transfer object when building display settings via ComponentDisplaySettings.Builder.scalingRange(ComponentIntensityRange), ChannelIntensityRanges.Builder.componentRange(int, ComponentIntensityRange), and related methods. It does not carry gamma; for that, use ComponentDisplaySettings directly.

Instances are immutable. Use builder() or copyBuilder() to construct one.

Default values: a freshly built instance (no setters called) has minimum = 0 and maximum = Long.MAX_VALUE. Long.MAX_VALUE is a sentinel meaning "use the full camera bit-depth range."

See Also:

ChannelIntensityRanges, ComponentDisplaySettings

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ComponentIntensityRange.Builder	builder() Returns a new builder with default values (min=0, max=Long.MAX_VALUE).
ComponentIntensityRange.Builder	copyBuilder() Returns a builder pre-populated with this instance's values.
long	getMaximum() Returns the maximum intensity (white point).
long	getMinimum() Returns the minimum intensity (black point).

Method Detail

builder

static ComponentIntensityRange.Builder builder()

Returns a new builder with default values (min=0, max=Long.MAX_VALUE).

Returns:

new builder

copyBuilder

ComponentIntensityRange.Builder copyBuilder()

Returns a builder pre-populated with this instance's values.

Returns:

copy builder

getMinimum

long getMinimum()

Returns the minimum intensity (black point).

Returns:

minimum intensity; 0 when not explicitly set

getMaximum

long getMaximum()

Returns the maximum intensity (white point).

Returns:

maximum intensity; Long.MAX_VALUE when not explicitly set, which means "use the full camera bit-depth range"