Package org.dcm4che.typeddicom.dataelements

Interface ReferencedImageSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

EncapsulatedDocumentModule, EnhancedUSImageModule, GeneralReferenceModule, MicroscopyBulkSimpleAnnotationsModule, VLImageModule, XRayImageModule

All Known Implementing Classes:

AdvancedBlendingSequence.Item, CArmPhotonElectronRadiationIOD, CArmPhotonElectronRadiationRecordIOD, ComputedRadiographyImageIOD, CornealTopographyMapIOD, CTImageIOD, CurrentFrameFunctionalGroupsSequence.Item, DeformableRegistrationSequence.Item, DeformableSpatialRegistrationIOD, DermoscopicPhotographyImageIOD, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, DisplayedAreaSelectionSequence.Item, EncapsulatedCDAIOD, EncapsulatedDocumentModule.SimpleWrapper, EncapsulatedMTLIOD, EncapsulatedOBJIOD, EncapsulatedPDFIOD, EncapsulatedSTLIOD, EnhancedContinuousRTImageIOD, EnhancedRTImageIOD, EnhancedUSImageModule.SimpleWrapper, EnhancedUSVolumeIOD, FiducialSetSequence.Item, FrameDisplayShutterSequence.Item, GeneralReferenceModule.SimpleWrapper, GraphicAnnotationSequence.Item, GraphicCoordinatesDataSequence.Item, MaskSubtractionSequence.Item, MicroscopyBulkSimpleAnnotationsIOD, MicroscopyBulkSimpleAnnotationsModule.SimpleWrapper, MRImageIOD, MultiFrameGrayscaleByteSecondaryCaptureImageIOD, MultiFrameGrayscaleWordSecondaryCaptureImageIOD, MultiFramePresentationSequence.Item, MultiFrameSingleBitSecondaryCaptureImageIOD, MultiFrameTrueColorSecondaryCaptureImageIOD, NuclearMedicineImageIOD, OphthalmicPhotography16BitImageIOD, OphthalmicPhotography8BitImageIOD, OphthalmicThicknessMapIOD, ParametricMapIOD, PerformedSeriesSequence.Item, PerFrameFunctionalGroupsSequence.Item, PlanOverviewSequence.Item, PositronEmissionTomographyImageIOD, RealTimeVideoEndoscopicImageIOD, RealTimeVideoPhotographicImageIOD, ReferencedImageRealWorldValueMappingSequence.Item, ReferencedSeriesSequence.Item, RegistrationSequence.Item, RoboticArmRadiationIOD, RoboticArmRadiationRecordIOD, RTBeamsDeliveryInstructionIOD, RTBeamsTreatmentRecordIOD, RTBrachyApplicationSetupDeliveryInstructionIOD, RTBrachyTreatmentRecordIOD, RTImageIOD, RTIonBeamsTreatmentRecordIOD, RTIonPlanIOD, RTPatientPositionAcquisitionInstructionIOD, RTPhysicianIntentIOD, RTPlanIOD, RTRadiationRecordSetIOD, RTRadiationSalvageRecordIOD, RTRadiationSetDeliveryInstructionIOD, RTRadiationSetIOD, RTSegmentAnnotationIOD, RTStructureSetIOD, RTTreatmentPreparationIOD, RTTreatmentSummaryRecordIOD, SecondaryCaptureImageIOD, SegmentationIOD, SelectedFrameFunctionalGroupsSequence.Item, SharedFunctionalGroupsSequence.Item, SoftcopyVOILUTSequence.Item, SpatialFiducialsIOD, SpatialRegistrationIOD, StructuredDisplayImageBoxSequence.Item, SurfaceSegmentationIOD, TomotherapeuticRadiationIOD, TomotherapeuticRadiationRecordIOD, UltrasoundImageIOD, UltrasoundMultiFrameImageIOD, VideoEndoscopicImageIOD, VideoMicroscopicImageIOD, VideoPhotographicImageIOD, VisualEvaluationTestSequence.Item, VLEndoscopicImageIOD, VLImageModule.SimpleWrapper, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, VLWholeSlideMicroscopyImageIOD, VolumeCroppingSequence.Item, VolumetricPresentationInputSetSequence.Item, WideFieldOphthalmicPhotography3DCoordinatesImageIOD, WideFieldOphthalmicPhotographyStereographicProjectionImageIOD, XRayAngiographicImageIOD, XRayImageModule.SimpleWrapper, XRayRadiofluoroscopicImageIOD

Enclosing class:

ReferencedImageSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Referenced Image Sequence" (see ReferencedImageSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedImageSequence.Holder.Builder	builder()
static ReferencedImageSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedImageSequence()
default ReferencedImageSequence	ensureReferencedImageSequence()	Adds a new Referenced Image Sequence (see ReferencedImageSequence) with initial capacity 1 (see ensureReferencedImageSequence(int)) if it does not already exist.
default ReferencedImageSequence	ensureReferencedImageSequence(int initialCapacity)	Adds a new Referenced Image Sequence (see ReferencedImageSequence) if it does not already exist.
default ReferencedImageSequence	getReferencedImageSequence()
default ReferencedImageSequence	newReferencedImageSequence(int initialCapacity)	Adds a new Referenced Image Sequence.
default void	removeReferencedImageSequence()	Removes the Referenced Image Sequence (see ReferencedImageSequence
static ReferencedImageSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Referenced Image Sequence (see ReferencedImageSequence)

Returns:

a wrapper object implementing the ReferencedImageSequence.Holder interface.

builder

static ReferencedImageSequence.Holder.Builder builder()

Returns:

a ReferencedImageSequence.Holder.Builder to create Referenced Image Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getReferencedImageSequence

default ReferencedImageSequence getReferencedImageSequence()

Returns:

the Referenced Image Sequence (see ReferencedImageSequence)

newReferencedImageSequence

default ReferencedImageSequence newReferencedImageSequence(int initialCapacity)

Adds a new Referenced Image Sequence. (see ReferencedImageSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced Image Sequence

Returns:

the newly created ReferencedImageSequence.

ensureReferencedImageSequence

default ReferencedImageSequence ensureReferencedImageSequence(int initialCapacity)

Adds a new Referenced Image Sequence (see ReferencedImageSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Referenced Image Sequence (see ReferencedImageSequence) or a new one with capacity initialCapacity.

ensureReferencedImageSequence

default ReferencedImageSequence ensureReferencedImageSequence()

Adds a new Referenced Image Sequence (see ReferencedImageSequence) with initial capacity 1 (see ensureReferencedImageSequence(int)) if it does not already exist.

Returns:

either the already existing Referenced Image Sequence (see ReferencedImageSequence) or a new one with capacity 1.

containsReferencedImageSequence

default boolean containsReferencedImageSequence()

Returns:

whether it contains the Referenced Image Sequence (see ReferencedImageSequence)

removeReferencedImageSequence

default void removeReferencedImageSequence()

Removes the Referenced Image Sequence (see ReferencedImageSequence