Interface ConverterSetup

  • All Known Implementing Classes:
    PlaceHolderConverterSetup, RealARGBColorConverterSetup

    public interface ConverterSetup
    Modify the range and color of the converter for a source. Because each source can have its own converter, this is used to adjust brightness, contrast, and color of individual sources.
    Author:
    Tobias Pietzsch
    • Method Detail

      • setupChangeListeners

        org.scijava.listeners.Listeners<ConverterSetup.SetupChangeListener> setupChangeListeners()
        SetupChangeListeners can be added/removed here, and will be notified about changes to this ConverterSetup.
      • getSetupId

        int getSetupId()
        Get the id of the BasicViewSetup this converter acts on.
        Returns:
        the id of the BasicViewSetup this converter acts on.
      • setDisplayRange

        void setDisplayRange​(double min,
                             double max)
        Set the range of source values that is mapped to the full range of the target type. Source values outside of the specified range are clamped.
        Parameters:
        min - source value to map to minimum of the target range.
        max - source value to map to maximum of the target range.
      • supportsColor

        boolean supportsColor()
      • getDisplayRangeMin

        double getDisplayRangeMin()
        Get the (largest) source value that is mapped to the minimum of the target range.
        Returns:
        source value that is mapped to the minimum of the target range.
      • getDisplayRangeMax

        double getDisplayRangeMax()
        Get the (smallest) source value that is mapped to the maximum of the target range.
        Returns:
        source value that is mapped to the maximum of the target range.
      • setViewer

        @Deprecated
        default void setViewer​(RequestRepaint viewer)
        Deprecated.
        Deprecated: Use "setupChangeListeners().add( s -> viewer.requestRepaint() )" instead.

        Set the RequestRepaint that should be notified if ConverterSetup settings change.

        Parameters:
        viewer -