Package org.dcm4che.typeddicom.dataelements

Class RangingDepth

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RangingDepth

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointDoubleWrapper

public class RangingDepth
extends AbstractDataElementWrapper
implements FloatingPointDoubleWrapper

Name: Ranging Depth
Keyword: RangingDepth
Tag: (0052,0009)
Value Representation: FD
Value Multiplicity: 1

• Described in the contexts:
  • Intravascular OCT Acquisition Parameters Module > Ranging Depth
  as follows:
  Attribute Name: Ranging Depth
  Type: 1
  Attribute Description:

  Maximum detectable sample-to-reference path displacement, in mm (measured in air). This is the radius of the FOR PRESENTATION image in air.

  Note

  Ranging Depth is distinct from Penetration Depth, which is the depth to which one can obtain an OCT signal in tissue.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RangingDepth.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Ranging Depth" (see RangingDepth)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
RangingDepth	copy()	Returns a new Ranging Depth which wraps a copy of the Attributes wrapped in this Ranging Depth.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

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

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

RangingDepth

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

Creates a new Ranging Depth object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RangingDepth

public RangingDepth()

Creates a new Ranging Depth object which wraps a new and empty Attributes object.

Method Details

copy

public RangingDepth copy()

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

Returns:

a new Ranging Depth which wraps a copy of the Attributes wrapped in this Ranging Depth.

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.