Package org.dcm4che.typeddicom.dataelements

Class NumberOfFocalPlanes

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.NumberOfFocalPlanes

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class NumberOfFocalPlanes
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Number of Focal Planes
Keyword: NumberOfFocalPlanes
Tag: (0048,0013)
Value Representation: US
Value Multiplicity: 1

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

  Number of acquisition focal planes used for extended depth of field.

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

  Note

  Total Pixel Matrix Focal Planes (0048,0303) describes the number of focal planes separately encoded, and is distinct from Number of Focal Planes (0048,0013), 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	NumberOfFocalPlanes.Builder<SELF extends NumberOfFocalPlanes.Builder<SELF,T>,T extends NumberOfFocalPlanes.Holder>
static interface	NumberOfFocalPlanes.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Number of Focal Planes" (see NumberOfFocalPlanes)
static class	NumberOfFocalPlanes.SimpleHolder

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
NumberOfFocalPlanes()	Creates a new Number of Focal Planes object which wraps a new and empty Attributes object.
NumberOfFocalPlanes(org.dcm4che3.data.Attributes attributes)	Creates a new Number of Focal Planes object which wraps the provided attributes.

Method Summary

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

getInt, setInt

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

getValueRepresentation

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

NumberOfFocalPlanes

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

Creates a new Number of Focal Planes object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

NumberOfFocalPlanes

public NumberOfFocalPlanes()

Creates a new Number of Focal Planes object which wraps a new and empty Attributes object.

Method Details

copy

public NumberOfFocalPlanes copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.