Package org.dcm4che.typeddicom.dataelements

Class OverlayBitPosition

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.OverlayBitPosition

All Implemented Interfaces:

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

public class OverlayBitPosition
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Overlay Bit Position
Keyword: OverlayBitPosition
Tag: (60xx,0102)
Value Representation: UnsignedShort
Value Multiplicity: 1

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

  The value of this Attribute shall be 0.

  Note

  Formerly the Standard described embedding the overlay data in the Image Pixel Data (7FE0,0010), in which case the value of this Attribute specified the bit in which the overlay was stored. This usage has been retired. See http://medical.nema.org/MEDICAL/Dicom/2004/printed/04_03pu3.pdfPS3.3-2004.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

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

OverlayBitPosition

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

Creates a new Overlay Bit Position object which wraps the provided attributes.

Parameters:

attributes - the Attributes object to be wrapped.

OverlayBitPosition

public OverlayBitPosition()

Creates a new Overlay Bit Position object which wraps a new and empty Attributes object.

Method Detail

copy

public OverlayBitPosition copy()

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

Returns:

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

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