Package org.dcm4che.typeddicom.dataelements

Class ReferencedFiducialUID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferencedFiducialUID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, StringDataElementWrapper, UniqueIdentifierUIDWrapper

public class ReferencedFiducialUID
extends AbstractDataElementWrapper
implements UniqueIdentifierUIDWrapper

Name: Referenced Fiducial UID
Keyword: ReferencedFiducialUID
Tag: (0070,031B)
Value Representation: UI
Value Multiplicity: 1

• Described in the contexts:
  • Structure Set Module > Structure Set ROI Sequence > Definition Source Sequence > Referenced Fiducial UID
  as follows:
  Attribute Name: Referenced Fiducial UID
  Type: 1C
  Attribute Description:

  The value of Fiducials UID (0070,031A) in the referenced SOP Instance that identifies the fiducial that is the source of the ROI Contour information.

  Required if Referenced SOP Class UID (0008,1150) is Spatial Fiducials Storage ("1.2.840.10008.5.1.4.1.1.66.2").

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ReferencedFiducialUID()	Creates a new Referenced Fiducial UID object which wraps a new and empty Attributes object.
ReferencedFiducialUID(org.dcm4che3.data.Attributes attributes)	Creates a new Referenced Fiducial UID object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ReferencedFiducialUID	copy()	Returns a new Referenced Fiducial UID which wraps a copy of the Attributes wrapped in this Referenced Fiducial UID.
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.UniqueIdentifierUIDWrapper

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

ReferencedFiducialUID

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

Creates a new Referenced Fiducial UID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ReferencedFiducialUID

public ReferencedFiducialUID()

Creates a new Referenced Fiducial UID object which wraps a new and empty Attributes object.

Method Details

copy

public ReferencedFiducialUID copy()

Returns a new Referenced Fiducial UID which wraps a copy of the Attributes wrapped in this Referenced Fiducial UID. (see Attributes(Attributes)

Returns:

a new Referenced Fiducial UID which wraps a copy of the Attributes wrapped in this Referenced Fiducial UID.

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.