Package org.dcm4che.typeddicom.dataelements

Interface SourceImageSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

CornealTopographyMapAnalysisModule, EnhancedUSImageModule, GeneralReferenceModule, OphthalmicOpticalCoherenceTomographyEnFaceImageModule, OphthalmicPhotographyImageModule, OphthalmicThicknessMapModule

All Known Implementing Classes:

CArmPhotonElectronRadiationIOD, CArmPhotonElectronRadiationRecordIOD, ComputedRadiographyImageIOD, CornealTopographyMapAnalysisModule.SimpleWrapper, CornealTopographyMapIOD, CTImageIOD, DeformableSpatialRegistrationIOD, DerivationImageSequence.Item, DermoscopicPhotographyImageIOD, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, EnhancedContinuousRTImageIOD, EnhancedRTImageIOD, EnhancedUSImageModule.SimpleWrapper, EnhancedUSVolumeIOD, GeneralReferenceModule.SimpleWrapper, MRImageIOD, MultiFrameGrayscaleByteSecondaryCaptureImageIOD, MultiFrameGrayscaleWordSecondaryCaptureImageIOD, MultiFrameSingleBitSecondaryCaptureImageIOD, MultiFrameTrueColorSecondaryCaptureImageIOD, NuclearMedicineImageIOD, OphthalmicOpticalCoherenceTomographyEnFaceImageIOD, OphthalmicOpticalCoherenceTomographyEnFaceImageModule.SimpleWrapper, OphthalmicPhotography16BitImageIOD, OphthalmicPhotography8BitImageIOD, OphthalmicPhotographyImageModule.SimpleWrapper, OphthalmicThicknessMapIOD, OphthalmicThicknessMapModule.SimpleWrapper, ParametricMapIOD, PositronEmissionTomographyImageIOD, RealTimeVideoEndoscopicImageIOD, RealTimeVideoPhotographicImageIOD, RoboticArmRadiationIOD, RoboticArmRadiationRecordIOD, RTBeamsDeliveryInstructionIOD, RTBeamsTreatmentRecordIOD, RTBrachyApplicationSetupDeliveryInstructionIOD, RTBrachyTreatmentRecordIOD, RTImageIOD, RTIonBeamsTreatmentRecordIOD, RTIonPlanIOD, RTPatientPositionAcquisitionInstructionIOD, RTPhysicianIntentIOD, RTPlanIOD, RTRadiationRecordSetIOD, RTRadiationSalvageRecordIOD, RTRadiationSetDeliveryInstructionIOD, RTRadiationSetIOD, RTSegmentAnnotationIOD, RTStructureSetIOD, RTTreatmentPreparationIOD, RTTreatmentSummaryRecordIOD, SecondaryCaptureImageIOD, SegmentationIOD, SpatialFiducialsIOD, SpatialRegistrationIOD, SurfaceSegmentationIOD, TomotherapeuticRadiationIOD, TomotherapeuticRadiationRecordIOD, UltrasoundImageIOD, UltrasoundMultiFrameImageIOD, VideoEndoscopicImageIOD, VideoMicroscopicImageIOD, VideoPhotographicImageIOD, VLEndoscopicImageIOD, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, VLWholeSlideMicroscopyImageIOD, WideFieldOphthalmicPhotography3DCoordinatesImageIOD, WideFieldOphthalmicPhotographyStereographicProjectionImageIOD, XRay3DAcquisitionSequence.Item, XRayAngiographicImageIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

SourceImageSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SourceImageSequence.Holder.Builder	builder()
static SourceImageSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsSourceImageSequence()
default SourceImageSequence	ensureSourceImageSequence()	Adds a new Source Image Sequence (see SourceImageSequence) with initial capacity 1 (see ensureSourceImageSequence(int)) if it does not already exist.
default SourceImageSequence	ensureSourceImageSequence(int initialCapacity)	Adds a new Source Image Sequence (see SourceImageSequence) if it does not already exist.
default SourceImageSequence	getSourceImageSequence()
default SourceImageSequence	newSourceImageSequence(int initialCapacity)	Adds a new Source Image Sequence.
default void	removeSourceImageSequence()	Removes the Source Image Sequence (see SourceImageSequence
static SourceImageSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Source Image Sequence (see SourceImageSequence)

Returns:

a wrapper object implementing the SourceImageSequence.Holder interface.

builder

static SourceImageSequence.Holder.Builder builder()

Returns:

a SourceImageSequence.Holder.Builder to create Source Image Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getSourceImageSequence

default SourceImageSequence getSourceImageSequence()

Returns:

the Source Image Sequence (see SourceImageSequence)

newSourceImageSequence

default SourceImageSequence newSourceImageSequence(int initialCapacity)

Adds a new Source Image Sequence. (see SourceImageSequence)

Parameters:

initialCapacity - the initial capacity for the new Source Image Sequence

Returns:

the newly created SourceImageSequence.

ensureSourceImageSequence

default SourceImageSequence ensureSourceImageSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureSourceImageSequence

default SourceImageSequence ensureSourceImageSequence()

Adds a new Source Image Sequence (see SourceImageSequence) with initial capacity 1 (see ensureSourceImageSequence(int)) if it does not already exist.

Returns:

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

containsSourceImageSequence

default boolean containsSourceImageSequence()

Returns:

whether it contains the Source Image Sequence (see SourceImageSequence)

removeSourceImageSequence

default void removeSourceImageSequence()

Removes the Source Image Sequence (see SourceImageSequence