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:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.IntDataElementWrapper, UnsignedLongWrapper

public class TotalPixelMatrixFocalPlanes
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements UnsignedLongWrapper

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

• Described in the contexts:
  • Microscope Slide Layer Tile Organization 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.14.1.1

  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)
static class	TotalPixelMatrixFocalPlanes.SimpleHolder

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PRIVATE_CREATOR	The Private Creator associated with this class.
static int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.UnsignedLongWrapper

VALUE_REPRESENTATION

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.
java.lang.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.IntDataElementWrapper

getInt, setInt

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

getValueRepresentation

Field Detail

PRIVATE_CREATOR

public static final java.lang.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 Detail

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 Detail

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.

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper