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)

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

getInt, getInts, setInts

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

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.

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.