Package org.dcm4che.typeddicom.dataelements

Class OverlayBitsAllocated

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.OverlayBitsAllocated

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class OverlayBitsAllocated
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Overlay Bits Allocated
Keyword: OverlayBitsAllocated
Tag: (60xx,0100)
Value Representation: US
Value Multiplicity: 1

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

  Number of Bits Allocated in the Overlay.

  The value of this Attribute shall be 1.

  Note

  Formerly the Standard described embedding the overlay data in the Image Pixel Data (7FE0,0010), in which case the value of this Attribute was required to be the same as Bits Allocated (0028,0100). This usage has been retired. See ftp://medical.nema.org/MEDICAL/Dicom/2004/printed/04_03pu3.pdfPS3.3-2004.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

OverlayBitsAllocated

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

Creates a new Overlay Bits Allocated object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

OverlayBitsAllocated

public OverlayBitsAllocated()

Creates a new Overlay Bits Allocated object which wraps a new and empty Attributes object.

Method Details

copy

public OverlayBitsAllocated copy()

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

Returns:

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

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.