Package org.dcm4che.typeddicom.dataelements

Class RTROIRelationship

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RTROIRelationship

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class RTROIRelationship
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: RT ROI Relationship
Keyword: RTROIRelationship
Tag: (3006,0033)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT ROI Observations Module > RT ROI Observations Sequence > RT Related ROI Sequence > RT ROI Relationship
  as follows:
  Attribute Name: RT ROI Relationship
  Type: 3
  Attribute Description:

  Relationship of referenced ROI with respect to referencing ROI.

  Defined Terms:

  SAME

  ROIs represent the same entity

  ENCLOSED

  referenced ROI completely encloses referencing ROI

  ENCLOSING

  referencing ROI completely encloses referenced ROI

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
RTROIRelationship	copy()	Returns a new RT ROI Relationship which wraps a copy of the Attributes wrapped in this RT ROI Relationship.
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

RTROIRelationship

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

Creates a new RT ROI Relationship object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RTROIRelationship

public RTROIRelationship()

Creates a new RT ROI Relationship object which wraps a new and empty Attributes object.

Method Details

copy

public RTROIRelationship copy()

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

Returns:

a new RT ROI Relationship which wraps a copy of the Attributes wrapped in this RT ROI Relationship.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.