Package org.dcm4che.typeddicom.dataelements

Interface AnatomicRegionSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

CornealTopographyMapImageModule, CRImageModule, CTImageModule, DXAnatomyImagedModule, EnhancedUSImageModule, GeneralImageModule, IntraOralImageModule, MammographyImageModule, MRImageModule, NMImageModule, OcularRegionImagedModule, OphthalmicThicknessMapModule, PatientPositioningModule, PETImageModule, PresentationViewDescriptionModule, USImageModule, VLImageModule, WideFieldOphthalmicPhotography3DCoordinatesModule, WideFieldOphthalmicPhotographyStereographicProjectionModule, XRayImageModule

All Known Implementing Classes:

AnnotationGroupSequence.Item, ComputedRadiographyImageIOD, CornealTopographyMapImageModule.SimpleWrapper, CornealTopographyMapIOD, CRImageModule.SimpleWrapper, CTDefinedProcedureProtocolIOD, CTImageIOD, CTImageModule.SimpleWrapper, CTPerformedProcedureProtocolIOD, DermoscopicPhotographyImageIOD, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, DXAnatomyImagedModule.SimpleWrapper, EnhancedUSImageModule.SimpleWrapper, EnhancedUSVolumeIOD, FrameAnatomySequence.Item, GeneralImageModule.SimpleWrapper, HangingProtocolDefinitionSequence.Item, ImplantAssemblyTemplateTargetAnatomySequence.Item, ImplantTargetAnatomySequence.Item, ImplantTemplateGroupTargetAnatomySequence.Item, IntraOralImageModule.SimpleWrapper, MammographyImageModule.SimpleWrapper, MRImageIOD, MRImageModule.SimpleWrapper, MultiFrameGrayscaleByteSecondaryCaptureImageIOD, MultiFrameGrayscaleWordSecondaryCaptureImageIOD, MultiFrameSingleBitSecondaryCaptureImageIOD, MultiFrameTrueColorSecondaryCaptureImageIOD, NMImageModule.SimpleWrapper, NuclearMedicineImageIOD, OcularRegionImagedModule.SimpleWrapper, OphthalmicOpticalCoherenceTomographyEnFaceImageIOD, OphthalmicPhotography16BitImageIOD, OphthalmicPhotography8BitImageIOD, OphthalmicThicknessMapIOD, OphthalmicThicknessMapModule.SimpleWrapper, OphthalmicTomographyImageIOD, ParametricMapIOD, PatientPositioningModule.SimpleWrapper, PETImageModule.SimpleWrapper, PlanarMPRVolumetricPresentationStateIOD, PositronEmissionTomographyImageIOD, PresentationViewDescriptionModule.SimpleWrapper, RealTimeVideoEndoscopicImageIOD, RealTimeVideoPhotographicImageIOD, RTDoseIOD, RTImageIOD, RTROIObservationsSequence.Item, SecondaryCaptureImageIOD, SegmentationIOD, SegmentSequence.Item, UltrasoundImageIOD, UltrasoundMultiFrameImageIOD, USImageModule.SimpleWrapper, VideoEndoscopicImageIOD, VideoMicroscopicImageIOD, VideoPhotographicImageIOD, VLEndoscopicImageIOD, VLImageModule.SimpleWrapper, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, VLWholeSlideMicroscopyImageIOD, VolumeRenderingVolumetricPresentationStateIOD, WideFieldOphthalmicPhotography3DCoordinatesImageIOD, WideFieldOphthalmicPhotography3DCoordinatesModule.SimpleWrapper, WideFieldOphthalmicPhotographyStereographicProjectionImageIOD, WideFieldOphthalmicPhotographyStereographicProjectionModule.SimpleWrapper, XADefinedProcedureProtocolIOD, XAPerformedProcedureProtocolIOD, XRayAngiographicImageIOD, XRayImageModule.SimpleWrapper, XRayRadiofluoroscopicImageIOD

Enclosing class:

AnatomicRegionSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Anatomic Region Sequence" (see AnatomicRegionSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AnatomicRegionSequence.Holder.Builder	builder()
static AnatomicRegionSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsAnatomicRegionSequence()
default AnatomicRegionSequence	ensureAnatomicRegionSequence()	Adds a new Anatomic Region Sequence (see AnatomicRegionSequence) with initial capacity 1 (see ensureAnatomicRegionSequence(int)) if it does not already exist.
default AnatomicRegionSequence	ensureAnatomicRegionSequence(int initialCapacity)	Adds a new Anatomic Region Sequence (see AnatomicRegionSequence) if it does not already exist.
default AnatomicRegionSequence	getAnatomicRegionSequence()
default AnatomicRegionSequence	newAnatomicRegionSequence(int initialCapacity)	Adds a new Anatomic Region Sequence.
default void	removeAnatomicRegionSequence()	Removes the Anatomic Region Sequence (see AnatomicRegionSequence
static AnatomicRegionSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Anatomic Region Sequence (see AnatomicRegionSequence)

Returns:

a wrapper object implementing the AnatomicRegionSequence.Holder interface.

builder

static AnatomicRegionSequence.Holder.Builder builder()

Returns:

a AnatomicRegionSequence.Holder.Builder to create Anatomic Region Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getAnatomicRegionSequence

default AnatomicRegionSequence getAnatomicRegionSequence()

Returns:

the Anatomic Region Sequence (see AnatomicRegionSequence)

newAnatomicRegionSequence

default AnatomicRegionSequence newAnatomicRegionSequence(int initialCapacity)

Adds a new Anatomic Region Sequence. (see AnatomicRegionSequence)

Parameters:

initialCapacity - the initial capacity for the new Anatomic Region Sequence

Returns:

the newly created AnatomicRegionSequence.

ensureAnatomicRegionSequence

default AnatomicRegionSequence ensureAnatomicRegionSequence(int initialCapacity)

Adds a new Anatomic Region Sequence (see AnatomicRegionSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Anatomic Region Sequence (see AnatomicRegionSequence) or a new one with capacity initialCapacity.

ensureAnatomicRegionSequence

default AnatomicRegionSequence ensureAnatomicRegionSequence()

Adds a new Anatomic Region Sequence (see AnatomicRegionSequence) with initial capacity 1 (see ensureAnatomicRegionSequence(int)) if it does not already exist.

Returns:

either the already existing Anatomic Region Sequence (see AnatomicRegionSequence) or a new one with capacity 1.

containsAnatomicRegionSequence

default boolean containsAnatomicRegionSequence()

Returns:

whether it contains the Anatomic Region Sequence (see AnatomicRegionSequence)

removeAnatomicRegionSequence

default void removeAnatomicRegionSequence()

Removes the Anatomic Region Sequence (see AnatomicRegionSequence