Package org.dcm4che.typeddicom.dataelements

Class OverlayType

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.OverlayType

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class OverlayType
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Overlay Type
Keyword: OverlayType
Tag: (60xx,0040)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Overlay Plane Module > Overlay Type
  as follows:
  Attribute Name: Overlay Type
  Type: 1
  Attribute Description:

  Indicates whether this overlay represents a region of interest or other graphics.

  Enumerated Values:

  G

  Graphics

  R

  ROI

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OverlayType.Builder<SELF extends OverlayType.Builder<SELF,T>,T extends OverlayType.Holder>
static interface	OverlayType.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Overlay Type" (see OverlayType)
static class	OverlayType.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 String	PRIVATE_CREATOR	The Private Creator associated with this class.
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
OverlayType()	Creates a new Overlay Type object which wraps a new and empty Attributes object.
OverlayType(org.dcm4che3.data.Attributes attributes)	Creates a new Overlay Type object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
OverlayType	copy()	Returns a new Overlay Type which wraps a copy of the Attributes wrapped in this Overlay Type.
String	getPrivateCreator()
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, getValue

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

getString, setString

Field Details

PRIVATE_CREATOR

public static final String PRIVATE_CREATOR

The Private Creator associated with this class.

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

OverlayType

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

Creates a new Overlay Type object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

OverlayType

public OverlayType()

Creates a new Overlay Type object which wraps a new and empty Attributes object.

Method Details

copy

public OverlayType copy()

Returns a new Overlay Type which wraps a copy of the Attributes wrapped in this Overlay Type. (see Attributes(Attributes)

Returns:

a new Overlay Type which wraps a copy of the Attributes wrapped in this Overlay Type.

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.