Package org.dcm4che.typeddicom.dataelements

Class RTImageDescription

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RTImageDescription

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortTextWrapper, StringDataElementWrapper

public class RTImageDescription
extends AbstractDataElementWrapper
implements ShortTextWrapper

Name: RT Image Description
Keyword: RTImageDescription
Tag: (3002,0004)
Value Representation: ST
Value Multiplicity: 1

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

  User-defined description of RT Image.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
RTImageDescription()	Creates a new RT Image Description object which wraps a new and empty Attributes object.
RTImageDescription(org.dcm4che3.data.Attributes attributes)	Creates a new RT Image Description object which wraps the provided attributes.

Method Summary

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

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

getValueRepresentation

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

RTImageDescription

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

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

Parameters:

attributes - The Attributes object to be wrapped.

RTImageDescription

public RTImageDescription()

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

Method Details

copy

public RTImageDescription copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.