Enum Class MostLikePlane

java.lang.Object
java.lang.Enum<MostLikePlane>
com.xinapse.image.MostLikePlane
All Implemented Interfaces:
Serializable, Comparable<MostLikePlane>, Constable

public enum MostLikePlane extends Enum<MostLikePlane>
The radiological planes that can be used to describe the approximate orientation of a scan plane.
  • Enum Constant Details

  • Method Details

    • values

      public static MostLikePlane[] 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 MostLikePlane 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
    • getInstance

      public static MostLikePlane getInstance(String s) throws InvalidArgumentException
      Returns a MostLikePlane corresponding to a string.
      Parameters:
      s - a String from which the most-like plane will be interpreted. Can be:
      • "unknown",
      • "axial",
      • "sagittal", or
      • "coronal".
      Interpretation of the String is case-insensitive.
      Returns:
      a MostLikePlane corresponding to a String, or UNKNOWN if the String is invalid.
      Throws:
      InvalidArgumentException - if the String is invalid.
    • getInstance

      public static MostLikePlane getInstance(float[][] imageOrientationPatient)
      Returns the MostLikePlane corresponding to the image orientation in patient coordinates.
      Parameters:
      imageOrientationPatient - a 2x3 or 3x3 float[][] containing the direction cosines of the image row, column and (possibly) slice directions of the image matrix.
      Returns:
      the MostLikePlane corresponding to the image orientation direction cosines.
    • getInstance

      public static MostLikePlane getInstance(org.jogamp.vecmath.Vector3f[] imageOrientationPatient)
      Returns the MostLikePlane corresponding to the image orientation in patient coordinates.
      Parameters:
      imageOrientationPatient - a Vector3f[] of length at least 3 containing the direction cosines of the image row, column and (possibly) slice directions of the image matrix.
      Returns:
      the MostLikePlane corresponding to the image orientation direction cosines.
    • getImageOrientationPatient

      public org.jogamp.vecmath.Vector3f[] getImageOrientationPatient()
      Returns the image orientation in patient coordinates for an image plane which is exactly in this MostLikePlane.
      Returns:
      the image orientation in patient coordinates, or null if this is UNKNOWN.
    • selectPlane

      public static MostLikePlane selectPlane(Component parentComponent) throws CancelledException
      Shows a dialog prompting the user to select a scan plane.
      Parameters:
      parentComponent - the parent Component of the dialog.
      Returns:
      the MostLikePlane selected by the user.
      Throws:
      CancelledException - if selection is cancelled by the user.
    • toString

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