Package org.dcm4che.typeddicom.dataelements

Interface FrameExtractionSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

FrameExtractionModule

All Known Implementing Classes:

BreastProjectionXRayImageIOD, BreastTomosynthesisImageIOD, EnhancedCTImageIOD, EnhancedMRColorImageIOD, EnhancedMRImageIOD, EnhancedPETImageIOD, EnhancedUSVolumeIOD, EnhancedXAImageIOD, EnhancedXRFImageIOD, FrameExtractionSequence.SimpleHolder, IntravascularOpticalCoherenceTomographyImageIOD, LegacyConvertedEnhancedCTImageIOD, LegacyConvertedEnhancedMRImageIOD, LegacyConvertedEnhancedPETImageIOD, MRSpectroscopyIOD, MultiFrameGrayscaleByteSCImageIOD, MultiFrameGrayscaleWordSCImageIOD, MultiFrameSingleBitSCImageIOD, MultiFrameTrueColorSCImageIOD, NMImageIOD, OphthalmicOpticalCoherenceTomographyBScanVolumeAnalysisIOD, OphthalmicPhotography16BitImageIOD, OphthalmicPhotography8BitImageIOD, OphthalmicTomographyImageIOD, ParametricMapIOD, RTDoseIOD, RTImageIOD, SegmentationIOD, USMultiFrameImageIOD, VideoEndoscopicImageIOD, VideoMicroscopicImageIOD, VideoPhotographicImageIOD, VLWholeSlideMicroscopyImageIOD, WideFieldOphthalmicPhotography3DCoordinatesImageIOD, WideFieldOphthalmicPhotographyStereographicProjectionImageIOD, XRay3DAngiographicImageIOD, XRay3DCraniofacialImageIOD, XRayAngiographicImageIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

FrameExtractionSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Frame Extraction Sequence" (see FrameExtractionSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FrameExtractionSequence.Holder.Builder	builder()
static FrameExtractionSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFrameExtractionSequence()
default FrameExtractionSequence	ensureFrameExtractionSequence()	Adds a new Frame Extraction Sequence (see FrameExtractionSequence) with initial capacity 1 (see ensureFrameExtractionSequence(int)) if it does not already exist.
default FrameExtractionSequence	ensureFrameExtractionSequence(int initialCapacity)	Adds a new Frame Extraction Sequence (see FrameExtractionSequence) if it does not already exist.
default FrameExtractionSequence	getFrameExtractionSequence()
default FrameExtractionSequence	newFrameExtractionSequence(int initialCapacity)	Adds a new Frame Extraction Sequence.
default void	removeFrameExtractionSequence()	Removes the Frame Extraction Sequence (see FrameExtractionSequence
static FrameExtractionSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Frame Extraction Sequence (see FrameExtractionSequence)

Returns:

a wrapper object implementing the FrameExtractionSequence.Holder interface.

builder

static FrameExtractionSequence.Holder.Builder builder()

Returns:

a FrameExtractionSequence.Holder.Builder to create Frame Extraction Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getFrameExtractionSequence

default FrameExtractionSequence getFrameExtractionSequence()

Returns:

the Frame Extraction Sequence (see FrameExtractionSequence)

newFrameExtractionSequence

default FrameExtractionSequence newFrameExtractionSequence(int initialCapacity)

Adds a new Frame Extraction Sequence. (see FrameExtractionSequence)

Parameters:

initialCapacity - the initial capacity for the new Frame Extraction Sequence

Returns:

the newly created FrameExtractionSequence.

ensureFrameExtractionSequence

default FrameExtractionSequence ensureFrameExtractionSequence(int initialCapacity)

Adds a new Frame Extraction Sequence (see FrameExtractionSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Frame Extraction Sequence (see FrameExtractionSequence) or a new one with capacity initialCapacity.

ensureFrameExtractionSequence

default FrameExtractionSequence ensureFrameExtractionSequence()

Adds a new Frame Extraction Sequence (see FrameExtractionSequence) with initial capacity 1 (see ensureFrameExtractionSequence(int)) if it does not already exist.

Returns:

either the already existing Frame Extraction Sequence (see FrameExtractionSequence) or a new one with capacity 1.

containsFrameExtractionSequence

default boolean containsFrameExtractionSequence()

Returns:

whether it contains the Frame Extraction Sequence (see FrameExtractionSequence)

removeFrameExtractionSequence

default void removeFrameExtractionSequence()

Removes the Frame Extraction Sequence (see FrameExtractionSequence