cdac.medinfo.sdk.dcm30_04.baselibs

Class ImageOverlayBoxContentSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.ImageOverlayBoxContentSequenceItem

All Implemented Interfaces:

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

public class ImageOverlayBoxContentSequenceItem
extends Item

This item class contains the methods to set, get and validate the attribute present in Image Overlay Box Content Sequence Item.

See Also:

Serialized Form

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.
java.lang.String	getSOPInstanceUID() Retrieves SOP Instance UID of the contained Image Overlay Box SOP Class.
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.
void	setSOPInstanceUID(java.lang.String strSOPInstanceUID) Sets SOP Instance UID of the contained Image Overlay Box SOP Class.
boolean	validateForModule() Validates all the attributes in ImageOverlayBoxContentSequenceItem 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

setSOPInstanceUID

public void setSOPInstanceUID(java.lang.String strSOPInstanceUID)

Sets SOP Instance UID of the contained Image Overlay Box SOP Class. Required if Sequence is sent.

Parameters:

strSOPInstanceUID - String value of SOP Instance UID of the contained Image Overlay Box SOP Class.

getSOPInstanceUID

public java.lang.String getSOPInstanceUID()

Retrieves SOP Instance UID of the contained Image Overlay Box SOP Class. Required if Image Overlay Box Content Sequence is sent.

Returns:

String - value of SOP Instance UID.

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 - value of Overlay Magnification 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 - 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 - 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 - value of Overlay Background Density.

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 - String value of Overlay Smoothing Type.

getOverlaySmoothingType

public java.lang.String getOverlaySmoothingType()

Retrieves Overlay Smoothing Type.

Returns:

String - value of Overlay Smoothing Type.

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in ImageOverlayBoxContentSequenceItem 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 If Mandatory or Conditional element fails.