Package org.dcm4che.typeddicom.dataelements

Interface PixelSpacingSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

PixelSpacingSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Pixel Spacing Sequence" (see PixelSpacingSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PixelSpacingSequence.Holder.Builder	builder()
static PixelSpacingSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPixelSpacingSequence()
default PixelSpacingSequence	ensurePixelSpacingSequence()	Adds a new Pixel Spacing Sequence (see PixelSpacingSequence) with initial capacity 1 (see ensurePixelSpacingSequence(int)) if it does not already exist.
default PixelSpacingSequence	ensurePixelSpacingSequence(int initialCapacity)	Adds a new Pixel Spacing Sequence (see PixelSpacingSequence) if it does not already exist.
default PixelSpacingSequence	getPixelSpacingSequence()
default PixelSpacingSequence	newPixelSpacingSequence(int initialCapacity)	Adds a new Pixel Spacing Sequence.
default void	removePixelSpacingSequence()	Removes the Pixel Spacing Sequence (see PixelSpacingSequence
static PixelSpacingSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Pixel Spacing Sequence (see PixelSpacingSequence)

Returns:

a wrapper object implementing the PixelSpacingSequence.Holder interface.

builder

static PixelSpacingSequence.Holder.Builder builder()

Returns:

a PixelSpacingSequence.Holder.Builder to create Pixel Spacing Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a PixelSpacingSequence.Holder.Builder to create Pixel Spacing Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getPixelSpacingSequence

default PixelSpacingSequence getPixelSpacingSequence()

Returns:

the Pixel Spacing Sequence (see PixelSpacingSequence)

newPixelSpacingSequence

default PixelSpacingSequence newPixelSpacingSequence(int initialCapacity)

Adds a new Pixel Spacing Sequence. (see PixelSpacingSequence)

Parameters:

initialCapacity - the initial capacity for the new Pixel Spacing Sequence

Returns:

the newly created PixelSpacingSequence.

ensurePixelSpacingSequence

default PixelSpacingSequence ensurePixelSpacingSequence(int initialCapacity)

Adds a new Pixel Spacing Sequence (see PixelSpacingSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Pixel Spacing Sequence (see PixelSpacingSequence) or a new one with capacity initialCapacity.

ensurePixelSpacingSequence

default PixelSpacingSequence ensurePixelSpacingSequence()

Adds a new Pixel Spacing Sequence (see PixelSpacingSequence) with initial capacity 1 (see ensurePixelSpacingSequence(int)) if it does not already exist.

Returns:

either the already existing Pixel Spacing Sequence (see PixelSpacingSequence) or a new one with capacity 1.

containsPixelSpacingSequence

default boolean containsPixelSpacingSequence()

Returns:

whether it contains the Pixel Spacing Sequence (see PixelSpacingSequence)

removePixelSpacingSequence

default void removePixelSpacingSequence()

Removes the Pixel Spacing Sequence (see PixelSpacingSequence