Package org.dcm4che.typeddicom.dataelements

Class ImagePositionPatient

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ImagePositionPatient

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DecimalStringMultiWrapper, DoubleDataElementMultiWrapper, FloatDataElementMultiWrapper, StringDataElementMultiWrapper

public class ImagePositionPatient
extends AbstractDataElementWrapper
implements DecimalStringMultiWrapper

Name: Image Position (Patient)
Keyword: ImagePositionPatient
Tag: (0020,0032)
Value Representation: DS
Value Multiplicity: 3

• Described in the contexts:
  • Deformable Spatial Registration Module > Deformable Registration Sequence > Deformable Registration Grid Sequence > Image Position (Patient)
  as follows:
  Attribute Name: Image Position (Patient)
  Type: 1
  Attribute Description:

  The x, y, and z coordinates of the upper left hand voxel (center of the first voxel transmitted) of the grid, in mm in the Registered Frame of Reference. See DICOM Standard Part 3 - Section C.7.6.2.1.1 for further explanation.

  
  
• Described in the contexts:
  • Plane Position (Patient) Macro > Plane Position Sequence > Image Position (Patient)
  as follows:
  Attribute Name: Image Position (Patient)
  Type: 1C
  Attribute Description:

  The x, y, and z coordinates of the upper left hand corner (center of the first voxel transmitted) of the frame, in mm. See DICOM Standard Part 3 - Section C.7.6.2.1.1 and DICOM Standard Part 3 - Section C.7.6.16.2.3.1 for further explanation.

  Note

  In the case of CT images with an Acquisition Type (0018,9302) of CONSTANT_ANGLE the image plane is defined to pass through the data collection center and be normal to the central ray of the diverging X-Ray beam.

  Required if:

  • Frame Type (0008,9007) Value 1 of this frame is ORIGINAL and Volumetric Properties (0008,9206) of this frame is other than DISTORTED, or

  • SOP Class UID is Segmentation Storage ("1.2.840.10008.5.1.4.1.1.66.4") and Frame of Reference UID (0020,0052) is present, or

  • SOP Class UID is Ophthalmic Tomography Image Storage ("1.2.840.10008.5.1.4.1.1.77.1.5.4") and Ophthalmic Volumetric Properties Flag (0022,1622) is YES, or

  • SOP Class UID is Ophthalmic Optical Coherence Tomography B-scan Volume Analysis Storage ("1.2.840.10008.5.1.4.1.1.77.1.5.8").

  May be present otherwise.

  
  
• Described in the contexts:
  • Image Plane Module > Image Position (Patient)
  as follows:
  Attribute Name: Image Position (Patient)
  Type: 1
  Attribute Description:

  The x, y, and z coordinates of the upper left hand corner (center of the first voxel transmitted) of the image, in mm. See DICOM Standard Part 3 - Section C.7.6.2.1.1 for further explanation.

  
  
• Described in the contexts:
  • ROI Contour Module > ROI Contour Sequence > Source Pixel Planes Characteristics Sequence > Image Position (Patient)
  as follows:
  Attribute Name: Image Position (Patient)
  Type: 1
  Attribute Description:

  The x, y and z coordinates in mm of the upper left hand corner of the pixel matrix in the Patient-Based Coordinate System described in DICOM Standard Part 3 - Section C.7.6.2.1.1.

  
  
• Described in the contexts:
  • NM Detector Module > Detector Information Sequence > Image Position (Patient)
  as follows:
  Attribute Name: Image Position (Patient)
  Type: 2
  Attribute Description:

  The x, y, and z coordinates of the upper left hand corner (center of the first voxel transmitted) of the image, in mm. See DICOM Standard Part 3 - Section C.7.6.2.1.1 for further explanation.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ImagePositionPatient	copy()	Returns a new Image Position (Patient) which wraps a copy of the Attributes wrapped in this Image Position (Patient).
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.DataElementWrapper

exists, getValue

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

getValueRepresentation

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

getDouble, getDoubles, setDoubles

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

getFloat, getFloats, setFloats

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

getString, getString, getStrings, setStrings

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

ImagePositionPatient

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

Creates a new Image Position (Patient) object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ImagePositionPatient

public ImagePositionPatient()

Creates a new Image Position (Patient) object which wraps a new and empty Attributes object.

Method Details

copy

public ImagePositionPatient copy()

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

Returns:

a new Image Position (Patient) which wraps a copy of the Attributes wrapped in this Image Position (Patient).

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.