Package org.dcm4che.typeddicom.dataelements

Class BurnedInAnnotation

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.BurnedInAnnotation

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class BurnedInAnnotation
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Burned In Annotation
Keyword: BurnedInAnnotation
Tag: (0028,0301)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Whole Slide Microscopy Image Module > Burned In Annotation
  as follows:
  Attribute Name: Burned In Annotation
  Type: 1
  Attribute Description:

  Indicates whether or not image contains sufficient burned in annotation to identify the patient.

  Enumerated Values:

  YES

  NO

  Note

  If Specimen Label in Image (0048,0010) value is YES, Burned In Annotation (0028,0301) might be NO if the label includes only a specimen identifier and not patient identifying data.

  
  
• Described in the contexts:
  • Enhanced CT Image Module > Burned In Annotation
  as follows:
  Attribute Name: Burned In Annotation
  Type: 1C
  Attribute Description:

  Indicates whether or not the image contains sufficient burned in annotation to identify the patient and date the image was acquired.

  Enumerated Values:

  NO

  This means that images that contain this Module shall not contain such burned in annotations.

  Required if SOP Class UID is not "1.2.840.10008.5.1.4.1.1.2.2" (Legacy Converted), may be present otherwise.

  
  
• Described in the contexts:
  • Enhanced MR Image Module > Burned In Annotation
  as follows:
  Attribute Name: Burned In Annotation
  Type: 1C
  Attribute Description:

  Indicates whether or not the image contains sufficient burned in annotation to identify the patient and date the image was acquired.

  Enumerated Values:

  NO

  This means that images that contain this Module shall not contain such burned in annotations.

  Required if SOP Class UID is not "1.2.840.10008.5.1.4.1.1.4.4" (Legacy Converted), may be present otherwise.

  
  
• Described in the contexts:
  • General Image Module > Burned In Annotation
  as follows:
  Attribute Name: Burned In Annotation
  Type: 3
  Attribute Description:

  Indicates whether or not image contains sufficient burned in annotation to identify the patient and date the image was acquired.

  Enumerated Values:

  YES

  NO

  If this Attribute is absent, then the image may or may not contain burned in annotation.

  
  
• Described in the contexts:
  • Ophthalmic Thickness Map Module > Burned In Annotation
  • Corneal Topography Map Image Module > Burned In Annotation
  as follows:
  Attribute Name: Burned In Annotation
  Type: 1
  Attribute Description:

  Indicates that the image does not contain burned in annotation to identify the patient and date the image was acquired.

  Enumerated Values:

  NO

  
  
• Described in the contexts:
  • Enhanced Mammography Image Module > Burned in Annotation
  as follows:
  Attribute Name: Burned in Annotation
  Type: 1
  Attribute Description:

  Indicates whether or not the image contains sufficient burned in annotation to identify the patient and date the image was acquired.

  Enumerated Values:

  NO

  
  
• Described in the contexts:
  • Enhanced PET Image Module > Burned in Annotation
  as follows:
  Attribute Name: Burned in Annotation
  Type: 1C
  Attribute Description:

  Indicates that the image does not contain burned in annotations.

  Enumerated Values:

  NO

  This means that images that contain this Module shall not contain burned in annotations.

  Required if SOP Class UID is not "1.2.840.10008.5.1.4.1.1.128.1" (Legacy Converted), may be present otherwise.

  
  
• Described in the contexts:
  • Enhanced XA/XRF Image Module Table > Burned In Annotation
  • X-Ray 3D Image Module > Burned In Annotation
  as follows:
  Attribute Name: Burned In Annotation
  Type: 1
  Attribute Description:

  Indicates whether or not the image contains sufficient burned in annotation to identify the patient and date the image was acquired.

  Enumerated Values:

  NO

  
  
• Described in the contexts:
  • Intravascular OCT Image Module > Burned In Annotation
  • Enhanced US Image Module > Burned In Annotation
  • Parametric Map Image Module > Burned In Annotation
  • Ophthalmic Tomography Image Module > Burned In Annotation
  • Ophthalmic Optical Coherence Tomography B-scan Volume Analysis Image Module > Burned In Annotation
  as follows:
  Attribute Name: Burned In Annotation
  Type: 1
  Attribute Description:

  Indicates whether or not image contains sufficient burned in annotation to identify the patient and date the image was acquired.

  Enumerated Values:

  NO

  
  
• Described in the contexts:
  • Encapsulated Document Module > Burned In Annotation
  as follows:
  Attribute Name: Burned In Annotation
  Type: 1
  Attribute Description:

  Indicates whether or not the encapsulated document contains sufficient burned in annotation to identify the patient and date the data was acquired.

  Enumerated Values:

  YES

  NO

  Identification of patient and date as text in an encapsulated document (e.g., in an XML attribute or element) is equivalent to "burned in annotation". A de-identified document may use the value NO.

  If Modality (0008,0060) is M3D, the presence of identifying information embossed or engraved on any part of the model shall be indicated by a value of YES.

  
  
• Described in the contexts:
  • Ophthalmic Photography Image Module > Burned In Annotation
  • SC Multi-frame Image Module > Burned In Annotation
  • Ophthalmic Optical Coherence Tomography En Face Image Module > Burned In Annotation
  • DX Image Module > Burned In Annotation
  as follows:
  Attribute Name: Burned In Annotation
  Type: 1
  Attribute Description:

  Indicates whether or not image contains sufficient burned in annotation to identify the patient and date the image was acquired.

  Enumerated Values:

  YES

  NO

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BurnedInAnnotation.Builder<SELF extends BurnedInAnnotation.Builder<SELF,T>,T extends BurnedInAnnotation.Holder>
static interface	BurnedInAnnotation.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Burned In Annotation" (see BurnedInAnnotation)
static class	BurnedInAnnotation.SimpleHolder

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.CodeStringWrapper

CodeStringWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends CodeStringWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.CodeStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
BurnedInAnnotation()	Creates a new Burned In Annotation object which wraps a new and empty Attributes object.
BurnedInAnnotation(org.dcm4che3.data.Attributes attributes)	Creates a new Burned In Annotation object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
BurnedInAnnotation	copy()	Returns a new Burned In Annotation which wraps a copy of the Attributes wrapped in this Burned In Annotation.
int	getTag()

Methods inherited from class org.dcm4che.typeddicom.AbstractDataElementWrapper

equals, exists, getValue, hashCode, toString

Methods inherited from class org.dcm4che.typeddicom.AbstractAttributesWrapper

getAttributes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper

getBytes, getSafeBytes, setBytes

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.CodeStringWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getPrivateCreator, getValue

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

getString, setString

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

BurnedInAnnotation

public BurnedInAnnotation(org.dcm4che3.data.Attributes attributes)

Creates a new Burned In Annotation object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

BurnedInAnnotation

public BurnedInAnnotation()

Creates a new Burned In Annotation object which wraps a new and empty Attributes object.

Method Details

copy

public BurnedInAnnotation copy()

Returns a new Burned In Annotation which wraps a copy of the Attributes wrapped in this Burned In Annotation. (see Attributes(Attributes)

Returns:

a new Burned In Annotation which wraps a copy of the Attributes wrapped in this Burned In Annotation.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.