Package org.dcm4che.typeddicom.dataelements

Class AnnotationAppliesToAllZPlanes

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.AnnotationAppliesToAllZPlanes

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class AnnotationAppliesToAllZPlanes
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Annotation Applies to All Z Planes
Keyword: AnnotationAppliesToAllZPlanes
Tag: (006A,000F)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Microscopy Bulk Simple Annotations Module > Annotation Group Sequence > Annotation Applies to All Z Planes
  as follows:
  Attribute Name: Annotation Applies to All Z Planes
  Type: 1C
  Attribute Description:

  Whether the Annotations in this Annotation Group apply to the full thickness of the tissue on the slide. I.e., they are applicable regardless of the focal plane, in the case that images were acquired with multiple focal planes (Z-stacks).

  Enumerated Values:

  YES

  the Annotations apply to the full thickness

  NO

  the Annotations apply only to the specified Z plane

  Note

  When the value is NO, the Z plane will be specified either in Common Z Coordinate Value (006A,0010) if all the coordinates are in the same Z plane(s), or in Point Coordinates Data (0066,0016) or Double Point Coordinates Data (0066,0022) if not.

  Required if Annotation Coordinate Type (006A,0001) is 3D.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AnnotationAppliesToAllZPlanes.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Annotation Applies to All Z Planes" (see AnnotationAppliesToAllZPlanes)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

Constructor	Description
AnnotationAppliesToAllZPlanes()	Creates a new Annotation Applies to All Z Planes object which wraps a new and empty Attributes object.
AnnotationAppliesToAllZPlanes(org.dcm4che3.data.Attributes attributes)	Creates a new Annotation Applies to All Z Planes object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
AnnotationAppliesToAllZPlanes	copy()	Returns a new Annotation Applies to All Z Planes which wraps a copy of the Attributes wrapped in this Annotation Applies to All Z Planes.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

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.DataElementWrapper

exists, 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

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

AnnotationAppliesToAllZPlanes

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

Creates a new Annotation Applies to All Z Planes object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

AnnotationAppliesToAllZPlanes

public AnnotationAppliesToAllZPlanes()

Creates a new Annotation Applies to All Z Planes object which wraps a new and empty Attributes object.

Method Details

copy

public AnnotationAppliesToAllZPlanes copy()

Returns a new Annotation Applies to All Z Planes which wraps a copy of the Attributes wrapped in this Annotation Applies to All Z Planes. (see Attributes(Attributes)

Returns:

a new Annotation Applies to All Z Planes which wraps a copy of the Attributes wrapped in this Annotation Applies to All Z Planes.

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.