Package org.dcm4che.typeddicom.dataelements

Class FiducialDescription

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.FiducialDescription

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortTextWrapper, StringDataElementWrapper

public class FiducialDescription
extends AbstractDataElementWrapper
implements ShortTextWrapper

Name: Fiducial Description
Keyword: FiducialDescription
Tag: (0070,030F)
Value Representation: ST
Value Multiplicity: 1

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

  User description or comments about the fiducial.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

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

getValueRepresentation

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

FiducialDescription

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

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

Parameters:

attributes - The Attributes object to be wrapped.

FiducialDescription

public FiducialDescription()

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

Method Details

copy

public FiducialDescription copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.