Interface ChannelDisplaySettings


public interface ChannelDisplaySettings
Stores the display settings for individual channels Coords of image to be displayed. Maintains the state of things like channel color, visibility, min, max, gamma, and histogram range.
  • Method Details

    • getColor

      Color getColor()
      Color used to represent this channel, i.e., brightest color of the LUT used to display this channel
      Returns:
      Color for this channel
    • isUniformComponentScalingEnabled

      boolean isUniformComponentScalingEnabled()
    • getHistoRangeBits

      int getHistoRangeBits()
      Range of this histogram displayed for this channel For now, histogram always starts at zero, so this represents the maximum value on the x-axis of the histogram.
      Returns:
      Maximum value on the x-axis of the histogram expressed as a factor of 2
    • useCameraRange

      boolean useCameraRange()
      Returns whether the camera range is used as histogram range.
      Returns:
      True when historangebits is equal to the maximum intensity coming from the camera
    • getFloatHistoRangeMinimum

      default double getFloatHistoRangeMinimum()
      Low end of the histogram axis for floating point images.

      The default implementation reports no axis range, so that implementations written before the float axis existed keep compiling.

      Returns:
      pixel value, or Double.NaN if not set
      See Also:
    • getFloatHistoRangeMaximum

      default double getFloatHistoRangeMaximum()
      High end of the histogram axis for floating point images.
      Returns:
      pixel value, or Double.NaN if not set
      See Also:
    • hasFloatHistoRange

      default boolean hasFloatHistoRange()
      Returns whether a float histogram axis range has been recorded.
      Returns:
      true if both ends are set and the high end is strictly above the low end; an empty or inverted range counts as unset, since it cannot be drawn
    • isFloatHistoRangePinned

      default boolean isFloatHistoRangePinned()
      Returns whether the float histogram axis was chosen by the user.

      A pinned axis is not widened to include newly displayed images.

      Returns:
      true if the axis should be left as-is
    • isVisible

      boolean isVisible()
      Indicates whether this is visible.
      Returns:
      True when this channel is visible to the user, false otherwise
    • getName

      String getName()
      Returns name of the channel that is displayed.
      Returns:
      Name of the channel being displayed.
    • getGroupName

      String getGroupName()
      Name of the channelgroup this channel belongs to.
      Returns:
      Name of the channelGroup this channel belongs to
    • getNumberOfComponents

      int getNumberOfComponents()
    • getComponentSettings

      ComponentDisplaySettings getComponentSettings(int component)
    • getAllComponentSettings

      List<ComponentDisplaySettings> getAllComponentSettings()
    • copyBuilder

    • copyBuilderWithComponentSettings

      ChannelDisplaySettings.Builder copyBuilderWithComponentSettings(int component, ComponentDisplaySettings settings)
    • builder