Package org.dcm4che.typeddicom.dataelements

Class PatientOrientation

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.PatientOrientation

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringMultiWrapper, StringDataElementMultiWrapper

public class PatientOrientation
extends AbstractDataElementWrapper
implements CodeStringMultiWrapper

Name: Patient Orientation
Keyword: PatientOrientation
Tag: (0020,0020)
Value Representation: CS
Value Multiplicity: 2

• Described in the contexts:
  • General Image Module > Patient Orientation
  as follows:
  Attribute Name: Patient Orientation
  Type: 2C
  Attribute Description:

  Patient direction of the rows and columns of the image. Required if image does not require Image Orientation (Patient) (0020,0037) and Image Position (Patient) (0020,0032) or if image does not require Image Orientation (Slide) (0048,0102). May be present otherwise. See DICOM Standard Part 3 - Section C.7.6.1.1.1 for further explanation.

  Note

  IODs may have Attributes other than Patient Orientation, Image Orientation, or Image Position (Patient) to describe orientation in which case this Attribute will be zero length.

  
  
• Described in the contexts:
  • Patient Orientation in Frame Macro > Patient Orientation in Frame Sequence > Patient Orientation
  as follows:
  Attribute Name: Patient Orientation
  Type: 1
  Attribute Description:

  Patient direction of the rows and columns of this frame.

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

  
  
• Described in the contexts:
  • DX Image Module > Patient Orientation
  as follows:
  Attribute Name: Patient Orientation
  Type: 1C
  Attribute Description:

  Patient direction of the rows and columns of the image.

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

  Required if View Code Sequence (0054,0220) is not present or is present with an Item value other than http://snomed.info/id/119376003(119376003, SCT, "tissue specimen") or http://snomed.info/id/127457009(127457009, SCT, "tissue specimen from breast"). May be present otherwise.

  
  
• Described in the contexts:
  • General Reference Module > Source Image Sequence > Patient Orientation
  • Derivation Image Macro > Derivation Image Sequence > Source Image Sequence > Patient Orientation
  as follows:
  Attribute Name: Patient Orientation
  Type: 1C
  Attribute Description:

  The Patient Orientation values of the source image.

  Required if the value of Spatial Locations Preserved (0028,135A) is REORIENTED_ONLY.

  
  
• Described in the contexts:
  • Enhanced Mammography Image Module > Patient Orientation
  as follows:
  Attribute Name: Patient Orientation
  Type: 1C
  Attribute Description:

  Patient direction of the rows and columns of the most representative frame.

  Required if View Code Sequence (0054,0220) has an Item value other than one representing a specimen image. May be present otherwise.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

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

PatientOrientation

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

Creates a new Patient Orientation object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

PatientOrientation

public PatientOrientation()

Creates a new Patient Orientation object which wraps a new and empty Attributes object.

Method Details

copy

public PatientOrientation copy()

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

Returns:

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

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.