Package org.dcm4che.typeddicom.dataelements

Class TotalPixelMatrixFocalPlanes

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.TotalPixelMatrixFocalPlanes

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedLongWrapper

public class TotalPixelMatrixFocalPlanes
extends AbstractDataElementWrapper
implements UnsignedLongWrapper

Name: Total Pixel Matrix Focal Planes
Keyword: TotalPixelMatrixFocalPlanes
Tag: (0048,0303)
Value Representation: UL
Value Multiplicity: 1

• Described in the contexts:
  • Segmentation Image Module > Total Pixel Matrix Focal Planes
  • Parametric Map Image Module > Total Pixel Matrix Focal Planes
  • Whole Slide Microscopy Image Module > Total Pixel Matrix Focal Planes
  as follows:
  Attribute Name: Total Pixel Matrix Focal Planes
  Type: 1C
  Attribute Description:

  Total number of focal planes (Z locations) in the pixel matrix; i.e., depth of total imaged volume in pixels. See DICOM Standard Part 3 - Section C.8.12.4.1.3

  Required if Dimension Organization Type (0020,9311) is present with a value of TILED_FULL. May be present otherwise.

  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	TotalPixelMatrixFocalPlanes.Builder<SELF extends TotalPixelMatrixFocalPlanes.Builder<SELF,T>,T extends TotalPixelMatrixFocalPlanes.Holder>
static interface	TotalPixelMatrixFocalPlanes.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Total Pixel Matrix Focal Planes" (see TotalPixelMatrixFocalPlanes)

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

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

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
TotalPixelMatrixFocalPlanes()	Creates a new Total Pixel Matrix Focal Planes object which wraps a new and empty Attributes object.
TotalPixelMatrixFocalPlanes(org.dcm4che3.data.Attributes attributes)	Creates a new Total Pixel Matrix Focal Planes object which wraps the provided attributes.

Method Summary

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

getInt, setInt

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

TotalPixelMatrixFocalPlanes

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

Creates a new Total Pixel Matrix Focal Planes object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

TotalPixelMatrixFocalPlanes

public TotalPixelMatrixFocalPlanes()

Creates a new Total Pixel Matrix Focal Planes object which wraps a new and empty Attributes object.

Method Details

copy

public TotalPixelMatrixFocalPlanes copy()

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

Returns:

a new Total Pixel Matrix Focal Planes which wraps a copy of the Attributes wrapped in this Total Pixel Matrix Focal Planes.

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.