Package org.dcm4che.typeddicom.dataelements

Class OCTFocalDistance

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.OCTFocalDistance

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointDoubleWrapper

public class OCTFocalDistance
extends AbstractDataElementWrapper
implements FloatingPointDoubleWrapper

Name: OCT Focal Distance
Keyword: OCTFocalDistance
Tag: (0052,0002)
Value Representation: FD
Value Multiplicity: 1

• Described in the contexts:
  • Intravascular OCT Acquisition Parameters Module > OCT Focal Distance
  as follows:
  Attribute Name: OCT Focal Distance
  Type: 2
  Attribute Description:

  Distance from focal point to center of catheter, in mm (measured in air).

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
OCTFocalDistance()	Creates a new OCT Focal Distance object which wraps a new and empty Attributes object.
OCTFocalDistance(org.dcm4che3.data.Attributes attributes)	Creates a new OCT Focal Distance object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
OCTFocalDistance	copy()	Returns a new OCT Focal Distance which wraps a copy of the Attributes wrapped in this OCT Focal Distance.
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.DoubleDataElementWrapper

getDouble, setDouble

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

getFloat, setFloat

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

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

OCTFocalDistance

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

Creates a new OCT Focal Distance object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

OCTFocalDistance

public OCTFocalDistance()

Creates a new OCT Focal Distance object which wraps a new and empty Attributes object.

Method Details

copy

public OCTFocalDistance copy()

Returns a new OCT Focal Distance which wraps a copy of the Attributes wrapped in this OCT Focal Distance. (see Attributes(Attributes)

Returns:

a new OCT Focal Distance which wraps a copy of the Attributes wrapped in this OCT Focal Distance.

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.