Package org.dcm4che.typeddicom.dataelements

Interface BurnedInAnnotation.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

CornealTopographyMapImageModule, DXImageModule, EncapsulatedDocumentModule, EnhancedCTImageModule, EnhancedMammographyImageModule, EnhancedMRImageModule, EnhancedPETImageModule, EnhancedUSImageModule, EnhancedXAXRFImageModuleTable, GeneralImageModule, IntravascularOCTImageModule, OphthalmicOpticalCoherenceTomographyBScanVolumeAnalysisImageModule, OphthalmicOpticalCoherenceTomographyEnFaceImageModule, OphthalmicPhotographyImageModule, OphthalmicThicknessMapModule, OphthalmicTomographyImageModule, ParametricMapImageModule, SCMultiFrameImageModule, WholeSlideMicroscopyImageModule, XRay3DImageModule

All Known Implementing Classes:

BreastProjectionXRayImageIOD, BreastTomosynthesisImageIOD, CornealTopographyMapImageModule.SimpleWrapper, CornealTopographyMapIOD, CRImageIOD, CTImageIOD, DermoscopicPhotographyImageIOD, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, DXImageModule.SimpleWrapper, EncapsulatedCDAIOD, EncapsulatedDocumentModule.SimpleWrapper, EncapsulatedMTLIOD, EncapsulatedOBJIOD, EncapsulatedPDFIOD, EncapsulatedSTLIOD, EnhancedCTImageIOD, EnhancedCTImageModule.SimpleWrapper, EnhancedMammographyImageModule.SimpleWrapper, EnhancedMRColorImageIOD, EnhancedMRImageIOD, EnhancedMRImageModule.SimpleWrapper, EnhancedPETImageIOD, EnhancedPETImageModule.SimpleWrapper, EnhancedUSImageModule.SimpleWrapper, EnhancedUSVolumeIOD, EnhancedXAImageIOD, EnhancedXAXRFImageModuleTable.SimpleWrapper, EnhancedXRFImageIOD, GeneralImageModule.SimpleWrapper, IntravascularOCTImageModule.SimpleWrapper, IntravascularOpticalCoherenceTomographyImageIOD, LegacyConvertedEnhancedCTImageIOD, LegacyConvertedEnhancedMRImageIOD, LegacyConvertedEnhancedPETImageIOD, MRImageIOD, MultiFrameGrayscaleByteSCImageIOD, MultiFrameGrayscaleWordSCImageIOD, MultiFrameSingleBitSCImageIOD, MultiFrameTrueColorSCImageIOD, NMImageIOD, OphthalmicOpticalCoherenceTomographyBScanVolumeAnalysisImageModule.SimpleWrapper, OphthalmicOpticalCoherenceTomographyBScanVolumeAnalysisIOD, OphthalmicOpticalCoherenceTomographyEnFaceImageIOD, OphthalmicOpticalCoherenceTomographyEnFaceImageModule.SimpleWrapper, OphthalmicPhotography16BitImageIOD, OphthalmicPhotography8BitImageIOD, OphthalmicPhotographyImageModule.SimpleWrapper, OphthalmicThicknessMapIOD, OphthalmicThicknessMapModule.SimpleWrapper, OphthalmicTomographyImageIOD, OphthalmicTomographyImageModule.SimpleWrapper, ParametricMapImageModule.SimpleWrapper, ParametricMapIOD, PETImageIOD, RealTimeVideoEndoscopicImageIOD, RealTimeVideoPhotographicImageIOD, RTDoseIOD, RTImageIOD, SCMultiFrameImageModule.SimpleWrapper, SecondaryCaptureImageIOD, SegmentationIOD, USImageIOD, USMultiFrameImageIOD, VideoEndoscopicImageIOD, VideoMicroscopicImageIOD, VideoPhotographicImageIOD, VLEndoscopicImageIOD, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, VLWholeSlideMicroscopyImageIOD, WholeSlideMicroscopyImageModule.SimpleWrapper, WideFieldOphthalmicPhotography3DCoordinatesImageIOD, WideFieldOphthalmicPhotographyStereographicProjectionImageIOD, XRay3DAngiographicImageIOD, XRay3DCraniofacialImageIOD, XRay3DImageModule.SimpleWrapper, XRayAngiographicImageIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

BurnedInAnnotation

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

A class implementing this interface can hold attributes which contain the DICOM tag "Burned In Annotation" (see BurnedInAnnotation)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BurnedInAnnotation.Holder.Builder	builder()
static BurnedInAnnotation.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsBurnedInAnnotation()
default BurnedInAnnotation	getBurnedInAnnotation()
default void	removeBurnedInAnnotation()	Removes the Burned In Annotation (see BurnedInAnnotation
static BurnedInAnnotation.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Burned In Annotation (see BurnedInAnnotation)

Returns:

a wrapper object implementing the BurnedInAnnotation.Holder interface.

builder

static BurnedInAnnotation.Holder.Builder builder()

Returns:

a BurnedInAnnotation.Holder.Builder to create Burned In Annotation Items with a fluent API.

builder

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

Parameters:

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

Returns:

a BurnedInAnnotation.Holder.Builder to create Burned In Annotation Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getBurnedInAnnotation

default BurnedInAnnotation getBurnedInAnnotation()

Returns:

the Burned In Annotation (see BurnedInAnnotation)

containsBurnedInAnnotation

default boolean containsBurnedInAnnotation()

Returns:

whether it contains the Burned In Annotation (see BurnedInAnnotation)

removeBurnedInAnnotation

default void removeBurnedInAnnotation()

Removes the Burned In Annotation (see BurnedInAnnotation