com.xinapse.dicom
Enum Modality

java.lang.Object
  java.lang.Enum<Modality>
      com.xinapse.dicom.Modality

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Modality>

public enum Modality
extends java.lang.Enum<Modality>

An enumeration of the known imaging modalities.

Nested Class Summary

static class

Modality.ComboBox A javax.swing.JComboBox that is used for selecting a Modality.

Enum Constant Summary

ANGIOSCOPY_RET
Angioscopy Modality (RETIRED).

AUDIO
Audio Modality.

BIOMAGNETIC_IMAGING
Biomagnetic imaging Modality.

CARDIAC_ELECTROPHYSIOLOGY
Cardiac electrophysiology Modality.

CINE_FLUOROGRAPHY_RET
Cine fluorography Modality (RETIRED).

COLOR_FLOW_DOPPLER
Color Doppler imaging Modality.

COMPUTED_RADIOGRAPHY
Computed radigraphy imaging Modality.

COMPUTERISED_TOMOGRAPHY
X-ray computerised tomography imaging Modality.

CULPOSCOPY_RET
Culcoscopy Modality (RETIRED).

CYSTOSCOPY_RET
Cytoscopy Modality (RETIRED).

DIAPHANOGRAPHY
Diaphonography imaging Modality.

DIGITAL_FLUOROSCOPY_RET
Digital fluoroscopy Modality (RETIRED).

DIGITAL_MICROSCOPY_RET
Digital microscopy Modality (RETIRED).

DIGITAL_RADIOGRAPHY
Digital radiography image Modality.

DIGITAL_SUBTRACTION_ANGIOGRAPHY_RET
Digital subtraction angiography Modality (RETIRED).

DUPLEX_DOPPLER
Duplex Doppler imaging Modality.

ECHOCARDIOGRAPHY_RET
Echocardiography Modality (RETIRED).

ELECTROCARDIOGRAPHY
Elecrocardiography Modality.

ENDOSCOPY
Endoscopy imaging Modality.

EXTERNAL_CAMERA_PHOTOGRAPHY
External camera Modality.

FLUORESCEIN_ANGIOGRAPHY_RET
Fluorescein angiography Modality (RETIRED).

FUNDOSCOPY_RET
Fundoscopy Modality (RETIRED).

GENERAL_MICROSCOPY
General microscopy Modality.

HAEMODYNAMIC_WAVEFORM
Haemodynamic waveform Modality.

HARD_COPY
Hard copy Modality.

INTRA_ORAL_RADIOGRAPHY
Intra-oral radiography Modality.

IVUS
Intravascular ultrasound Modality.

KEY_OBJECT_SELECTION
Key object selection Modality.

LAPAROSCOPY_RET
Laparoscopy Modality Modality (RETIRED).

LASER_SURFACE_SCAN
Laser surface scan imaging Modality.

MAGNETIC_RESONANCE
Magnetic resonance imaging Modality.

MAGNETIC_RESONANCE_ANGIOGRAPHY_RET
Magnetic resonance angiography Modality (RETIRED).

MAGNETIC_RESONANCE_SPECTROSCOPY_RET
Magnetic resonance spectroscopy Modality (RETIRED).

MAMMOGRAPHY
Mammography Modality.

NUCLEAR_MEDICINE
Nuclear medicine imaging Modality.

OPTHALMIC_MAPPING
Opthalmic mapping Modality.

OPTHALMIC_PHOTOGRAPHY
Opthalmic photography Modality.

OPTHALMIC_REFRACTION
Opthalmic refraction Modality.

OPTHALMIC_VISUAL_FIELD
Opthalmic visual field Modality.

OPTICAL_COHERENCE_TOMOGRAPHY
Optical coherence tomography Modality.

OTHER
Other Modality.

PANORAMIC_X_RAY
Panoramic X-ray Modality.

POSITRON_EMISSION_TOMOGRAPHY
Positron emission tomography imaging Modality.

PRESENTATION_STATE
Presentation state Modality.

RADIO_FLUOROSCOPY
X-ray fluoroscopy imaging Modality.

RADIOGRAPHIC_IMAGING
Radiographic imaging Modality.

RADIOTHERAPY_DOSE
Radiotherapy dose Modality.

RADIOTHERAPY_IMAGE
Radiotherapy image Modality.

RADIOTHERAPY_PLAN
Radiotherapy plan Modality.

RADIOTHERAPY_RECORD
Radiotherapy record Modality.

RADIOTHERAPY_STRUCTURE_SET
Radiotherapy structure set Modality.

REGISTRATION
Image registration Modality.

SECONDARY_CAPTUE_RET
Secondary capture imaging Modality (RETIRED).

SEGMENTATION
Image segmentation Modality.

SINGLE_PHOTON_EMISSION_COMPUTED_TOMOGRAPHY
SPECT imaging Modality.

SLIDE_MISCROSCOPY
Slide microscopy Modality.

SR_DOCUMENT
Structured report document Modality.

STEREOMETRIC_RELATIONSHIP
Sterometric relationship Modality.

THERMOGRAPHY
Thermography imaging Modality.

ULTRASOUND
Ultrasound imaging Modality.

VIDEOFLUOROGRAPHY_RET
Videofluorography Modality (RETIRED).

X_RAY_ANGIOGRAPHY
X-ray angiography imaging Modality.

Field Summary

static java.lang.String

MODALITY_PREFERENCE_NAME The Preference name for the imaging modality.

Method Summary

static Modality	getInstance(java.lang.String ms) Returns a Modality Object corresponding to the supplied string.
com.xinapse.dicom.Uid	getStorageClassUID() Returns the UID of the Storage Class with which Objects of this Modality should be stored.
boolean	isImagingModality() Returns true if this is an imaging Modality.
static void	main(java.lang.String[] args) Run the unit test on the Modality class.
boolean	requiresPositionalInformation() Returns true if images of this Modality require positional information.
java.lang.String	toString() Returns a string describing this imaging modality.
static Modality	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Modality[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COMPUTED_RADIOGRAPHY

public static final Modality COMPUTED_RADIOGRAPHY

Computed radigraphy imaging Modality.

COMPUTERISED_TOMOGRAPHY

public static final Modality COMPUTERISED_TOMOGRAPHY

X-ray computerised tomography imaging Modality.

MAGNETIC_RESONANCE

public static final Modality MAGNETIC_RESONANCE

Magnetic resonance imaging Modality.

NUCLEAR_MEDICINE

public static final Modality NUCLEAR_MEDICINE

Nuclear medicine imaging Modality.

ULTRASOUND

public static final Modality ULTRASOUND

Ultrasound imaging Modality.

OTHER

public static final Modality OTHER

Other Modality.

BIOMAGNETIC_IMAGING

public static final Modality BIOMAGNETIC_IMAGING

Biomagnetic imaging Modality.

COLOR_FLOW_DOPPLER

public static final Modality COLOR_FLOW_DOPPLER

Color Doppler imaging Modality.

DUPLEX_DOPPLER

public static final Modality DUPLEX_DOPPLER

Duplex Doppler imaging Modality.

DIAPHANOGRAPHY

public static final Modality DIAPHANOGRAPHY

Diaphonography imaging Modality.

ENDOSCOPY

public static final Modality ENDOSCOPY

Endoscopy imaging Modality.

LASER_SURFACE_SCAN

public static final Modality LASER_SURFACE_SCAN

Laser surface scan imaging Modality.

POSITRON_EMISSION_TOMOGRAPHY

public static final Modality POSITRON_EMISSION_TOMOGRAPHY

Positron emission tomography imaging Modality.

RADIOGRAPHIC_IMAGING

public static final Modality RADIOGRAPHIC_IMAGING

Radiographic imaging Modality.

SINGLE_PHOTON_EMISSION_COMPUTED_TOMOGRAPHY

public static final Modality SINGLE_PHOTON_EMISSION_COMPUTED_TOMOGRAPHY

SPECT imaging Modality.

THERMOGRAPHY

public static final Modality THERMOGRAPHY

Thermography imaging Modality.

X_RAY_ANGIOGRAPHY

public static final Modality X_RAY_ANGIOGRAPHY

X-ray angiography imaging Modality.

RADIO_FLUOROSCOPY

public static final Modality RADIO_FLUOROSCOPY

X-ray fluoroscopy imaging Modality.

RADIOTHERAPY_IMAGE

public static final Modality RADIOTHERAPY_IMAGE

Radiotherapy image Modality.

RADIOTHERAPY_DOSE

public static final Modality RADIOTHERAPY_DOSE

Radiotherapy dose Modality.

RADIOTHERAPY_STRUCTURE_SET

public static final Modality RADIOTHERAPY_STRUCTURE_SET

Radiotherapy structure set Modality.

RADIOTHERAPY_PLAN

public static final Modality RADIOTHERAPY_PLAN

Radiotherapy plan Modality.

RADIOTHERAPY_RECORD

public static final Modality RADIOTHERAPY_RECORD

Radiotherapy record Modality.

HARD_COPY

public static final Modality HARD_COPY

Hard copy Modality.

DIGITAL_RADIOGRAPHY

public static final Modality DIGITAL_RADIOGRAPHY

Digital radiography image Modality.

MAMMOGRAPHY

public static final Modality MAMMOGRAPHY

Mammography Modality.

INTRA_ORAL_RADIOGRAPHY

public static final Modality INTRA_ORAL_RADIOGRAPHY

Intra-oral radiography Modality.

PANORAMIC_X_RAY

public static final Modality PANORAMIC_X_RAY

Panoramic X-ray Modality.

GENERAL_MICROSCOPY

public static final Modality GENERAL_MICROSCOPY

General microscopy Modality.

SLIDE_MISCROSCOPY

public static final Modality SLIDE_MISCROSCOPY

Slide microscopy Modality.

EXTERNAL_CAMERA_PHOTOGRAPHY

public static final Modality EXTERNAL_CAMERA_PHOTOGRAPHY

External camera Modality.

PRESENTATION_STATE

public static final Modality PRESENTATION_STATE

Presentation state Modality.

AUDIO

public static final Modality AUDIO

Audio Modality.

ELECTROCARDIOGRAPHY

public static final Modality ELECTROCARDIOGRAPHY

Elecrocardiography Modality.

CARDIAC_ELECTROPHYSIOLOGY

public static final Modality CARDIAC_ELECTROPHYSIOLOGY

Cardiac electrophysiology Modality.

HAEMODYNAMIC_WAVEFORM

public static final Modality HAEMODYNAMIC_WAVEFORM

Haemodynamic waveform Modality.

SR_DOCUMENT

public static final Modality SR_DOCUMENT

Structured report document Modality.

IVUS

public static final Modality IVUS

Intravascular ultrasound Modality.

OPTHALMIC_PHOTOGRAPHY

public static final Modality OPTHALMIC_PHOTOGRAPHY

Opthalmic photography Modality.

STEREOMETRIC_RELATIONSHIP

public static final Modality STEREOMETRIC_RELATIONSHIP

Sterometric relationship Modality.

OPTICAL_COHERENCE_TOMOGRAPHY

public static final Modality OPTICAL_COHERENCE_TOMOGRAPHY

Optical coherence tomography Modality.

OPTHALMIC_REFRACTION

public static final Modality OPTHALMIC_REFRACTION

Opthalmic refraction Modality.

OPTHALMIC_VISUAL_FIELD

public static final Modality OPTHALMIC_VISUAL_FIELD

Opthalmic visual field Modality.

OPTHALMIC_MAPPING

public static final Modality OPTHALMIC_MAPPING

Opthalmic mapping Modality.

KEY_OBJECT_SELECTION

public static final Modality KEY_OBJECT_SELECTION

Key object selection Modality.

SEGMENTATION

public static final Modality SEGMENTATION

Image segmentation Modality.

REGISTRATION

public static final Modality REGISTRATION

Image registration Modality.

DIGITAL_SUBTRACTION_ANGIOGRAPHY_RET

public static final Modality DIGITAL_SUBTRACTION_ANGIOGRAPHY_RET

Digital subtraction angiography Modality (RETIRED). Use XA instead.

CINE_FLUOROGRAPHY_RET

public static final Modality CINE_FLUOROGRAPHY_RET

Cine fluorography Modality (RETIRED). Use RF instead.

DIGITAL_FLUOROSCOPY_RET

public static final Modality DIGITAL_FLUOROSCOPY_RET

Digital fluoroscopy Modality (RETIRED). Use RF instead.

VIDEOFLUOROGRAPHY_RET

public static final Modality VIDEOFLUOROGRAPHY_RET

Videofluorography Modality (RETIRED). Use RF instead.

ANGIOSCOPY_RET

public static final Modality ANGIOSCOPY_RET

Angioscopy Modality (RETIRED).

CYSTOSCOPY_RET

public static final Modality CYSTOSCOPY_RET

Cytoscopy Modality (RETIRED).

ECHOCARDIOGRAPHY_RET

public static final Modality ECHOCARDIOGRAPHY_RET

Echocardiography Modality (RETIRED).

LAPAROSCOPY_RET

public static final Modality LAPAROSCOPY_RET

Laparoscopy Modality Modality (RETIRED).

FLUORESCEIN_ANGIOGRAPHY_RET

public static final Modality FLUORESCEIN_ANGIOGRAPHY_RET

Fluorescein angiography Modality (RETIRED).

CULPOSCOPY_RET

public static final Modality CULPOSCOPY_RET

Culcoscopy Modality (RETIRED).

DIGITAL_MICROSCOPY_RET

public static final Modality DIGITAL_MICROSCOPY_RET

Digital microscopy Modality (RETIRED).

FUNDOSCOPY_RET

public static final Modality FUNDOSCOPY_RET

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

SECONDARY_CAPTUE_RET

public static final Modality SECONDARY_CAPTUE_RET

Secondary capture imaging Modality (RETIRED). Use the original Modality instead.

Field Detail

MODALITY_PREFERENCE_NAME

public static final java.lang.String MODALITY_PREFERENCE_NAME

The Preference name for the imaging modality.

See Also:

Constant Field Values

Method Detail

values

public static Modality[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Modality c : Modality.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Modality valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getInstance

public static Modality getInstance(java.lang.String ms)
                            throws com.xinapse.util.InvalidArgumentException

Returns a Modality Object corresponding to the supplied string.

Parameters:

ms - one of the defined DICOM terms for the imagine modality, for example "MR" for magnetic resonance. If ms does not match any of these, then Modality.UNKNOWN is returned.

Throws:

com.xinapse.util.InvalidArgumentException

getStorageClassUID

public com.xinapse.dicom.Uid getStorageClassUID()

Returns the UID of the Storage Class with which Objects of this Modality should be stored.

Returns:

the UID of the Storgae Class with which DCMObjects of this Modality should be stored, or null if DCMObjects of this Modality cannot be stored.

requiresPositionalInformation

public boolean requiresPositionalInformation()

Returns true if images of this Modality require positional information.

isImagingModality

public boolean isImagingModality()

Returns true if this is an imaging Modality.

Returns:

true if this is an imaging Modality; false otherwise.

toString

public java.lang.String toString()

Returns a string describing this imaging modality.

Overrides:

toString in class java.lang.Enum<Modality>

Returns:

a string describing this modality.

main

public static void main(java.lang.String[] args)

Run the unit test on the Modality class.

Parameters:

args - ignored.