Package com.xinapse.dicom

Enum Class Modality

java.lang.Object
java.lang.Enum<Modality>
com.xinapse.dicom.Modality
All Implemented Interfaces:
Serializable, Comparable<Modality>, Constable
public enum Modality extends Enum<Modality>
An enumeration of the known imaging and other modalities.

  • Enum Constant Details

    • ASMT

      public static final Modality ASMT
      Content assessment results Modality.

    • AUDIO

      public static final Modality AUDIO
      Audio Modality.

    • AUTOREFRACTION

      public static final Modality AUTOREFRACTION
      Autorefraction Modality.

    • BDUS

      public static final Modality BDUS
      Bone densitometry (ultrasound) Modality.

    • BI

      public static final Modality BI
      Biomagnetic imaging Modality; store as secondary capture.

    • BMD

      public static final Modality BMD
      Bone Mineral Densitometry (X-Ray) Modality.

    • COMPUTED_RADIOGRAPHY

      public static final Modality COMPUTED_RADIOGRAPHY
      Computed radigraphy imaging Modality.

    • COMPUTED_TOMOGRAPHY

      public static final Modality COMPUTED_TOMOGRAPHY
      X-ray computerised tomography imaging Modality.

    • ENHANCED_COMPUTED_TOMOGRAPHY

      public static final Modality ENHANCED_COMPUTED_TOMOGRAPHY
      X-ray computerised tomography imaging Modality.

    • CT_PROTOCOL

      public static final Modality CT_PROTOCOL
      X-ray computerised tomography protocol Modality.

    • DIAPHANOGRAPHY

      public static final Modality DIAPHANOGRAPHY
      Diaphonography imaging Modality.

    • DOCUMENT

      public static final Modality DOCUMENT
      Document Modality.

    • DIGITAL_RADIOGRAPHY

      public static final Modality DIGITAL_RADIOGRAPHY
      Digital radiography image Modality.

    • ELECTROCARDIOGRAPHY

      public static final Modality ELECTROCARDIOGRAPHY
      Elecrocardiography Modality.

    • CARDIAC_ELECTROPHYSIOLOGY

      public static final Modality CARDIAC_ELECTROPHYSIOLOGY
      Cardiac electrophysiology Modality.

    • ENDOSCOPY

      public static final Modality ENDOSCOPY
      Endoscopy imaging Modality.

    • FIDUCIALS

      public static final Modality FIDUCIALS
      Fiducials Modality.

    • GENERAL_MICROSCOPY

      public static final Modality GENERAL_MICROSCOPY
      General microscopy Modality.

    • HARD_COPY

      public static final Modality HARD_COPY
      Hard copy Modality; cannot store.

    • HAEMODYNAMIC_WAVEFORM

      public static final Modality HAEMODYNAMIC_WAVEFORM
      Haemodynamic waveform Modality.

    • INTRA_ORAL_RADIOGRAPHY

      public static final Modality INTRA_ORAL_RADIOGRAPHY
      Intra-oral radiography Modality.

    • INTRA_OCCULAR_LENS_DATA

      public static final Modality INTRA_OCCULAR_LENS_DATA
      Intra-occular lens data Modality.

    • IVOC

      public static final Modality IVOC
      Intravascular optical coherence tomography Modality.

    • IVUS

      public static final Modality IVUS
      Intravascular ultrasound Modality.

    • KERATOMETRY

      public static final Modality KERATOMETRY
      Keratometry Modality.

    • KEY_OBJECT_SELECTION

      public static final Modality KEY_OBJECT_SELECTION
      Key object selection Modality; cannot store.

    • LASER_SURFACE_SCAN

      public static final Modality LASER_SURFACE_SCAN
      Laser surface scan imaging Modality.

    • MAMMOGRAPHY

      public static final Modality MAMMOGRAPHY
      Mammography Modality.

    • MAGNETIC_RESONANCE

      public static final Modality MAGNETIC_RESONANCE
      Magnetic resonance imaging Modality.

    • ENHANCED_MAGNETIC_RESONANCE

      public static final Modality ENHANCED_MAGNETIC_RESONANCE
      Enhanced magnetic resonance imaging Modality.

    • NUCLEAR_MEDICINE

      public static final Modality NUCLEAR_MEDICINE
      Nuclear medicine imaging Modality.

    • OAM

      public static final Modality OAM
      Opthalmic axial measurement Modality; cannot store.

    • OPTICAL_COHERENCE_TOMOGRAPHY

      public static final Modality OPTICAL_COHERENCE_TOMOGRAPHY
      Optical coherence tomography Modality.

    • OPTHALMIC_PHOTOGRAPHY

      public static final Modality OPTHALMIC_PHOTOGRAPHY
      Opthalmic photography Modality.

    • OPTHALMIC_MAPPING

      public static final Modality OPTHALMIC_MAPPING
      Opthalmic mapping Modality; use Secondary Capture Storage SOP Class.

    • OPTHALMIC_VISUAL_FIELD

      public static final Modality OPTHALMIC_VISUAL_FIELD
      Opthalmic visual field Modality; cannot store.

    • OPT

      public static final Modality OPT
      Opthalmic tomography Modality.

    • OSS

      public static final Modality OSS
      Optical surface scan Modality.

    • OTHER

      public static final Modality OTHER
      Other Modality; use Secondary Capture SOP Class.

    • PLAN

      public static final Modality PLAN
      Plan Modality.

    • PRESENTATION_STATE

      public static final Modality PRESENTATION_STATE
      Presentation state Modality.

    • POSITRON_EMISSION_TOMOGRAPHY

      public static final Modality POSITRON_EMISSION_TOMOGRAPHY
      Positron emission tomography imaging Modality.

    • ENHANCED_POSITRON_EMISSION_TOMOGRAPHY

      public static final Modality ENHANCED_POSITRON_EMISSION_TOMOGRAPHY
      Enhanced positron emission tomography imaging Modality.

    • PANORAMIC_X_RAY

      public static final Modality PANORAMIC_X_RAY
      Panoramic X-ray Modality.

    • REGISTRATION

      public static final Modality REGISTRATION
      Image registration Modality.

    • RESP

      public static final Modality RESP
      Respiratory Waveform Modality.

    • RADIO_FLUOROSCOPY

      public static final Modality RADIO_FLUOROSCOPY
      X-ray fluoroscopy imaging Modality.

    • RADIOGRAPHIC_IMAGING

      public static final Modality RADIOGRAPHIC_IMAGING
      Radiographic imaging Modality.

    • RADIOTHERAPY_DOSE

      public static final Modality RADIOTHERAPY_DOSE
      Radiotherapy dose Modality.

    • RADIOTHERAPY_IMAGE

      public static final Modality RADIOTHERAPY_IMAGE
      Radiotherapy image Modality.

    • RADIOTHERAPY_PLAN

      public static final Modality RADIOTHERAPY_PLAN
      Radiotherapy plan Modality.

    • RADIOTHERAPY_RECORD

      public static final Modality RADIOTHERAPY_RECORD
      Radiotherapy record Modality.

    • RADIOTHERAPY_STRUCTURE_SET

      public static final Modality RADIOTHERAPY_STRUCTURE_SET
      Radiotherapy structure set Modality.

    • REAL_WORLD_VALUE

      public static final Modality REAL_WORLD_VALUE
      Real world value map Modality.

    • SECONDARY_CAPTURE

      public static final Modality SECONDARY_CAPTURE
      Secondary capture imaging Modality.

    • SEGMENTATION

      public static final Modality SEGMENTATION
      Image segmentation Modality.

    • SLIDE_MISCROSCOPY

      public static final Modality SLIDE_MISCROSCOPY
      Slide microscopy Modality.

    • STEREOMETRIC_RELATIONSHIP

      public static final Modality STEREOMETRIC_RELATIONSHIP
      Sterometric relationship Modality.

    • SR_DOCUMENT

      public static final Modality SR_DOCUMENT
      Structured report document Modality.

    • SUBJECTIVE_REFRACTION

      public static final Modality SUBJECTIVE_REFRACTION
      Structured report document Modality.

    • STAIN

      public static final Modality STAIN
      Automated slide stainer Modality.

    • THERMOGRAPHY

      public static final Modality THERMOGRAPHY
      Thermography imaging Modality; use Secondary Capture Storage SOP Class UID.

    • ULTRASOUND

      public static final Modality ULTRASOUND
      Ultrasound imaging Modality.

    • VISUAL_ACUITY

      public static final Modality VISUAL_ACUITY
      Visual Acuity Modality.

    • X_RAY_ANGIOGRAPHY

      public static final Modality X_RAY_ANGIOGRAPHY
      X-ray angiography imaging Modality.

    • EXTERNAL_CAMERA_PHOTOGRAPHY

      public static final Modality EXTERNAL_CAMERA_PHOTOGRAPHY
      External camera Modality.

    • ANGIOSCOPY_RET

      public static final Modality ANGIOSCOPY_RET
      Angioscopy Modality (RETIRED).

    • COLOR_FLOW_DOPPLER_RET

      public static final Modality COLOR_FLOW_DOPPLER_RET
      Color Doppler imaging Modality (RETIRED).

    • CINE_FLUOROGRAPHY_RET

      public static final Modality CINE_FLUOROGRAPHY_RET
      Cine fluorography Modality (RETIRED). Use RF instead.

    • CULPOSCOPY_RET

      public static final Modality CULPOSCOPY_RET
      Culcoscopy Modality (RETIRED).

    • CYSTOSCOPY_RET

      public static final Modality CYSTOSCOPY_RET
      Cytoscopy Modality (RETIRED).

    • DIGITAL_FLUOROSCOPY_RET

      public static final Modality DIGITAL_FLUOROSCOPY_RET
      Digital fluoroscopy Modality (RETIRED). Use RF instead.

    • DIGITAL_MICROSCOPY_RET

      public static final Modality DIGITAL_MICROSCOPY_RET
      Digital microscopy Modality (RETIRED).

    • DIGITAL_SUBTRACTION_ANGIOGRAPHY_RET

      public static final Modality DIGITAL_SUBTRACTION_ANGIOGRAPHY_RET
      Digital subtraction angiography Modality..

    • DUPLEX_DOPPLER_RET

      public static final Modality DUPLEX_DOPPLER_RET
      Duplex Doppler imaging Modality (RETIRED).

    • ECHOCARDIOGRAPHY_RET

      public static final Modality ECHOCARDIOGRAPHY_RET
      Echocardiography Modality (RETIRED).

    • FLUORESCEIN_ANGIOGRAPHY_RET

      public static final Modality FLUORESCEIN_ANGIOGRAPHY_RET
      Fluorescein angiography Modality (RETIRED).

    • FUNDOSCOPY_RET

      public static final Modality FUNDOSCOPY_RET
      Fundoscopy Modality (RETIRED).

    • LAPAROSCOPY_RET

      public static final Modality LAPAROSCOPY_RET
      Laparoscopy Modality Modality (RETIRED).

    • MAGNETIC_RESONANCE_ANGIOGRAPHY_RET

      public static final Modality MAGNETIC_RESONANCE_ANGIOGRAPHY_RET
      Magnetic resonance angiography Modality (RETIRED). Use MR instead.

    • MAGNETIC_RESONANCE_SPECTROSCOPY_RET

      public static final Modality MAGNETIC_RESONANCE_SPECTROSCOPY_RET
      Magnetic resonance spectroscopy Modality (RETIRED). Use MR instead.

    • OPTHALMIC_REFRACTION

      public static final Modality OPTHALMIC_REFRACTION
      Ophthalmic refraction Modality (RETIRED). Used subjective refraction instead.

    • SINGLE_PHOTON_EMISSION_COMPUTED_TOMOGRAPHY_RET

      public static final Modality SINGLE_PHOTON_EMISSION_COMPUTED_TOMOGRAPHY_RET
      SPECT imaging Modality (RETIRED).

    • VIDEOFLUOROGRAPHY_RET

      public static final Modality VIDEOFLUOROGRAPHY_RET
      Videofluorography Modality (RETIRED). Use RF instead.

  • Field Details

    • MODALITY_PREFERENCE_NAME

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

  • Method Details

    • values

      public static Modality[] 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 Modality 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 Modality getInstance(com.xinapse.dicom.Uid storageClassUID, String modalityName) throws InvalidArgumentException
      Returns a Modality corresponding to the supplied Storage Class SOP UID and name.
      Parameters:
      storageClassUID - one of the Storage Class SOP UIDs.
      modalityName - one of the defined DICOM terms for the imaging modality, for example "MR" for magnetic resonance.
      Returns:
      the Modality corresponding to the supplied Storage Class SOP UID and name.
      Throws:
      InvalidArgumentException - if the arguments do not correspond to a Modality.

    • getInstance

      public static Modality getInstance(com.xinapse.dicom.Uid storageClassUID) throws InvalidArgumentException
      Returns a Modality corresponding to the supplied storage class SOP Uid.
      Parameters:
      storageClassUID - one of the Storage Class SOP UIDs.
      Returns:
      the Modality corresponding to the Storage Class SOP UID.
      Throws:
      InvalidArgumentException - if storageClassUID does not have a corresponding Modality.

    • getInstance

      public static Modality getInstance(String modalityName) throws InvalidArgumentException
      Returns a Modality corresponding to the supplied modality name.
      Parameters:
      modalityName - the name of one of the Modalities.
      Returns:
      the Modality corresponding to the suppied name.
      Throws:
      InvalidArgumentException - if the name does not have a corresponding Modality.

    • getInstance

      public static Modality getInstance(com.xinapse.dicom.DCMObject object)
      Finds the Modality in a DCMObject.
      Parameters:
      object - the DCMObject from which to find the Modality.
      Returns:
      the Modality, or null if the Modality can't be found or interpreted.

    • getStorageClassUID

      public com.xinapse.dicom.Uid getStorageClassUID()
      Returns a UID of the Storage Class with which Objects of this Modality can be stored.
      Returns:
      a UID of the Storage Class with which DCMObjects of this Modality can be stored, or null if DCMObjects of this Modality cannot be stored.

    • requiresPositionalInformation

      public boolean requiresPositionalInformation()
      Returns true if images of this Modality requires positional information.
      Returns:
      true if images of this Modality requires positional information; false otherwise.

    • isImagingModality

      public boolean isImagingModality()
      Returns true if this is an imaging Modality.
      Returns:
      true if this is an imaging Modality; false otherwise.

    • isComputedTomography

      public boolean isComputedTomography()
      Returns true if this is a CT Modality.
      Returns:
      true if this is a CT Modality; false otherwise.

    • isMagneticResonance

      public boolean isMagneticResonance()
      Returns true if this is a magnetic resonance Modality.
      Returns:
      true if this is a magnetic resonance Modality; false otherwise.

    • isEnhanced

      public boolean isEnhanced()
      Returns true if this is an enhanced Modality.
      Returns:
      true if this is an enhanced Modality; false otherwise.

    • toString

      public String toString()
      Returns a string indicating this imaging modality.
      Overrides:
      toString in class Enum<Modality>
      Returns:
      a string indicating this modality.

    • getDescription

      public String getDescription()
      Returns a string describing this imaging modality.
      Returns:
      a string describing this modality.

    • getPreferredModality

      public static Modality getPreferredModality()
      Returns the user's most common-used Modality as set in the user Preferences.
      Returns:
      the user's preferred Modality.

    • savePreferredModality

      public static void savePreferredModality(Modality modality)
      Saves the user's most common-used Modality to the user Preferences.
      Parameters:
      modality - the user's preferred Modality.

    • getAlwaysAsk

      public static boolean getAlwaysAsk()
      Returns whether always to ask the user what is the Modality, if not set in an image.
      Returns:
      whether always to ask the user what is the Modality, if not set in an image.

    • saveAlwaysAsk

      public static void saveAlwaysAsk(boolean alwaysAsk)
      Saves whether always to ask the user what is the Modality, if not set in an image.
      Parameters:
      alwaysAsk - whether always to ask the user what is the Modality, if not set in an image.

    • main

      public static void main(String[] args)
      Run the unit test on the Modality class.
      Parameters:
      args - ignored.