Package org.dcm4che.typeddicom.dataelements

Class FiducialUID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.FiducialUID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, StringDataElementWrapper, UniqueIdentifierUIDWrapper

public class FiducialUID
extends AbstractDataElementWrapper
implements UniqueIdentifierUIDWrapper

Name: Fiducial UID
Keyword: FiducialUID
Tag: (0070,031A)
Value Representation: UI
Value Multiplicity: 1

• Described in the contexts:
  • Spatial Fiducials Module > Fiducial Set Sequence > Fiducial Sequence > Fiducial UID
  as follows:
  Attribute Name: Fiducial UID
  Type: 3
  Attribute Description:

  Globally unique identifier for the fiducial instance of this fiducial assignment.

  
  
• Described in the contexts:
  • Deformable Spatial Registration Module > Deformable Registration Sequence > Used Fiducials Sequence > Fiducial UID
  • Spatial Registration Module > Registration Sequence > Used Fiducials Sequence > Fiducial UID
  as follows:
  Attribute Name: Fiducial UID
  Type: 1
  Attribute Description:

  The UID that identifies the fiducial used as registration input.

  
  
• Described in the contexts:
  • Spatial Coordinates Macro > Fiducial UID
  • 3D Spatial Coordinates Macro > Fiducial UID
  as follows:
  Attribute Name: Fiducial UID
  Type: 3
  Attribute Description:

  The globally unique identifier for this fiducial Item.

  Note

  The fiducial UID can be used to associate this set of graphics with other Content Items.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

FiducialUID

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

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

Parameters:

attributes - The Attributes object to be wrapped.

FiducialUID

public FiducialUID()

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

Method Details

copy

public FiducialUID copy()

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

Returns:

a new Fiducial UID which wraps a copy of the Attributes wrapped in this 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.