Package org.dcm4che.typeddicom.dataelements

Class TrackingID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.TrackingID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, StringDataElementWrapper, UnlimitedTextWrapper

public class TrackingID
extends AbstractDataElementWrapper
implements UnlimitedTextWrapper

Name: Tracking ID
Keyword: TrackingID
Tag: (0062,0020)
Value Representation: UT
Value Multiplicity: 1

• Described in the contexts:
  • Dermoscopic Image Module > Tracking ID
  as follows:
  Attribute Name: Tracking ID
  Type: 1C
  Attribute Description:

  A text label used for tracking a finding or feature, potentially across multiple reporting objects, over time. This label shall be unique within the domain in which it is used.

  Required if Tracking UID (0062,0021) is present.

  Note

  This Attribute allows linkage to Content Items in SR instances with observation context PS3.16 DCM112039(112039, DCM, "Tracking Identifier") having the same value.

  
  
• Described in the contexts:
  • Graphic Annotation Module > Graphic Annotation Sequence > Graphic Object Sequence > Tracking ID
  • Graphic Annotation Module > Graphic Annotation Sequence > Text Object Sequence > Tracking ID
  as follows:
  Attribute Name: Tracking ID
  Type: 1C
  Attribute Description:

  A text label used for tracking a finding or feature, potentially across multiple reporting objects, over time. This label shall be unique within the domain in which it is used.

  Required if Tracking UID (0062,0021) is present.

  Note

  This Attribute allows linkage to segments in Segmentation Instances with the same value of Tracking ID (0062,0020), and to Content Items in SR Instances with observation context PS3.16 DCM112039(112039, DCM, "Tracking Identifier") having the same value.

  
  
• Described in the contexts:
  • Segment Description Macro > Tracking ID
  as follows:
  Attribute Name: Tracking ID
  Type: 1C
  Attribute Description:

  A text label used for tracking a finding or feature, potentially across multiple reporting objects, over time. This label shall be unique within the domain in which it is used.

  Required if Tracking UID (0062,0021) is present.

  Note

  1. May or may not have the same value as Segment Label (0062,0005).

  2. Related SR Instances may exist, for example, to record measurements related to this segment, but need not exist for this Attribute to be used.

  3. This Attribute will have the same value as the value of the PS3.16 DCM112039(112039, DCM, "Tracking Identifier") Content Item in SR Instances that reference this Segment in this Segmentation Instance.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
TrackingID()	Creates a new Tracking ID object which wraps a new and empty Attributes object.
TrackingID(org.dcm4che3.data.Attributes attributes)	Creates a new Tracking ID object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
TrackingID	copy()	Returns a new Tracking ID which wraps a copy of the Attributes wrapped in this Tracking ID.
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.StringDataElementWrapper

getString, setString

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

getValueRepresentation

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

TrackingID

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

Creates a new Tracking ID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

TrackingID

public TrackingID()

Creates a new Tracking ID object which wraps a new and empty Attributes object.

Method Details

copy

public TrackingID copy()

Returns a new Tracking ID which wraps a copy of the Attributes wrapped in this Tracking ID. (see Attributes(Attributes)

Returns:

a new Tracking ID which wraps a copy of the Attributes wrapped in this Tracking ID.

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.