cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class BasicPrintImageOverlayBoxModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.BasicPrintImageOverlayBoxModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class BasicPrintImageOverlayBoxModule
extends Module

\* This module specifies the Attributes that identify the Basic Print Image Overlay Box Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
BasicPrintImageOverlayBoxModule(IDataSet objIDataSet) Instantiates a new basic print image overlay box module.

Method Summary

Methods

Modifier and Type	Method and Description
short	getMagnifyToNumberOfColumns() Retrieves number of columns of the overlay or image after magnification.
java.lang.String	getOverlayBackgroundDensity() Retrieves Overlay Background Density.
java.lang.String	getOverlayForegroundDensity() Retrieves the density for pixels which correspond with overlay bit = 1.
java.lang.String	getOverlayMagnificationType() Retrieves Overlay Magnification Type.
java.lang.String	getOverlayOrImageMagnification() Retrieves magnification of the overlay or image before they are superimposed.
OverlayPixelDataSequence	getOverlayPixelDataSequence() Retrieves pre-initialized object of Overlay Pixel Data Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
java.lang.String	getOverlaySmoothingType() Retrieves Overlay Smoothing Type.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setMagnifyToNumberOfColumns(short shMagnifyToNumberOfColumns) Sets the number of columns of the overlay or image after magnification.
void	setOverlayBackgroundDensity(EnumOverlayBackgroundDensity enumOverlayBackgroundDensity) Sets tthe density for pixels which correspond with overlay bit = 0 that are not superimposed on the image and Combined Print Image pixels that are not part of the overlay or image Defined Terms: BLACK WHITE.
void	setOverlayForegroundDensity(EnumOverlayForegroundDensity enumOverlayForegroundDensity) Sets the density for pixels which correspond with overlay bit = 1.
void	setOverlayMagnificationType(EnumOverlayMagnificationType enumOverlayMagnificationType) Sets magnification type if the overlay is magnified before being superimposed on the image.
void	setOverlayOrImageMagnification(EnumOverlayOrImageMagnification enumOverlayOrImageMagnification) Sets magnification of the overlay or image before they are superimposed.
void	setOverlaySmoothingType(java.lang.String strOverlaySmoothingType) Sets the type of interpolation function; only valid for Overlay Magnification Type 2010,0060 = CUBIC.
boolean	validateModule() Validates each Attribute in the Module according to the Type of the Attribute.

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

BasicPrintImageOverlayBoxModule

public BasicPrintImageOverlayBoxModule(IDataSet objIDataSet)

Instantiates a new basic print image overlay box module.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

Validates each Attribute in the Module according to the Type of the Attribute. Attributes are of 5 types. Type 1,Type 2 are Mandatory: Mandatory Attributes have to present in the Module. Type 1C,2C are Conditional: Conditional Attributes' presence depend on a condition. If the condition is satisfied the Attribute has to be present. Type 3 are Optional Optional Attributes can be added as and when required.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

Boolean - status indicating success or failure

Throws:

InvalidModuleException - - If validation of Module fails

getOverlayPixelDataSequence

public OverlayPixelDataSequence getOverlayPixelDataSequence()

Retrieves pre-initialized object of Overlay Pixel Data Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

OverlayPixelDataSequence - instance of Overlay Pixel Data Sequence.

setOverlayMagnificationType

public void setOverlayMagnificationType(EnumOverlayMagnificationType enumOverlayMagnificationType)

Sets magnification type if the overlay is magnified before being superimposed on the image. Enumerated Values: REPLICATE,BILINEAR,CUBIC.

Parameters:

enumOverlayMagnificationType - Enum value of Overlay Magnification Type.

getOverlayMagnificationType

public java.lang.String getOverlayMagnificationType()

Retrieves Overlay Magnification Type.

Returns:

String - String value of Overlay Magnification Type.

setOverlaySmoothingType

public void setOverlaySmoothingType(java.lang.String strOverlaySmoothingType)

Sets the type of interpolation function; only valid for Overlay Magnification Type 2010,0060 = CUBIC.

Parameters:

strOverlaySmoothingType - the str overlay smoothing type

getOverlaySmoothingType

public java.lang.String getOverlaySmoothingType()

Retrieves Overlay Smoothing Type.

Returns:

String - String value of Overlay Smoothing Type.

setOverlayOrImageMagnification

public void setOverlayOrImageMagnification(EnumOverlayOrImageMagnification enumOverlayOrImageMagnification)

Sets magnification of the overlay or image before they are superimposed. Enumerated Values: IMAGE = Image is to be magnified OVERLAY = Overlay is to be magnified.

Parameters:

enumOverlayOrImageMagnification - Enum value of Overlay or Image Magnification.

getOverlayOrImageMagnification

public java.lang.String getOverlayOrImageMagnification()

Retrieves magnification of the overlay or image before they are superimposed.

Returns:

String - String value of Overlay Or Image Magnification.

setMagnifyToNumberOfColumns

public void setMagnifyToNumberOfColumns(short shMagnifyToNumberOfColumns)

Sets the number of columns of the overlay or image after magnification.

Parameters:

shMagnifyToNumberOfColumns - short value of Magnify To Number Of Columns.

getMagnifyToNumberOfColumns

public short getMagnifyToNumberOfColumns()

Retrieves number of columns of the overlay or image after magnification.

Returns:

short - short value of Magnify To Number Of Columns.

setOverlayForegroundDensity

public void setOverlayForegroundDensity(EnumOverlayForegroundDensity enumOverlayForegroundDensity)

Sets the density for pixels which correspond with overlay bit = 1. The density of the other pixels remain unchanged. Defined Terms: BLACK WHITE

Parameters:

enumOverlayForegroundDensity - Enum value of Overlay Foreground Density.

getOverlayForegroundDensity

public java.lang.String getOverlayForegroundDensity()

Retrieves the density for pixels which correspond with overlay bit = 1.

Returns:

String - String value of Overlay Foreground Density.

setOverlayBackgroundDensity

public void setOverlayBackgroundDensity(EnumOverlayBackgroundDensity enumOverlayBackgroundDensity)

Sets tthe density for pixels which correspond with overlay bit = 0 that are not superimposed on the image and Combined Print Image pixels that are not part of the overlay or image Defined Terms: BLACK WHITE.

Parameters:

enumOverlayBackgroundDensity - Enum value of Overlay Background Density.

getOverlayBackgroundDensity

public java.lang.String getOverlayBackgroundDensity()

Retrieves Overlay Background Density.

Returns:

String - String value of Overlay Background Density.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the vector of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

Collection of tags - returns the vector containing the collection of tags.