Package org.dcm4che.typeddicom.dataelements

Class GantryPitchRotationDirection

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.GantryPitchRotationDirection

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class GantryPitchRotationDirection
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Gantry Pitch Rotation Direction
Keyword: GantryPitchRotationDirection
Tag: (300A,014C)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Machine Verification Module > Ion Machine Verification Sequence > Ion Control Point Verification Sequence > Gantry Pitch Rotation Direction
  as follows:
  Attribute Name: Gantry Pitch Rotation Direction
  Type:
  Attribute Description:

  Direction of Gantry Pitch Angle when viewing along the positive X-axis of the IEC GANTRY coordinate system, for segment following Control Point. See DICOM Standard Part 3 - Section C.8.8.14.8 and DICOM Standard Part 3 - Section C.8.8.25.6.5.

  Enumerated Values:

  CW

  clockwise

  CC

  counter-clockwise

  NONE

  no rotation

  
  
• Described in the contexts:
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Ion Control Point Delivery Sequence > Gantry Pitch Rotation Direction
  • RT Ion Beams Module > Ion Beam Sequence > Ion Control Point Sequence > Gantry Pitch Rotation Direction
  as follows:
  Attribute Name: Gantry Pitch Rotation Direction
  Type: 2C
  Attribute Description:

  Direction of Gantry Pitch Angle when viewing along the positive X-axis of the IEC GANTRY coordinate system, for segment following Control Point. Required for first Item of Control Point Sequence, or if Gantry Pitch Rotation Direction changes during Beam. See DICOM Standard Part 3 - Section C.8.8.14.8 and DICOM Standard Part 3 - Section C.8.8.25.6.5.

  Enumerated Values:

  CW

  clockwise

  CC

  counter-clockwise

  NONE

  no rotation

  
  
• Described in the contexts:
  • RT Beams Session Record Module > Treatment Session Beam Sequence > Control Point Delivery Sequence > Gantry Pitch Rotation Direction
  • RT Beams Module > Beam Sequence > Control Point Sequence > Gantry Pitch Rotation Direction
  as follows:
  Attribute Name: Gantry Pitch Rotation Direction
  Type: 3
  Attribute Description:

  Direction of Gantry Pitch Angle when viewing along the positive X-axis of the IEC GANTRY coordinate system, for segment following Control Point. If used, must be present for first Item of Control Point Sequence, or if used and Gantry Pitch Rotation Direction changes during Beam, must be present. See DICOM Standard Part 3 - Section C.8.8.14.8 and DICOM Standard Part 3 - Section C.8.8.25.6.5.

  Enumerated Values:

  CW

  clockwise

  CC

  counter-clockwise

  NONE

  no rotation

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GantryPitchRotationDirection.Builder<SELF extends GantryPitchRotationDirection.Builder<SELF,T>,T extends GantryPitchRotationDirection.Holder>
static interface	GantryPitchRotationDirection.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Gantry Pitch Rotation Direction" (see GantryPitchRotationDirection)
static class	GantryPitchRotationDirection.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
GantryPitchRotationDirection()	Creates a new Gantry Pitch Rotation Direction object which wraps a new and empty Attributes object.
GantryPitchRotationDirection(org.dcm4che3.data.Attributes attributes)	Creates a new Gantry Pitch Rotation Direction object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
GantryPitchRotationDirection	copy()	Returns a new Gantry Pitch Rotation Direction which wraps a copy of the Attributes wrapped in this Gantry Pitch Rotation Direction.
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

GantryPitchRotationDirection

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

Creates a new Gantry Pitch Rotation Direction object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

GantryPitchRotationDirection

public GantryPitchRotationDirection()

Creates a new Gantry Pitch Rotation Direction object which wraps a new and empty Attributes object.

Method Details

copy

public GantryPitchRotationDirection copy()

Returns a new Gantry Pitch Rotation Direction which wraps a copy of the Attributes wrapped in this Gantry Pitch Rotation Direction. (see Attributes(Attributes)

Returns:

a new Gantry Pitch Rotation Direction which wraps a copy of the Attributes wrapped in this Gantry Pitch Rotation Direction.

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.