org.micromanager.display

Interface ComponentIntensityRange.Builder

Enclosing interface:

ComponentIntensityRange

public static interface ComponentIntensityRange.Builder

Builder for ComponentIntensityRange.

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

Method Summary

Modifier and Type	Method and Description
ComponentIntensityRange	build() Builds and returns the ComponentIntensityRange.
ComponentIntensityRange.Builder	maximum(long max) Sets the maximum intensity (white point) for this component.
ComponentIntensityRange.Builder	minimum(long min) Sets the minimum intensity (black point) for this component.
ComponentIntensityRange.Builder	range(long min, long max) Convenience method to set both minimum and maximum in one call.

Method Detail

minimum

ComponentIntensityRange.Builder minimum(long min)

Sets the minimum intensity (black point) for this component.

Parameters:

min - intensity value at or below which pixels display as black

Returns:

this builder

maximum

ComponentIntensityRange.Builder maximum(long max)

Sets the maximum intensity (white point) for this component.

Use Long.MAX_VALUE to indicate "use the full camera bit-depth range."

Parameters:

max - intensity value at or above which pixels display at full brightness

Returns:

this builder

range

ComponentIntensityRange.Builder range(long min,
                                      long max)

Convenience method to set both minimum and maximum in one call.

Parameters:

min - intensity value at or below which pixels display as black

max - intensity value at or above which pixels display at full brightness

Returns:

this builder

build

ComponentIntensityRange build()

Builds and returns the ComponentIntensityRange.

Returns:

immutable ComponentIntensityRange