cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class ImagePixelModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ImagePixelModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class ImagePixelModule
extends Module

\* The class ImagePixelModule. This class specifies the attributes that describe the pixel data of the image.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ImagePixelModule(IDataSet objIDataSet) Creates Image Pixel Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
ImagePixelMacro	getImagePixelMacro() Get the Instance of Image Pixel Macro.Attributes related to Image Pixel Macro will be set in Macro using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco Instance that was created at first.
java.lang.String	getPixelDataProviderURL() Retrieves Pixel Data Provider URL.
short	getPixelPaddingRangeLimit() Retrieves the Pixel Padding Range Limit.
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	setPixelDataProviderURL(java.lang.String strPixelDataProviderURL) Sets Pixel Data Provider URL.
void	setPixelPaddingRangeLimit(short sPixelPaddingRangeLimit) Sets the Pixel Padding Range Limit.
boolean	validateModule() This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types.

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

ImagePixelModule

public ImagePixelModule(IDataSet objIDataSet)

Creates Image Pixel Module with default initialization.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

This method 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 - the invalid module exception

getImagePixelMacro

public ImagePixelMacro getImagePixelMacro()

Get the Instance of Image Pixel Macro.Attributes related to Image Pixel Macro will be set in Macro using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco Instance that was created at first. Hence, any attributes in this Macro,if set multiple times will contain the value that was set in the last call to its setter method.

Returns:

- object of Image Pixel Macro which the user programmer can populate

setPixelDataProviderURL

public void setPixelDataProviderURL(java.lang.String strPixelDataProviderURL)

Sets Pixel Data Provider URL. A URL of a provider service that supplies the pixel data of the Image.

Parameters:

strPixelDataProviderURL - String value of Pixel Data Provider URL.

getPixelDataProviderURL

public java.lang.String getPixelDataProviderURL()

Retrieves Pixel Data Provider URL. A URL of a provider service that supplies the pixel data of the Image.

Returns:

String - String value of Pixel Data Provider URL.

setPixelPaddingRangeLimit

public void setPixelPaddingRangeLimit(short sPixelPaddingRangeLimit)

Sets the Pixel Padding Range Limit.

Parameters:

sPixelPaddingRangeLimit - short value of Pixel Padding Range Limit.

getPixelPaddingRangeLimit

public short getPixelPaddingRangeLimit()

Retrieves the Pixel Padding Range Limit.

Returns:

short - short value of Pixel Padding Range Limit.

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