Package org.dcm4che.typeddicom.dataelements

Interface FiducialSetSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

SpatialFiducialsModule

All Known Implementing Classes:

SpatialFiducialsIOD, SpatialFiducialsModule.SimpleWrapper

Enclosing class:

FiducialSetSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FiducialSetSequence.Holder.Builder	builder()
static FiducialSetSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFiducialSetSequence()
default FiducialSetSequence	ensureFiducialSetSequence()	Adds a new Fiducial Set Sequence (see FiducialSetSequence) with initial capacity 1 (see ensureFiducialSetSequence(int)) if it does not already exist.
default FiducialSetSequence	ensureFiducialSetSequence(int initialCapacity)	Adds a new Fiducial Set Sequence (see FiducialSetSequence) if it does not already exist.
default FiducialSetSequence	getFiducialSetSequence()
default FiducialSetSequence	newFiducialSetSequence(int initialCapacity)	Adds a new Fiducial Set Sequence.
default void	removeFiducialSetSequence()	Removes the Fiducial Set Sequence (see FiducialSetSequence
static FiducialSetSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Fiducial Set Sequence (see FiducialSetSequence)

Returns:

a wrapper object implementing the FiducialSetSequence.Holder interface.

builder

static FiducialSetSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getFiducialSetSequence

default FiducialSetSequence getFiducialSetSequence()

Returns:

the Fiducial Set Sequence (see FiducialSetSequence)

newFiducialSetSequence

default FiducialSetSequence newFiducialSetSequence(int initialCapacity)

Adds a new Fiducial Set Sequence. (see FiducialSetSequence)

Parameters:

initialCapacity - the initial capacity for the new Fiducial Set Sequence

Returns:

the newly created FiducialSetSequence.

ensureFiducialSetSequence

default FiducialSetSequence ensureFiducialSetSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureFiducialSetSequence

default FiducialSetSequence ensureFiducialSetSequence()

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

Returns:

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

containsFiducialSetSequence

default boolean containsFiducialSetSequence()

Returns:

whether it contains the Fiducial Set Sequence (see FiducialSetSequence)

removeFiducialSetSequence

default void removeFiducialSetSequence()

Removes the Fiducial Set Sequence (see FiducialSetSequence