Package org.dcm4che.typeddicom.dataelements

Interface FiducialSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

FiducialSequence.SimpleHolder, FiducialSetSequence.Item

Enclosing class:

FiducialSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Fiducial Sequence" (see FiducialSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FiducialSequence.Holder.Builder	builder()
static FiducialSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFiducialSequence()
default FiducialSequence	ensureFiducialSequence()	Adds a new Fiducial Sequence (see FiducialSequence) with initial capacity 1 (see ensureFiducialSequence(int)) if it does not already exist.
default FiducialSequence	ensureFiducialSequence(int initialCapacity)	Adds a new Fiducial Sequence (see FiducialSequence) if it does not already exist.
default FiducialSequence	getFiducialSequence()
default FiducialSequence	newFiducialSequence(int initialCapacity)	Adds a new Fiducial Sequence.
default void	removeFiducialSequence()	Removes the Fiducial Sequence (see FiducialSequence
static FiducialSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Fiducial Sequence (see FiducialSequence)

Returns:

a wrapper object implementing the FiducialSequence.Holder interface.

builder

static FiducialSequence.Holder.Builder builder()

Returns:

a FiducialSequence.Holder.Builder to create Fiducial Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getFiducialSequence

default FiducialSequence getFiducialSequence()

Returns:

the Fiducial Sequence (see FiducialSequence)

newFiducialSequence

default FiducialSequence newFiducialSequence(int initialCapacity)

Adds a new Fiducial Sequence. (see FiducialSequence)

Parameters:

initialCapacity - the initial capacity for the new Fiducial Sequence

Returns:

the newly created FiducialSequence.

ensureFiducialSequence

default FiducialSequence ensureFiducialSequence(int initialCapacity)

Adds a new Fiducial Sequence (see FiducialSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Fiducial Sequence (see FiducialSequence) or a new one with capacity initialCapacity.

ensureFiducialSequence

default FiducialSequence ensureFiducialSequence()

Adds a new Fiducial Sequence (see FiducialSequence) with initial capacity 1 (see ensureFiducialSequence(int)) if it does not already exist.

Returns:

either the already existing Fiducial Sequence (see FiducialSequence) or a new one with capacity 1.

containsFiducialSequence

default boolean containsFiducialSequence()

Returns:

whether it contains the Fiducial Sequence (see FiducialSequence)

removeFiducialSequence

default void removeFiducialSequence()

Removes the Fiducial Sequence (see FiducialSequence