Package org.dcm4che.typeddicom.dataelements

Class OverlayOrigin

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.OverlayOrigin

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementMultiWrapper, SignedShortMultiWrapper

public class OverlayOrigin
extends AbstractDataElementWrapper
implements SignedShortMultiWrapper

Name: Overlay Origin
Keyword: OverlayOrigin
Tag: (60xx,0050)
Value Representation: SS
Value Multiplicity: 2

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

  Location of first overlay point with respect to pixels in the image, given as row\column.

  The upper left pixel of the image has the coordinate 1\1.

  Column values greater than 1 indicate the overlay plane origin is to the right of the image origin. Row values greater than 1 indicate the overlay plane origin is below the image origin. Values less than 1 indicate the overlay plane origin is above or to the left of the image origin.

  Note

  Values of 0\0 indicate that the overlay pixels start 1 row above and one column to the left of the image pixels.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
OverlayOrigin	copy()	Returns a new Overlay Origin which wraps a copy of the Attributes wrapped in this Overlay Origin.
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.IntDataElementMultiWrapper

getInt, getInts, setInts

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

getValueRepresentation

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

OverlayOrigin

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

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

Parameters:

attributes - The Attributes object to be wrapped.

OverlayOrigin

public OverlayOrigin()

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

Method Details

copy

public OverlayOrigin copy()

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

Returns:

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

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.