Package org.dcm4che.typeddicom.dataelements

Interface FrameOfInterestDescription.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

FramePointersModule

All Known Implementing Classes:

FrameOfInterestDescription.SimpleHolder, MultiFrameGrayscaleByteSCImageIOD, MultiFrameGrayscaleWordSCImageIOD, MultiFrameSingleBitSCImageIOD, MultiFrameTrueColorSCImageIOD, USMultiFrameImageIOD, XRayAngiographicImageIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

FrameOfInterestDescription

public static interface FrameOfInterestDescription.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Frame of Interest Description" (see FrameOfInterestDescription)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FrameOfInterestDescription.Holder.Builder	builder()
static FrameOfInterestDescription.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFrameOfInterestDescription()
default FrameOfInterestDescription	getFrameOfInterestDescription()
default void	removeFrameOfInterestDescription()	Removes the Frame of Interest Description (see FrameOfInterestDescription
static FrameOfInterestDescription.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Frame of Interest Description (see FrameOfInterestDescription)

Returns:

A wrapper object implementing the FrameOfInterestDescription.Holder interface.

builder

static FrameOfInterestDescription.Holder.Builder builder()

Returns:

a FrameOfInterestDescription.Holder.Builder to create Frame of Interest Description Items with a fluent API.

builder

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

Parameters:

attributes - The Attributes to be wrapped by the FrameOfInterestDescription.Holder.Builder.

Returns:

a FrameOfInterestDescription.Holder.Builder to create Frame of Interest Description Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getFrameOfInterestDescription

default FrameOfInterestDescription getFrameOfInterestDescription()

Returns:

the Frame of Interest Description (see FrameOfInterestDescription)

containsFrameOfInterestDescription

default boolean containsFrameOfInterestDescription()

Returns:

Whether it contains the Frame of Interest Description (see FrameOfInterestDescription)

removeFrameOfInterestDescription

default void removeFrameOfInterestDescription()

Removes the Frame of Interest Description (see FrameOfInterestDescription