cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class OverlayPlaneModule

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.OverlayPlaneModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class OverlayPlaneModule
extends Module

This Class represents Overlay Plane. An Overlay Plane describes graphics or bit-mapped text that is associated with an Image or has its own existence within a Series. In this The Group Number allowed are in the series 60xx, i.e allows the repeating Group.

Field Summary

Fields

Modifier and Type	Field and Description
static ISingleCollection<ITag>	objSingleCollection The obj single collection.

Constructor Summary

Constructors

Constructor and Description
OverlayPlaneModule(IDataSet objIDataSet) Creates an Overlay Plane Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
short	getOverlayBitPosition() Return the short value of the attribute Overlay Bit Position.
short	getOverlayBitsAllocated() Return the short value of the attribute Overlay Bits Allocated.
short	getOverlayColumns() Return the short value of the attribute Overlay Columns.
ISingleCollection<byte[]>	getOverlayData() Return the String value of the attribute Overlay Data.
java.lang.String	getOverlayDescription() Return the String value of the attribute Overlay Description.
java.lang.String	getOverlayLabel() Return the String value of the attribute OverlayLabel.
short[]	getOverlayOrigin() Return the String value of the attribute Overlay Origin.
short	getOverlayRows() Return the short value of the attribute Overlay Rows.
java.lang.String	getOverlaySubtype() Return the String value of the attribute OverlaySubtype.
java.lang.String	getOverlayType() Return the String value of the attribute Overlay Type.
java.lang.String	getROIArea() Return the String value of the attribute ROI Area.
java.lang.String	getROIMean() Return the String value of the attribute ROI Mean.
java.lang.String	getROIStandardDeviation() Return the String value of the ROI attribute Standard Deviation.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the custom collection containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.
void	setOverlayBitPosition(short shOverlayBitPosition) The method is used to set Bit in which Overlay is stored.
void	setOverlayBitsAllocated(short shOverlayBitsAllocated) The method is used to set Number of Bits Allocated in the Overlay.
void	setOverlayColumns(short shOverlayColumns) The method is used to set Number of Columns in Overlay.
void	setOverlayData(ISingleCollection<byte[]> objCollectionOfOverlayData) The method is used to set the order of pixels sent for each overlay is left to right, top to bottom, The function accepts a String Value as User generated Study identifie the and creates the DE based on the transfer syntax and populates the DE with right values.
void	setOverlayDescription(java.lang.String strOverlayDescription) The method is used to User-defined comments about the overlay.
void	setOverlayLabel(java.lang.String strOverlayLabel) The method is used to set a user defined text string which may be used to label or name this overlay.
void	setOverlayOrigin(short[] arrShOverlayOrigin) The method is used to set Location of first overlay point with respect to pixels in the image, a region of interest or other graphics.
void	setOverlayRows(short shOverlayRows) The method is used to set Number of Rows in Overlay.
void	setOverlaySubtype(java.lang.String strOverlaySubtype) The method is used to set term which identifies the intended purpose of the Overlay Type.
void	setOverlayType(EnumOverlayType enumOverlayType) The method is used to set Indicates whether this overlay represents a region of interest or other graphics.
void	setROIArea(java.lang.String strROIArea) The method is used to set Number of pixels in ROI area.
void	setROIMean(java.lang.String strROIMean) The method is used to set ROI Mean.
void	setROIStandardDeviation(java.lang.String strROIStandardDeviation) The method is used to set ROI standard deviation.
boolean	validateModule() This method checks the DataSet according the rules of the Overlay Plane Module.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

add, dumpDICOMInfo, getDictionaryReader, getTransferSyntax, isPresent, isPresent, iterator, remove

Methods inherited from class java.lang.Object

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

Field Detail

objSingleCollection

public static ISingleCollection<ITag> objSingleCollection

The obj single collection.

Constructor Detail

OverlayPlaneModule

public OverlayPlaneModule(IDataSet objIDataSet)

Creates an Overlay Plane Module with default initialization.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

This method checks the DataSet according the rules of the Overlay Plane Module.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

boolean - status of validation as success or failure

Throws:

InvalidModuleException - the invalid module exception

setOverlayRows

public void setOverlayRows(short shOverlayRows)

The method is used to set Number of Rows in Overlay. The function accepts a String Value as strOverlayRows and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

shOverlayRows - : Number of Rows in Overlay.

setOverlayColumns

public void setOverlayColumns(short shOverlayColumns)

The method is used to set Number of Columns in Overlay. The function accepts a String Value as User generated Study identifie the and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module Data Set

Parameters:

shOverlayColumns - : Number of Columns in Overlay.

setOverlayType

public void setOverlayType(EnumOverlayType enumOverlayType)

The method is used to set Indicates whether this overlay represents a region of interest or other graphics. Enumerated Values:G = Graphics R = ROI. The function accepts a String Value as User generated Study identifie the and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

enumOverlayType - : indicates a region of interest or other graphics

setOverlayOrigin

public void setOverlayOrigin(short[] arrShOverlayOrigin)

The method is used to set Location of first overlay point with respect to pixels in the image, a region of interest or other graphics. Enumerated Values:G = Graphics R = ROI. The function accepts a String Value as User generated Study identifie the and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

arrShOverlayOrigin - :Location of first overlay point with respect to pixels in the image.

setOverlayBitsAllocated

public void setOverlayBitsAllocated(short shOverlayBitsAllocated)

The method is used to set Number of Bits Allocated in the Overlay. The function accepts a String Value as User generated Study identifie the and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module Data Set

Parameters:

shOverlayBitsAllocated - :Number of Bits Allocated in the Overlay.

setOverlayBitPosition

public void setOverlayBitPosition(short shOverlayBitPosition)

The method is used to set Bit in which Overlay is stored. The function accepts a String Value as User generated Study identifie the and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

shOverlayBitPosition - :Bit in which Overlay is stored.

setOverlayData

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

The method is used to set the order of pixels sent for each overlay is left to right, top to bottom, The function accepts a String Value as User generated Study identifie the and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

objCollectionOfOverlayData - : ISingle Collection of bytes.

setOverlayDescription

public void setOverlayDescription(java.lang.String strOverlayDescription)

The method is used to User-defined comments about the overlay. The function accepts a String Value as User generated Study identifie the and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

strOverlayDescription - :User-defined comments about the overlay.

setOverlaySubtype

public void setOverlaySubtype(java.lang.String strOverlaySubtype)

The method is used to set term which identifies the intended purpose of the Overlay Type. The function accepts a String Value as User generated Study identifie the and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

strOverlaySubtype - :term which identifies the intended purpose of the Overlay Type.

setOverlayLabel

public void setOverlayLabel(java.lang.String strOverlayLabel)

The method is used to set a user defined text string which may be used to label or name this overlay. The function accepts a String Value as User generated Study identifie the and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

strOverlayLabel - : a user defined text string which may be used to label or name this overlay.

setROIArea

public void setROIArea(java.lang.String strROIArea)

The method is used to set Number of pixels in ROI area. The function accepts a String Value as User generated Study identifie the and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

strROIArea - : Number of pixels in ROI area.

setROIMean

public void setROIMean(java.lang.String strROIMean)

The method is used to set ROI Mean. The function accepts a String Value as User generated Study identifie the and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module Data Set

Parameters:

strROIMean - : ROI Mean.

setROIStandardDeviation

public void setROIStandardDeviation(java.lang.String strROIStandardDeviation)

The method is used to set ROI standard deviation. The function accepts a String Value as User generated Study identifie the and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strROIStandardDeviation - : ROI standard deviation.

getOverlayRows

public short getOverlayRows()

Return the short value of the attribute Overlay Rows.

Returns:

short - returns the Rows of Overlay

getOverlayColumns

public short getOverlayColumns()

Return the short value of the attribute Overlay Columns.

Returns:

short - returns the Columns of Overlay

getOverlayType

public java.lang.String getOverlayType()

Return the String value of the attribute Overlay Type.

Returns:

String - returns the Type of Overlay

getOverlayOrigin

public short[] getOverlayOrigin()

Return the String value of the attribute Overlay Origin.

Returns:

String[] - returns the array of Overlay Origin

getOverlayBitsAllocated

public short getOverlayBitsAllocated()

Return the short value of the attribute Overlay Bits Allocated.

Returns:

short - returns the Bits Allocated for Overlay

getOverlayBitPosition

public short getOverlayBitPosition()

Return the short value of the attribute Overlay Bit Position.

Returns:

short - returns the Position of Overlay Bit

getOverlayData

public ISingleCollection<byte[]> getOverlayData()

Return the String value of the attribute Overlay Data.

Returns:

Collection of byte[] - returns the collection of Overlay Data

getOverlayDescription

public java.lang.String getOverlayDescription()

Return the String value of the attribute Overlay Description.

Returns:

String - return the Description of Overlay

getOverlaySubtype

public java.lang.String getOverlaySubtype()

Return the String value of the attribute OverlaySubtype.

Returns:

String - return the Overlay Subtype

getOverlayLabel

public java.lang.String getOverlayLabel()

Return the String value of the attribute OverlayLabel.

Returns:

String - returns the Overlay Label

getROIArea

public java.lang.String getROIArea()

Return the String value of the attribute ROI Area.

Returns:

String - returns the ROI Area

getROIMean

public java.lang.String getROIMean()

Return the String value of the attribute ROI Mean.

Returns:

String - returns the ROI Mean

getROIStandardDeviation

public java.lang.String getROIStandardDeviation()

Return the String value of the ROI attribute Standard Deviation.

Returns:

String - returns the ROI Standard Deviation

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the custom collection containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.

Overrides:

getVectorOfKeys in class Module

Returns:

collection - custom collection containing the list of DataElements belonging to the CT Image Module