Interface ComponentIntensityRange.Builder

Enclosing interface:
ComponentIntensityRange
public static interface ComponentIntensityRange.Builder
Builder for ComponentIntensityRange.

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

  • Method Details

    • 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

    • floatMinimum

      default ComponentIntensityRange.Builder floatMinimum(double min)
      Sets the minimum as an actual pixel value, for floating point images.

      For float images the long-valued minimum(long) is not usable, since the interesting range is rarely integral. Pass Double.NaN to clear the float range and fall back to the long-valued setting.

      The default implementation ignores the value, so that builders written before the float range existed keep compiling; they simply carry no float range.

      Parameters:
      min - pixel value, or NaN to unset
      Returns:
      this builder

    • floatMaximum

      default ComponentIntensityRange.Builder floatMaximum(double max)
      Sets the maximum as an actual pixel value, for floating point images.
      Parameters:
      max - pixel value, or NaN to unset
      Returns:
      this builder
      See Also:

    • floatRange

      default ComponentIntensityRange.Builder floatRange(double min, double max)
      Sets both float bounds as actual pixel values.
      Parameters:
      min - pixel value, or NaN to unset
      max - pixel value, or NaN to unset
      Returns:
      this builder
      See Also:

    • build

      ComponentIntensityRange build()
      Builds and returns the ComponentIntensityRange.
      Returns:
      immutable ComponentIntensityRange