Interface DisplaySettings.ContrastSettings

Enclosing interface:
DisplaySettings
@Deprecated public static interface DisplaySettings.ContrastSettings
Deprecated.
TODO: explain
This object contains contrast settings for a single channel. It is used to set the minimum contrast value (treated as black), maximum contrast value (treated as white, or full-intensity for colored displays), and gamma (how linear the mapping is between min and max). This object is used for both single-component (i.e. grayscale) and multi-component (e.g. RGB) channels. You can create a new ContrastSettings object via DisplayManager.createContrastSettings().

  • Method Details

    • getContrastMins

      @Deprecated Integer[] getContrastMins()
      Deprecated.
      Return the array of minimum contrast settings for all components.
      Returns:
      array of minimum contrast settings (i.e. the intensity value in the image that results in black display) for all components. May be null.

    • getSafeContrastMin

      @Deprecated Integer getSafeContrastMin(int component, Integer defaultVal)
      Deprecated.
      Return the minimum contrast setting for this channel and the specified component. If the contrastMins property is not set or is of inadequate length, then the provided default value will be returned instead.
      Parameters:
      component - The component index to use. For example, for an RGB image, a value of 0 would indicate the red component. For single-component images, use an index of 0.
      defaultVal - Value to return if there is no value available for the specified component number.
      Returns:
      The minimum contrast setting for the component

    • getContrastMaxes

      @Deprecated Integer[] getContrastMaxes()
      Deprecated.
      Return the array of maximum contrast settings for all components.
      Returns:
      array of maximum contrast settings (i.e. the intensity value in the image that results in the brightest display value) for all components. May be null.

    • getSafeContrastMax

      @Deprecated Integer getSafeContrastMax(int component, Integer defaultVal)
      Deprecated.
      Return the maximum contrast setting for this channel and the specified component. If the contrastMaxes property is not set or is of inadequate length, then the provided default value will be returned instead.
      Parameters:
      component - The component index to use. For example, for an RGB image, a value of 0 would indicate the red component. For single-component images, use an index of 0.
      defaultVal - Value to return if there is no value available for the specified component number.
      Returns:
      The maximum contrast setting for the component

    • getContrastGammas

      @Deprecated Double[] getContrastGammas()
      Deprecated.
      Return the array of gamma settings for all components. Note that multi-component images do not currently make use of the gamma setting.
      Returns:
      Array of gamma settings for all components. May be null.

    • getSafeContrastGamma

      @Deprecated Double getSafeContrastGamma(int component, Double defaultVal)
      Deprecated.
      Return the gamma setting for this channel and the specified component. If the contrastGammas property is not set or is of inadequate length, then the provided default value will be returned instead. Note that multi-component images do not currently make use of the gamma setting.
      Parameters:
      component - The component index to use. For example, for an RGB image, a value of 0 would indicate the red component. For single-component images, use an index of 0.
      defaultVal - Value to return if there is no value available for the specified component number.
      Returns:
      The gamma setting controlling how linear the contrast mapping is.

    • getIsVisible

      @Deprecated Boolean getIsVisible()
      Deprecated.
      Use isVisible()
      Nonstandard alias for isVisible.
      Returns:
      Flag indicating whether the channel is currently displayed

    • isVisible

      @Deprecated Boolean isVisible()
      Deprecated.
      Use isVisible
      Return true if the channel is currently displayed, and false otherwise. This is only relevant when the display is showing multiple channels at the same time (i.e. ColorMode is COMPOSITE); in all other modes this value is ignored.
      Returns:
      Flag indicating whether the channel is currently displayed

    • getNumComponents

      @Deprecated int getNumComponents()
      Deprecated.
      Return the number of components this ContrastSettings object has information for. This will be the length of the smallest array from the contrastMins, contrastMaxes, and contrastGammas attributes. Note that it is still possible for there to be nulls in one of those arrays.
      Returns:
      The number of components this object has information for.