Package org.dcm4che.typeddicom.dataelements

Class DistanceBetweenFocalPlanes

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DistanceBetweenFocalPlanes

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointSingleWrapper

public class DistanceBetweenFocalPlanes
extends AbstractDataElementWrapper
implements FloatingPointSingleWrapper

Name: Distance Between Focal Planes
Keyword: DistanceBetweenFocalPlanes
Tag: (0048,0014)
Value Representation: FL
Value Multiplicity: 1

• Described in the contexts:
  • Whole Slide Microscopy Image Module > Distance Between Focal Planes
  as follows:
  Attribute Name: Distance Between Focal Planes
  Type: 1C
  Attribute Description:

  Distance between acquisition focal planes used for extended depth of field, in µm.

  Required if Extended Depth of Field (0048,0012) value is YES.

  Note

  Spacing Between Slices (0018,0088) describes the spacing of focal planes separately encoded, and is distinct from Distance Between Focal Planes (0048,0014), which describes in what manner different focal planes were combined into a single encoded plane (focus stacking).

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

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

DistanceBetweenFocalPlanes

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

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

Parameters:

attributes - The Attributes object to be wrapped.

DistanceBetweenFocalPlanes

public DistanceBetweenFocalPlanes()

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

Method Details

copy

public DistanceBetweenFocalPlanes copy()

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

Returns:

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

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.