Package org.dcm4che.typeddicom.dataelements

Class OverlayDataAsOW

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.OverlayDataAsOW

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.IntDataElementWrapper, OtherWordWrapper

public class OverlayDataAsOW
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements OtherWordWrapper

Name: Overlay Data
Keyword: OverlayDataAsOW
Tag: (60xx,3000)
Value Representation: OtherWord
Value Multiplicity: 1

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

  Overlay pixel data.

  The order of pixels encoded for each overlay is left to right, top to bottom, i.e., the upper left pixel is encoded first followed by the remainder of the first row, followed by the first pixel of the 2nd row, then the remainder of the 2nd row and so on.

  Overlay data shall be contained in this Attribute.

  See DICOM Standard Part 3 - Section C.9.2.1.1 for further explanation.

  
  

Nested Class Summary

Nested Classes

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

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

OtherWordWrapper.Setter<B extends org.dcm4che.typeddicom.Builder<B,? extends org.dcm4che.typeddicom.AttributesWrapper>,D extends OtherWordWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PRIVATE_CREATOR	The Private Creator associated with this class.
static int	TAG	The DICOM Tag associated with this class.

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
OverlayDataAsOW()	Creates a new Overlay Data object which wraps a new and empty Attributes object.
OverlayDataAsOW(org.dcm4che3.data.Attributes attributes)	Creates a new Overlay Data object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
OverlayDataAsOW	copy()	Returns a new Overlay Data which wraps a copy of the Attributes wrapped in this Overlay Data.
java.lang.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.DataElementWrapper

exists, getValue

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

getInt, setInt

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

getValueRepresentation

Field Detail

PRIVATE_CREATOR

public static final java.lang.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 Detail

OverlayDataAsOW

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

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

Parameters:

attributes - the Attributes object to be wrapped.

OverlayDataAsOW

public OverlayDataAsOW()

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

Method Detail

copy

public OverlayDataAsOW copy()

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

Returns:

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

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper