Package org.dcm4che.typeddicom.dataelements

Class PatientPosition

  • All Implemented Interfaces:
    org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, CodeStringWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper
    public class PatientPosition
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements CodeStringWrapper
    Name: Patient Position
    Keyword: PatientPosition
    Tag: (0018,5100)
    Value Representation: CodeString
    Value Multiplicity: 1
    • Described in the contexts: as follows:
      Attribute Name: Patient Position
      Type: 1C
      Attribute Description:

      Patient position descriptor relative to the equipment. Required if Patient Additional Position (300A,0184) is not present. See DICOM Standard Part 3 - Section C.8.8.12.1.2 for Defined Terms and further explanation.


    • Described in the contexts: as follows:
      Attribute Name: Patient Position
      Type: 3
      Attribute Description:

      Patient position descriptor relative to the equipment. See DICOM Standard Part 3 - Section C.7.1.4.1.1.1.

      See DICOM Standard Part 3 - Section C.7.3.1.1.2 for Defined Terms and further explanation.


    • Described in the contexts: as follows:
      Attribute Name: Patient Position
      Type: 1C
      Attribute Description:

      Patient position descriptor relative to the patient support device.

      Required if Isocenter Position (300A,012C) is present. May be present otherwise.

      See DICOM Standard Part 3 - Section C.8.8.12.1.2 for Defined Terms and further explanation.

      Note

      The orientation of the patient relative to the patient support device is denoted in the same manner as in the DICOM Standard Part 3 - Section C.8.8.12. It defines the relation of the DICOM Patient-Based Coordinate System identified by the DICOM Standard Part 3 - Section C.7.4.1 of the RT Image to the IEC coordinate system and together with Isocenter Position (300A,012C) allows the RT Image to be placed into the Patient Frame of Reference. It also allows a system using an RT Image to verify that the patient is setup in a similar position relative to the patient support device.


    • Described in the contexts: as follows:
      Attribute Name: Patient Position
      Type: 3
      Attribute Description:

      Description of imaging subject's position relative to the equipment.

      See DICOM Standard Part 3 - Section C.7.3.1.1.2 for Defined Terms and further explanation.

      If present, shall be consistent with Patient Gantry Relationship Code Sequence (0054,0414) and Patient Orientation Modifier Code Sequence (0054,0412).


    • Described in the contexts: as follows:
      Attribute Name: Patient Position
      Type: 2C
      Attribute Description:

      Patient position descriptor relative to the equipment. Required for images where Patient Orientation Code Sequence (0054,0410) is not present and whose SOP Class is one of the following: CT ("1.2.840.10008.5.1.4.1.1.2") or MR ("1.2.840.10008.5.1.4.1.1.4") or Enhanced CT ("1.2.840.10008.5.1.4.1.1.2.1") or Enhanced MR Image ("1.2.840.10008.5.1.4.1.1.4.1") or Enhanced Color MR Image ("1.2.840.10008.5.1.4.1.1.4.3") or MR Spectroscopy ("1.2.840.10008.5.1.4.1.1.4.2") Storage SOP Classes.

      May be present for other SOP Classes if Patient Orientation Code Sequence (0054,0410) is not present.

      See DICOM Standard Part 3 - Section C.7.3.1.1.2 for Defined Terms and further explanation.


    • Constructor Summary

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      PatientPosition copy()
      Returns a new Patient Position which wraps a copy of the Attributes wrapped in this Patient Position.
      java.lang.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.StringDataElementWrapper

        getString, setString

    • Constructor Detail

      • PatientPosition

        public PatientPosition​(org.dcm4che3.data.Attributes attributes)
        Creates a new Patient Position object which wraps the provided attributes.
        Parameters:
        attributes - the Attributes object to be wrapped.

      • PatientPosition

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

    • Method Detail

      • copy

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

      • getPrivateCreator

        public java.lang.String getPrivateCreator()
        Specified by:
        getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

      • getTag

        public int getTag()
        Specified by:
        getTag in interface org.dcm4che.typeddicom.DataElementWrapper