Package org.dcm4che.typeddicom.dataelements

Class RTImagePlane

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RTImagePlane

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class RTImagePlane
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: RT Image Plane
Keyword: RTImagePlane
Tag: (3002,000C)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT Beams Module > Beam Sequence > Planned Verification Image Sequence > RT Image Plane
  as follows:
  Attribute Name: RT Image Plane
  Type: 3
  Attribute Description:

  Describes whether or not image plane is normal to beam axis.

  Enumerated Values:

  NORMAL

  image plane normal to beam axis

  NON_NORMAL

  image plane non-normal to beam axis

  
  
• Described in the contexts:
  • RT Image Module > RT Image Plane
  as follows:
  Attribute Name: RT Image Plane
  Type: 1
  Attribute Description:

  Describes whether or not image plane is normal to beam axis.

  Enumerated Values:

  NORMAL

  image plane normal to beam axis

  NON_NORMAL

  image plane non-normal to beam axis

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
RTImagePlane	copy()	Returns a new RT Image Plane which wraps a copy of the Attributes wrapped in this RT Image Plane.
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, getPrivateCreator, getValue

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

getString, setString

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

RTImagePlane

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

Creates a new RT Image Plane object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RTImagePlane

public RTImagePlane()

Creates a new RT Image Plane object which wraps a new and empty Attributes object.

Method Details

copy

public RTImagePlane copy()

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

Returns:

a new RT Image Plane which wraps a copy of the Attributes wrapped in this RT Image Plane.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.