Package com.xinapse.multisliceimage.roi

Enum Class MaskAction

java.lang.Object
java.lang.Enum<MaskAction>
com.xinapse.multisliceimage.roi.MaskAction
All Implemented Interfaces:
Serializable, Comparable<MaskAction>, Constable
public enum MaskAction extends Enum<MaskAction>
An enumeration of possible masking operation actions that can be applied to an ROI to mask out some of an image's pixels.

  • Enum Constant Details

    • NONE

      public static final MaskAction NONE
      MaskAction for no mask action.

    • MASK_INSIDE

      public static final MaskAction MASK_INSIDE
      MaskAction for masking pixels inside the ROI.

    • MASK_OUTSIDE

      public static final MaskAction MASK_OUTSIDE
      MaskAction for masking pixels outside the ROI.

    • MASK_INSIDE_SOFT

      public static final MaskAction MASK_INSIDE_SOFT
      MaskAction for soft masking pixels inside the ROI.

    • MASK_OUTSIDE_SOFT

      public static final MaskAction MASK_OUTSIDE_SOFT
      MaskAction for soft masking pixels outside the ROI.

  • Method Details

    • values

      public static MaskAction[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static MaskAction valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getPreferredMaskAction

      public static MaskAction getPreferredMaskAction()
      Returns the user's preferred mask action. Set from the user's preferences.
      Returns:
      the user's preferred mask action.

    • savePreferredMaskAction

      public static void savePreferredMaskAction(MaskAction ma)
      Sets the user's preferred mask action. Note that this does not permanently save the setting to user's preferences.
      Parameters:
      ma - the user's new preferred mask action.

    • toString

      public String toString()
      Returns a string describing this MaskAction.
      Overrides:
      toString in class Enum<MaskAction>
      Returns:
      a string describing this MaskAction.