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:
  • 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)

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 int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

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).
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

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

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

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

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.