cdac.medinfo.sdk.dcm30_04.baselibs

Class OverlayPixelDataSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.OverlayPixelDataSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class OverlayPixelDataSequenceItem
extends Item

This item class contains the methods to set,get and validate the attribute present in Overlay Pixel Data Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
short	getOverlayBitPosition() Retrieves Bit in which Overlay is stored.
short	getOverlayBitsAllocated() Retrieves Number of bits allocated in the Overlay
short	getOverlayColumns() Retrieves Number of Columns in Overlay.
ISingleCollection<byte[]>	getOverlayData() Retrieves Bit in which Overlay is stored.
short[]	getOverlayOrigin() Retrieves Location of first overlay point with respect to pixels in the image, given as row\column.
short	getOverlayRows() Retrieves Number of Rows in Overlay.
void	setOverlayBitPosition(EnumOverlayBitPosition enumOverlayBitPosition) Sets Bit in which Overlay is stored.
void	setOverlayBitsAllocated(EnumOverlayBitsAllocated enumOverlayBitsAllocated) Sets Number of bits allocated in the Overlay Enumerated Value: 1
void	setOverlayColumns(short shOverlayColumns) Sets Number of Columns in Overlay.
void	setOverlayData(ISingleCollection<byte[]> objOverlayData) Overlay data shall be contained in this Attribute.
void	setOverlayOrigin(short[] shArrOverlayOrigin) Sets Location of first overlay point with respect to pixels in the image, given as row\column.
void	setOverlayRows(short shOverlayRows) Sets Number of Rows in Overlay.
boolean	validateForModule() Validates all the attributes in Overlay Pixel Data Sequence Item that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Item

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setOverlayRows

public void setOverlayRows(short shOverlayRows)

Sets Number of Rows in Overlay.

Parameters:

shOverlayRows - short value of Number of Rows in Overlay.

getOverlayRows

public short getOverlayRows()

Retrieves Number of Rows in Overlay.

Returns:

short - short value of Number of Rows in Overlay.

setOverlayColumns

public void setOverlayColumns(short shOverlayColumns)

Sets Number of Columns in Overlay.

Parameters:

shOverlayColumns - short value of Number of Columns in Overlay.

getOverlayColumns

public short getOverlayColumns()

Retrieves Number of Columns in Overlay.

Returns:

short - short value of Number of Columns in Overlay.

setOverlayOrigin

public void setOverlayOrigin(short[] shArrOverlayOrigin)

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

Parameters:

shArrOverlayOrigin - short array of Overlay Origin

getOverlayOrigin

public short[] getOverlayOrigin()

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

Returns:

short - short value of Overlay Origin.

setOverlayBitsAllocated

public void setOverlayBitsAllocated(EnumOverlayBitsAllocated enumOverlayBitsAllocated)

Sets Number of bits allocated in the Overlay Enumerated Value: 1

Parameters:

enumOverlayBitsAllocated - Number of bits allocated in the Overlay

getOverlayBitsAllocated

public short getOverlayBitsAllocated()

Retrieves Number of bits allocated in the Overlay

Returns:

short - short value of Number of bits allocated in the Overlay

setOverlayBitPosition

public void setOverlayBitPosition(EnumOverlayBitPosition enumOverlayBitPosition)

Sets Bit in which Overlay is stored. Enumerated Value: 0

Parameters:

enumOverlayBitPosition - Bit in which Overlay is stored.

getOverlayBitPosition

public short getOverlayBitPosition()

Retrieves Bit in which Overlay is stored.

Returns:

short - short value of Bit in which Overlay is stored.

setOverlayData

public void setOverlayData(ISingleCollection<byte[]> objOverlayData)

Overlay data shall be contained in this Attribute.

Parameters:

strOverlayData - String value of Overlay Data.

getOverlayData

public ISingleCollection<byte[]> getOverlayData()

Retrieves Bit in which Overlay is stored.

Returns:

short - short value of Bit in which Overlay is stored.

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in Overlay Pixel Data Sequence Item that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException Conditional element fails.