Package org.dcm4che.typeddicom.dataelements

Interface TotalPixelMatrixOriginSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

MicroscopeSlideLayerTileOrganizationModule

All Known Implementing Classes:

ParametricMapIOD, SegmentationIOD, TotalPixelMatrixOriginSequence.SimpleHolder, VLWholeSlideMicroscopyImageIOD

Enclosing class:

TotalPixelMatrixOriginSequence

public static interface TotalPixelMatrixOriginSequence.Holder
extends org.dcm4che.typeddicom.AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Total Pixel Matrix Origin Sequence" (see TotalPixelMatrixOriginSequence)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TotalPixelMatrixOriginSequence.Holder.Builder

Method Summary

Modifier and Type	Method	Description
static TotalPixelMatrixOriginSequence.Holder.Builder	builder()
static TotalPixelMatrixOriginSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsTotalPixelMatrixOriginSequence()
default TotalPixelMatrixOriginSequence	ensureTotalPixelMatrixOriginSequence()	Adds a new Total Pixel Matrix Origin Sequence (see TotalPixelMatrixOriginSequence) with initial capacity 1 (see ensureTotalPixelMatrixOriginSequence(int)) if it does not already exist.
default TotalPixelMatrixOriginSequence	ensureTotalPixelMatrixOriginSequence(int initialCapacity)	Adds a new Total Pixel Matrix Origin Sequence (see TotalPixelMatrixOriginSequence) if it does not already exist.
default TotalPixelMatrixOriginSequence	getTotalPixelMatrixOriginSequence()
default TotalPixelMatrixOriginSequence	newTotalPixelMatrixOriginSequence(int initialCapacity)	Adds a new Total Pixel Matrix Origin Sequence.
default void	removeTotalPixelMatrixOriginSequence()	Removes the Total Pixel Matrix Origin Sequence (see TotalPixelMatrixOriginSequence
static TotalPixelMatrixOriginSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

static TotalPixelMatrixOriginSequence.Holder wrap(org.dcm4che3.data.Attributes attributes)

Parameters:

attributes - an attributes object containing the Total Pixel Matrix Origin Sequence (see TotalPixelMatrixOriginSequence)

Returns:

a wrapper object implementing the TotalPixelMatrixOriginSequence.Holder interface.

builder

static TotalPixelMatrixOriginSequence.Holder.Builder builder()

Returns:

a TotalPixelMatrixOriginSequence.Holder.Builder to create Total Pixel Matrix Origin Sequence Items with a fluent API.

builder

static TotalPixelMatrixOriginSequence.Holder.Builder builder(org.dcm4che3.data.Attributes attributes)

Parameters:

attributes - the Attributes to be wrapped by the TotalPixelMatrixOriginSequence.Holder.Builder.

Returns:

a TotalPixelMatrixOriginSequence.Holder.Builder to create Total Pixel Matrix Origin Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getTotalPixelMatrixOriginSequence

default TotalPixelMatrixOriginSequence getTotalPixelMatrixOriginSequence()

Returns:

the Total Pixel Matrix Origin Sequence (see TotalPixelMatrixOriginSequence)

newTotalPixelMatrixOriginSequence

default TotalPixelMatrixOriginSequence newTotalPixelMatrixOriginSequence(int initialCapacity)

Adds a new Total Pixel Matrix Origin Sequence. (see TotalPixelMatrixOriginSequence)

Parameters:

initialCapacity - the initial capacity for the new Total Pixel Matrix Origin Sequence

Returns:

the newly created TotalPixelMatrixOriginSequence.

ensureTotalPixelMatrixOriginSequence

default TotalPixelMatrixOriginSequence ensureTotalPixelMatrixOriginSequence(int initialCapacity)

Adds a new Total Pixel Matrix Origin Sequence (see TotalPixelMatrixOriginSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Total Pixel Matrix Origin Sequence is created.

Returns:

either the already existing Total Pixel Matrix Origin Sequence (see TotalPixelMatrixOriginSequence) or a new one with capacity initialCapacity.

ensureTotalPixelMatrixOriginSequence

default TotalPixelMatrixOriginSequence ensureTotalPixelMatrixOriginSequence()

Adds a new Total Pixel Matrix Origin Sequence (see TotalPixelMatrixOriginSequence) with initial capacity 1 (see ensureTotalPixelMatrixOriginSequence(int)) if it does not already exist.

Returns:

either the already existing Total Pixel Matrix Origin Sequence (see TotalPixelMatrixOriginSequence) or a new one with capacity 1.

containsTotalPixelMatrixOriginSequence

default boolean containsTotalPixelMatrixOriginSequence()

Returns:

whether it contains the Total Pixel Matrix Origin Sequence (see TotalPixelMatrixOriginSequence)

removeTotalPixelMatrixOriginSequence

default void removeTotalPixelMatrixOriginSequence()

Removes the Total Pixel Matrix Origin Sequence (see TotalPixelMatrixOriginSequence