java.lang.Object
- org.dcm4che.typeddicom.AbstractAttributesWrapper
- - org.dcm4che.typeddicom.AbstractDataElementWrapper
  - - org.dcm4che.typeddicom.dataelements.ReferencedROINumber

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.IntDataElementWrapper, IntegerStringWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper
```
public class ReferencedROINumber
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements IntegerStringWrapper
```
Name: Referenced ROI Number
Keyword: ReferencedROINumber
Tag: (3006,0084)
Value Representation: IntegerString
Value Multiplicity: 1
- Described in the contexts:
  - RT DVH Module > DVH Sequence > DVH Referenced ROI Sequence > Referenced ROI Number
  as follows:
  Attribute Name: Referenced ROI Number
  Type: 1
  Attribute Description:
  Uniquely identifies ROI used to calculate DVH specified by ROI Number (3006,0022) in Structure Set ROI Sequence (3006,0020) in DICOM Standard Part 3 - Section C.8.8.5 within RT Structure Set referenced by referenced RT Plan in Referenced RT Plan Sequence (300C,0002) in DICOM Standard Part 3 - Section C.8.8.3.
- Described in the contexts:
  - Spatial Fiducials Module > Fiducial Set Sequence > Fiducial Sequence > Definition Source Sequence > Referenced ROI Number
  as follows:
  Attribute Name: Referenced ROI Number
  Type: 1C
  Attribute Description:
  The value of ROI Number (3006,0022) in the referenced SOP Instance that identifies the ROI that is the origin of the Spatial Fiducial information.
  
  Required if Referenced SOP Class UID (0008,1150) is RT Structure Set Storage ("1.2.840.10008.5.1.4.1.1.481.3").
- Described in the contexts:
  - RT Dose Module > Plan Overview Sequence > Prescription Overview Sequence > Referenced ROI Number
  as follows:
  Attribute Name: Referenced ROI Number
  Type: 3
  Attribute Description:
  ROI for which the prescription parameters in this Sequence apply, specified by ROI Number (3006,0022) in the Instance referenced by Referenced Structure Set Sequence (300C,0060).
- Described in the contexts:
  - Spatial Registration Module > Registration Sequence > Used RT Structure Set ROI Sequence Sequence > Referenced ROI Number
  as follows:
  Attribute Name: Referenced ROI Number
  Type: 1
  Attribute Description:
  Uniquely identifies the ROI described in the Structure Set ROI Sequence (3006,0020) by reference to ROI Number (3006,0022).
- Described in the contexts:
  as follows:
  Attribute Name: Referenced ROI Number
  Type: 1
  Attribute Description:
  Uniquely identifies ROI representing the Bolus specified by ROI Number (3006,0022) in Structure Set ROI Sequence (3006,0020) in DICOM Standard Part 3 - Section C.8.8.5 within RT Structure Set in Referenced Structure Set Sequence (300C,0060) in DICOM Standard Part 3 - Section C.8.8.9.
- Described in the contexts:
  - RT Brachy Application Setups Module > Application Setup Sequence > Channel Sequence > Channel Shield Sequence > Referenced ROI Number
  as follows:
  Attribute Name: Referenced ROI Number
  Type: 2
  Attribute Description:
  Uniquely identifies ROI representing the Channel Shield specified by ROI Number (3006,0022) in Structure Set ROI Sequence (3006,0020) in DICOM Standard Part 3 - Section C.8.8.5 within RT Structure Set referenced by Referenced RT Structure Set Sequence (300C,0060) in DICOM Standard Part 3 - Section C.8.8.9. See DICOM Standard Part 3 - Section C.8.8.15.2.
- Described in the contexts:
  - RT ROI Observations Module > RT ROI Observations Sequence > RT Related ROI Sequence > Referenced ROI Number
  as follows:
  Attribute Name: Referenced ROI Number
  Type: 1
  Attribute Description:
  Uniquely identifies the related ROI described in the Structure Set ROI Sequence (3006,0020).
- Described in the contexts:
  - ROI Contour Module > ROI Contour Sequence > Referenced ROI Number
  - RT ROI Observations Module > RT ROI Observations Sequence > Referenced ROI Number
  as follows:
  Attribute Name: Referenced ROI Number
  Type: 1
  Attribute Description:
  Uniquely identifies the referenced ROI described in the Structure Set ROI Sequence (3006,0020).
- Described in the contexts:
  - RT Brachy Application Setups Module > Application Setup Sequence > Channel Sequence > Referenced ROI Number
  as follows:
  Attribute Name: Referenced ROI Number
  Type: 2C
  Attribute Description:
  Uniquely identifies the ROI representing the Channel shape.
  
  Specified by ROI Number (3006,0022) in Structure Set ROI Sequence (3006,0020) in DICOM Standard Part 3 - Section C.8.8.5 within RT Structure Set referenced by Referenced RT Structure Set Sequence (300C,0060) in DICOM Standard Part 3 - Section C.8.8.9.
  
  Required if Source Applicator Number (300A,0290) is present. See DICOM Standard Part 3 - Section C.8.8.15.2.
- Described in the contexts:
  - RT Dose ROI Module > RT Dose ROI Sequence > Referenced ROI Number
  as follows:
  Attribute Name: Referenced ROI Number
  Type: 1
  Attribute Description:
  Uniquely identifies the referenced ROI within the current RT Dose. See Note 1 and DICOM Standard Part 3 - Section C.8.8.7.2.
- Described in the contexts:
  - RT Brachy Application Setups Module > Application Setup Sequence > Brachy Accessory Device Sequence > Referenced ROI Number
  as follows:
  Attribute Name: Referenced ROI Number
  Type: 2
  Attribute Description:
  Uniquely identifies ROI representing the Brachy Accessory specified by ROI Number (3006,0022) in Structure Set ROI Sequence (3006,0020) in DICOM Standard Part 3 - Section C.8.8.5 within RT Structure Set referenced by Referenced RT Structure Set Sequence (300C,0060) in DICOM Standard Part 3 - Section C.8.8.9. See DICOM Standard Part 3 - Section C.8.8.15.2.
- Described in the contexts:
  - RT General Machine Verification Module > General Machine Verification Sequence > Referenced Bolus Sequence > Referenced ROI Number
  as follows:
  Attribute Name: Referenced ROI Number
  Type:
  Attribute Description:
  Uniquely identifies ROI representing the Bolus specified by ROI Number (3006,0022) in Structure Set ROI Sequence (3006,0020) in DICOM Standard Part 3 - Section C.8.8.5 within RT Structure Set in Referenced Structure Set Sequence (300C,0060) in DICOM Standard Part 3 - Section C.8.8.9.
- Described in the contexts:
  - Segment Reference Module > Segment Reference Sequence > Direct Segment Reference Sequence > Referenced ROI Number
  as follows:
  Attribute Name: Referenced ROI Number
  Type: 1C
  Attribute Description:
  ROI Number (3006,0022) in the referenced SOP Instance.
  
  Required as described in DICOM Standard Part 3 - Section C.36.9.1.1.
  
  See DICOM Standard Part 3 - Section C.36.9.1.1.
- Described in the contexts:
  - Segment Description Macro > Definition Source Sequence > Referenced ROI Number
  as follows:
  Attribute Name: Referenced ROI Number
  Type: 1C
  Attribute Description:
  The value of ROI Number (3006,0022) in the referenced SOP Instance that identifies the ROI that is the origin of the Segment information.
  
  Required if Referenced SOP Class UID (0008,1150) is RT Structure Set Storage ("1.2.840.10008.5.1.4.1.1.481.3").
- Described in the contexts:
  - RT Prescription Module > Dose Reference Sequence > Referenced ROI Number
  as follows:
  Attribute Name: Referenced ROI Number
  Type: 1C
  Attribute Description:
  Uniquely identifies ROI representing the dose reference specified by ROI Number (3006,0022) in Structure Set ROI Sequence (3006,0020) in DICOM Standard Part 3 - Section C.8.8.5 within RT Structure Set in Referenced Structure Set Sequence (300C,0060) in DICOM Standard Part 3 - Section C.8.8.9. Required if Dose Reference Structure Type (300A,0014) is POINT or VOLUME.
- Described in the contexts:
  - RT Beams Session Record Module > Treatment Session Beam Sequence > Referenced Bolus Sequence > Referenced ROI Number
  as follows:
  Attribute Name: Referenced ROI Number
  Type: 1
  Attribute Description:
  Uniquely identifies ROI representing the bolus specified by ROI Number (3006,0022) in Structure Set ROI Sequence (3006,0020) in DICOM Standard Part 3 - Section C.8.8.5 within DICOM Standard Part 3 - Section A.19 referenced by referenced RT Plan in Referenced RT Plan Sequence (300C,0002) in DICOM Standard Part 3 - Section C.8.8.17.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static interface`	`ReferencedROINumber.Builder<SELF extends ReferencedROINumber.Builder<SELF,T>,T extends ReferencedROINumber.Holder>`
`static interface`	`ReferencedROINumber.Holder`	A class implementing this interface can hold attributes which contain the DICOM tag "Referenced ROI Number" (see `ReferencedROINumber`)

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.IntegerStringWrapper
IntegerStringWrapper.Setter<B extends org.dcm4che.typeddicom.Builder<B,? extends org.dcm4che.typeddicom.AttributesWrapper>,D extends IntegerStringWrapper>

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`PRIVATE_CREATOR`	The Private Creator associated with this class.
`static int`	`TAG`	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.IntegerStringWrapper
VALUE_REPRESENTATION

Constructor Summary

Constructors
Constructor	Description
`ReferencedROINumber()`	Creates a new Referenced ROI Number object which wraps a new and empty `Attributes` object.
`ReferencedROINumber(org.dcm4che3.data.Attributes attributes)`	Creates a new Referenced ROI Number object which wraps the provided `attributes`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ReferencedROINumber`	`copy()`	Returns a new Referenced ROI Number which wraps a copy of the Attributes wrapped in this Referenced ROI Number.
`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.IntDataElementWrapper
getInt, setInt

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.IntegerStringWrapper
getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper
getString, setString

- Field Detail
  - PRIVATE_CREATOR
```
public static final java.lang.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 Detail
  - ReferencedROINumber
```
public ReferencedROINumber(org.dcm4che3.data.Attributes attributes)
```
    Creates a new Referenced ROI Number object which wraps the provided attributes.
    
    Parameters:
    
    attributes - the Attributes object to be wrapped.
  - ReferencedROINumber
```
public ReferencedROINumber()
```
    Creates a new Referenced ROI Number object which wraps a new and empty Attributes object.
- Method Detail
  - copy
```
public ReferencedROINumber copy()
```
    Returns a new Referenced ROI Number which wraps a copy of the Attributes wrapped in this Referenced ROI Number. (see Attributes(Attributes)
    
    Returns:
    
    a new Referenced ROI Number which wraps a copy of the Attributes wrapped in this Referenced ROI Number.
  - 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

Class ReferencedROINumber

Nested Class Summary

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

Field Summary

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.IntegerStringWrapper

Constructor Summary

Method Summary

Methods inherited from class org.dcm4che.typeddicom.AbstractDataElementWrapper

Methods inherited from class org.dcm4che.typeddicom.AbstractAttributesWrapper

Methods inherited from class java.lang.Object

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

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

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

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

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

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

Field Detail

PRIVATE_CREATOR

TAG

Constructor Detail

ReferencedROINumber

ReferencedROINumber

Method Detail

copy

getPrivateCreator

getTag