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 names that can be used to describe the approximate orientation of a scan plane.

  • Enum Constant Details

  • Field Details

    • OPTION

      public static final org.apache.commons.cli.Option OPTION
      An Option to specify the (approximate) orientation of an input image.

  • 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(ReadableImage image)
      Returns the MostLikePlane of an image.
      Parameters:
      image - the image for which to find the most-like plane.
      Returns:
      the MostLikePlane of the image. UNKNOWN is returned if the image plane can't be found.

    • 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.

    • getTransformTo

      public static AffineTransform3D getTransformTo(ReadableImage image, MostLikePlane fromPlane)
      Returns an AffineTransform3D that will approximately transform the row/column/slice direction cosines of an image plane (in patient coordinates) to the orientation of the supplied image. If no orientation information is present in the image header, then the pixel data will be examined to try to guess the orientation. However, this will only work for head images, and will give unpredictable results for the other body parts.
      Parameters:
      image - the image to transform to.
      fromPlane - the scan plane orientation to transform from.
      Returns:
      the transform that will transform from the fromPlane to that of the image. Returns the identity transform if the true transform cannot be found.

    • getTransformTo

      public static AffineTransform3D getTransformTo(MostLikePlane toPlane, MostLikePlane fromPlane)
      Returns an AffineTransform3D that will approximately transform the row/column/slice direction cosines of an image plane (in patient coordinates) to the supplied orientation.
      Parameters:
      toPlane - the scan plane orientation to transform to.
      fromPlane - the scan plane orientation to transform from.
      Returns:
      an AffineTransform3D that will transform locations in row/col/slice coordinates from row/col/slice coordinates in the fromPlane.

    • getTransform

      public static AffineTransform3D getTransform(MostLikePlane toPlane, MostLikePlane fromPlane)
      Returns a AffineTransform3D that will transform locations in one plane to locations in another plane.
      Parameters:
      toPlane - to image plane to transform positions to.
      fromPlane - to image plane to transform positions from.
      Returns:
      the tranform that transform locations in the fromPlane to locations in the toPlane.

    • 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.

    • getMostLikePlaneFromPixelValues

      public static MostLikePlane getMostLikePlaneFromPixelValues(ReadableImage image)
      Guesses the image orientation using just the image pixel values.
      Parameters:
      image - the image for which to guess the MostLikePlane.
      Returns:
      the MostLikePlane guessed from the pixel values. Returns UNKNOWN if the orientation can't be guessed.

    • toString

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

    • main

      public static void main(String[] args)
      Runs the unit test on this class.
      Parameters:
      args - the program arguments ignored).