org.micromanager.display

Interface DisplayIntensityRanges.Builder

Enclosing interface:

DisplayIntensityRanges

public static interface DisplayIntensityRanges.Builder

Builder for DisplayIntensityRanges.

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

Method Summary

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

Method Detail

componentRange

DisplayIntensityRanges.Builder componentRange(int channel,
                                              int component,
                                              long min,
                                              long max)

Sets the range for a specific channel and component by explicit min/max values.

Parameters:

channel - zero-based channel index

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

DisplayIntensityRanges.Builder componentRange(int channel,
                                              int component,
                                              ComponentIntensityRange range)

Sets the range for a specific channel and component from a ComponentIntensityRange.

Parameters:

channel - zero-based channel index

component - zero-based component index

range - range to copy min/max from

Returns:

this builder

componentMinimum

DisplayIntensityRanges.Builder componentMinimum(int channel,
                                                int component,
                                                long min)

Sets only the minimum (black point) for a specific channel and component.

Parameters:

channel - zero-based channel index

component - zero-based component index

min - black point

Returns:

this builder

componentMaximum

DisplayIntensityRanges.Builder componentMaximum(int channel,
                                                int component,
                                                long max)

Sets only the maximum (white point) for a specific channel and component.

Parameters:

channel - zero-based channel index

component - zero-based component index

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

Returns:

this builder

componentRanges

DisplayIntensityRanges.Builder componentRanges(int channel,
                                               java.util.List<ComponentIntensityRange> ranges)

Replaces all component ranges for the given channel with the given list.

Parameters:

channel - zero-based channel index

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

Returns:

this builder

channelRanges

DisplayIntensityRanges.Builder channelRanges(java.util.List<ChannelIntensityRanges> channelRanges)

Replaces all channel ranges with the given list.

Parameters:

channelRanges - list of ChannelIntensityRanges, one per channel

Returns:

this builder

build

DisplayIntensityRanges build()

Builds and returns the DisplayIntensityRanges.

Returns:

immutable DisplayIntensityRanges