Enum Class PatientPosition

java.lang.Object
java.lang.Enum<PatientPosition>
com.xinapse.dicom.PatientPosition
All Implemented Interfaces:
Serializable, Comparable<PatientPosition>, Constable
public enum PatientPosition extends Enum<PatientPosition>
An enumeration of the possible positions in which a patient may be lying in the scanning equipment (e.g, head-first, supine).

  • Enum Constant Details

    • HFP

      public static final PatientPosition HFP
      PatientPosition indicating head-first, prone.

    • HFS

      public static final PatientPosition HFS
      PatientPosition indicating head-first, supine.

    • HFDR

      public static final PatientPosition HFDR
      PatientPosition indicating head-first, decubitus right.

    • HFDL

      public static final PatientPosition HFDL
      PatientPosition indicating head-first, decubitus left.

    • FFP

      public static final PatientPosition FFP
      PatientPosition indicating feet-first, prone.

    • FFS

      public static final PatientPosition FFS
      PatientPosition indicating feet-first, supine.

    • FFDR

      public static final PatientPosition FFDR
      PatientPosition indicating feet-first, decubitus right.

    • FFDL

      public static final PatientPosition FFDL
      PatientPosition indicating feet-first, decubitus left.

  • Field Details

    • OPTION

      public static final org.apache.commons.cli.Option OPTION
      An Option to specify the patient position in the scanner.

    • PATIENT_POSITION_PREFERENCE_NAME

      public static final String PATIENT_POSITION_PREFERENCE_NAME
      The Preference name for the imaging patient position. Is public because this is used in the Perfusion package to set the patient position to MR or CT.
      See Also:

  • Method Details

    • values

      public static PatientPosition[] 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 PatientPosition 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 PatientPosition getInstance(String pp)
      Returns a PatientPosition corresponding to the supplied string.
      Parameters:
      pp - a String which is one of "HFS", "HFP", "HFDR", "HFDL", "FFS", "FFP", "FFDR" or "FFDL". The case of pp is ignored. If pp does not match any of these, then null is returned.
      Returns:
      a PatientPosition corresponding to the supplied string.

    • getPreferredPatientPosition

      public static PatientPosition getPreferredPatientPosition(Preferences prefs)
      Returns the user's preferred PatientPosition set in the user Preferences.
      Parameters:
      prefs - the Preferences.
      Returns:
      the user's preferred PatientPosition.

    • getLPS2XYZBasis

      public AffineTransform3D getLPS2XYZBasis()
      Returns a transform that will transform from patient-centric L,P,S coordinates to scanner x,y,z coordinates. This transform encodes PatientPosition only and must be composed with IOP/qform to obtain the true mapping.
      Returns:
      the AffineTransform3D that will transform a position or vector in basis L,P,S coordinates to one in scanner basis x,y,z coordinates.

    • getXYZ2LPSBasis

      public AffineTransform3D getXYZ2LPSBasis()
      Returns a transform that will transform from scanner basis x,y,z coordinates to basis patient-centric L,P,S coordinates.
      Returns:
      the AffineTransform3D that will transform a position or vector in scanner basis x,y,z coordinates to one in patient basis L,P,S coordinates.

    • savePreferredPatientPosition

      public static void savePreferredPatientPosition(PatientPosition patientPosition, Preferences prefs)
      Saves the user's preferred PatientPosition to the user Preferences.
      Parameters:
      patientPosition - the user's preferred PatientPosition.
      prefs - the Preferences.

    • getAlwaysAsk

      public static boolean getAlwaysAsk()
      Returns whether the user prefers always to be asked to set the PatientPosition.
      Returns:
      the user's preference for whether always to be asked to set the PatientPosition.

    • saveAlwaysAsk

      public static void saveAlwaysAsk(boolean alwaysAsk)
      Saves whether the user prefers always to be asked to set the PatientPosition.
      Parameters:
      alwaysAsk - the user's preference for whether always to be asked to set the PatientPosition.