Package org.dcm4che.typeddicom.dataelements

Class Modality

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.Modality

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class Modality
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Modality
Keyword: Modality
Tag: (0008,0060)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Visual Acuity Measurements Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the measurements in this Series.

  Enumerated Values:

  VA

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Ophthalmic Tomography B-scan Volume Analysis Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the images in this Series.

  Enumerated Values:

  OPTBSV

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Autorefraction Measurements Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the measurements in this Series.

  Enumerated Values:

  AR

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Ophthalmic Thickness Map Series Module > Modality
  • Corneal Topography Map Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that created the maps in this Series.

  Enumerated Values:

  OPM

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Ophthalmic Photography Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the images in this Series.

  Enumerated Values:

  OP

  
  
• Described in the contexts:
  • DX Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the images in this Series.

  Enumerated Values:

  DX

  PX

  IO

  MG

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • CT Protocol Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method to which the protocols in this Series apply.

  Enumerated Values:

  CTPROTOCOL

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Lensometry Measurements Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the measurements in this Series.

  Enumerated Values:

  LEN

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Enhanced US Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the images in this Series.

  Enumerated Values:

  US

  IVUS

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Stereometric Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that created the Instances in this Series.

  Enumerated Values:

  SMR

  
  
• Described in the contexts:
  • Intravascular OCT Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the images in this Series.

  Enumerated Values:

  IVOCT

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Image Acquisition Results Module > Modality
  as follows:
  Attribute Name: Modality
  Type:
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the Instances associated with this Modality Performed Procedure Step.

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for Defined Terms.

  Note

  A Modality value in the created SOP Instances may be different from the MPPS Modality value. For example, multiple Series may have been created during the MPPS (images, waveforms, softcopy presentation states and/or structured reports) with SOP Instances in different Series having different modality values.

  
  
• Described in the contexts:
  • Ophthalmic Tomography En Face Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the images in this Series.

  Enumerated Values:

  OPTENF

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Optical Surface Scanner Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the images in this Series.

  Enumerated Values:

  OSS

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Intra-Oral Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the images in this Series.

  Enumerated Values:

  IO

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Intraocular Lens Calculations Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that performed the calculations in this Series.

  Enumerated Values:

  IOL

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Whole Slide Microscopy Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the images in this Series.

  Enumerated Values:

  SM

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Mammography Series Module > Modality
  • Enhanced Mammography Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the images in this Series.

  Enumerated Values:

  MG

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Parametric Map Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that created the Instances in this Series

  Note

  1. It is expected that the majority of Parametric Maps will use the appropriate value for the acquisition modality, e.g., "MR", and so no specific Defined Terms or Enumerated Values are specified here.

  2. If the image is derived from multiple modalities, then a value of "OT" is appropriate.

  
  
• Described in the contexts:
  • Ophthalmic Axial Measurements Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the measurements in this Series.

  Enumerated Values:

  OAM

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Scheduled Procedure Step Module > Scheduled Procedure Step Sequence > Modality
  as follows:
  Attribute Name: Modality
  Type:
  Attribute Description:

  Type of device, process or method for which the Scheduled Procedure Step is scheduled.

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for Defined Terms.

  
  
• Described in the contexts:
  • SR Document Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that created the Instances in this Series.

  Enumerated Values:

  SR

  SR Document

  
  
• Described in the contexts:
  • General Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired or produced the data used to create the Instances in this Series.

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for Defined Terms.

  
  
• Described in the contexts:
  • Real World Value Mapping Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that created the Instances in this Series.

  Enumerated Values:

  RWV

  
  
• Described in the contexts:
  • Enhanced PET Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the images in this Series.

  Enumerated Values:

  PT

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Key Object Document Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that created the Instances in this Series.

  Enumerated Values:

  KO

  Key Object Selection

  
  
• Described in the contexts:
  • Ophthalmic Tomography Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the images in this Series.

  Enumerated Values:

  OPT

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Segmentation Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that created the Instances in this Series

  Enumerated Values:

  SEG

  
  
• Described in the contexts:
  • XA/XRF Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the images in this Series.

  Enumerated Values:

  XA

  RF

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Microscopy Bulk Simple Annotations Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that created the Instances in this Series.

  Enumerated Values:

  ANN

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Keratometry Measurements Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the measurements in this Series.

  Enumerated Values:

  KER

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Presentation Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that created the Instances in this Series.

  Enumerated Values:

  PR

  Presentation State

  See DICOM Standard Part 3 - Section C.7.3.1.1.1.

  
  
• Described in the contexts:
  • MR Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the images in this Series.

  Enumerated Values:

  MR

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Spatial Fiducials Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that created the Instances in this Series.

  Enumerated Values:

  FID

  
  
• Described in the contexts:
  • XA Protocol Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method to which the protocols in this Series apply.

  Enumerated Values:

  XAPROTOCOL

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Encapsulated Document Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that created the Instances in this Series.

  This Type definition shall override the definition in the DICOM Standard Part 3 - Section C.8.6.1.

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for Defined Terms.

  Note

  SR may be an appropriate value for an Encapsulated CDA document with a structured XML Body.

  
  
• Described in the contexts:
  • CT Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the images in this Series.

  Enumerated Values:

  CT

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Subjective Refraction Measurements Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the measurements in this Series.

  Enumerated Values:

  SRF

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Visual Field Static Perimetry Measurements Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the measurements in this Series.

  Enumerated Values:

  OPV

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Tractography Results Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the Instances in this Series.

  Enumerated Values:

  MR

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • SC Equipment Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 3
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the Instances in this Series.

  This type definition shall override the definition in the DICOM Standard Part 3 - Section C.7.3.1. See Note 2.

  See DICOM Standard Part 3 - Section C.7.3.1.1.1 for Defined Terms.

  
  
• Described in the contexts:
  • RT Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the Instances in this Series.

  Enumerated Values:

  RTIMAGE

  RT Image

  RTDOSE

  RT Dose

  RTSTRUCT

  RT Structure Set

  RTPLAN

  RT Plan

  RTRECORD

  RT Treatment Record

  See DICOM Standard Part 3 - Section C.8.8.1.1.

  
  
• Described in the contexts:
  • Hanging Protocol Definition Module > Hanging Protocol Definition Sequence > Modality
  as follows:
  Attribute Name: Modality
  Type: 1C
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create images or related objects to which this Hanging Protocol applies. See DICOM Standard Part 3 - Section C.7.3.1.1.1 for Defined Terms.

  Required if Anatomic Region Sequence (0008,2218) is not present. May be present otherwise.

  
  
• Described in the contexts:
  • Spatial Registration Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that created the Instances in this Series.

  Enumerated Values:

  REG

  
  
• Described in the contexts:
  • Enhanced RT Series Module > Modality
  as follows:
  Attribute Name: Modality
  Type: 1
  Attribute Description:

  Type of device, process or method that originally acquired the data used to create the Instances in this Series.

  See DICOM Standard Part 3 - Section C.36.3.1.1.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Modality.Builder<SELF extends Modality.Builder<SELF,T>,T extends Modality.Holder>
static interface	Modality.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Modality" (see Modality)
static class	Modality.SimpleHolder

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.CodeStringWrapper

CodeStringWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends CodeStringWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRIVATE_CREATOR	The Private Creator associated with this class.
static final int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.CodeStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
Modality()	Creates a new Modality object which wraps a new and empty Attributes object.
Modality(org.dcm4che3.data.Attributes attributes)	Creates a new Modality object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
Modality	copy()	Returns a new Modality which wraps a copy of the Attributes wrapped in this Modality.
String	getPrivateCreator()
int	getTag()

Methods inherited from class org.dcm4che.typeddicom.AbstractDataElementWrapper

equals, exists, getValue, hashCode, toString

Methods inherited from class org.dcm4che.typeddicom.AbstractAttributesWrapper

getAttributes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper

getBytes, getSafeBytes, setBytes

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.CodeStringWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

getString, setString

Field Details

PRIVATE_CREATOR

public static final String PRIVATE_CREATOR

The Private Creator associated with this class.

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

Modality

public Modality(org.dcm4che3.data.Attributes attributes)

Creates a new Modality object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

Modality

public Modality()

Creates a new Modality object which wraps a new and empty Attributes object.

Method Details

copy

public Modality copy()

Returns a new Modality which wraps a copy of the Attributes wrapped in this Modality. (see Attributes(Attributes)

Returns:

a new Modality which wraps a copy of the Attributes wrapped in this Modality.

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.