org.micromanager.display

Interface ChannelIntensityRanges.Builder

Enclosing interface:

ChannelIntensityRanges

public static interface ChannelIntensityRanges.Builder

Builder for ChannelIntensityRanges.

Obtain an instance via ChannelIntensityRanges.builder() or ChannelIntensityRanges.copyBuilder().

Method Summary

Modifier and Type	Method and Description
ChannelIntensityRanges	build() Builds and returns the ChannelIntensityRanges.
ChannelIntensityRanges.Builder	componentMaximum(int component, long max) Sets only the maximum (white point) for the given component.
ChannelIntensityRanges.Builder	componentMinimum(int component, long min) Sets only the minimum (black point) for the given component.
ChannelIntensityRanges.Builder	componentRange(int component, ComponentIntensityRange range) Sets the range for the given component from a ComponentIntensityRange.
ChannelIntensityRanges.Builder	componentRange(int component, long min, long max) Sets the range for the given component by explicit min and max values.
ChannelIntensityRanges.Builder	componentRanges(java.util.List<ComponentIntensityRange> ranges) Replaces all component ranges with the given list.

Method Detail

componentRange

ChannelIntensityRanges.Builder componentRange(int component,
                                              long min,
                                              long max)

Sets the range for the given component by explicit min and max values.

Parameters:

component - zero-based component index (e.g. 0=red, 1=green, 2=blue for RGB)

min - black point

max - white point (Long.MAX_VALUE = full camera range)

Returns:

this builder

componentRange

ChannelIntensityRanges.Builder componentRange(int component,
                                              ComponentIntensityRange range)

Sets the range for the given component from a ComponentIntensityRange.

Parameters:

component - zero-based component index

range - range to copy min/max from

Returns:

this builder

componentMinimum

ChannelIntensityRanges.Builder componentMinimum(int component,
                                                long min)

Sets only the minimum (black point) for the given component.

Parameters:

component - zero-based component index

min - black point

Returns:

this builder

componentMaximum

ChannelIntensityRanges.Builder componentMaximum(int component,
                                                long max)

Sets only the maximum (white point) for the given component.

Parameters:

component - zero-based component index

max - white point (Long.MAX_VALUE = full camera range)

Returns:

this builder

componentRanges

ChannelIntensityRanges.Builder componentRanges(java.util.List<ComponentIntensityRange> ranges)

Replaces all component ranges with the given list.

Parameters:

ranges - list of ranges, one per component; index 0 is the first component

Returns:

this builder

build

ChannelIntensityRanges build()

Builds and returns the ChannelIntensityRanges.

Returns:

immutable ChannelIntensityRanges