cdac.medinfo.sdk.dcm30_04.dicommodel.colorpalette

Class ColorPaletteIOD

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.IOD

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.NormalizedIOD

cdac.medinfo.sdk.dcm30_04.dicommodel.colorpalette.ColorPaletteIOD

public class ColorPaletteIOD
extends NormalizedIOD

A Color Palette entity specifies a color palette suitable for application to a grayscale image.

Author:

saloni

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COLOR_PALETTE_IOD The Constant COLOR_PALETTE_IOD.

Fields inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.NormalizedIOD

NORMALIZED_IOD

Constructor Summary

Constructors

Constructor and Description
ColorPaletteIOD() Instantiates a new image iod.
ColorPaletteIOD(IDataSet objIDataSet_) This constructor accepts the Data set from the user in its superclass IOD.
ColorPaletteIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes DictionaryReader in its superclass IOD.
ColorPaletteIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
ColorPaletteIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor accepts the DictionaryReader and TransferSyntax from the user in its superclass IOD.
ColorPaletteIOD(java.lang.String strFileName) Creates IOD from a DICOM file containing corresponding DICOM data.

Method Summary

Methods

Modifier and Type	Method and Description
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the Name of Module and corresponding Attributs of IOD.
ColorPaletteDefinitionModule	getColorPaletteDefinitionModule() Retrieves pre-initialized instance of Color Palette Definition Module.
ICCProfileModule	getICCProfileModule() Retrieves pre-initialized instance of ICC Profile Module.
PaletteColorLookupTableModule	getPaletteColorLookupTableModule() Retrieves pre-initialized instance of Palette Color Lookup Table Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates Image IOD according to the Module Table given in The DICOM Standard.

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

addDataElement, getDataSet, getTransferSyntax, isPresent, removeDataElement, removeModule

Methods inherited from class java.lang.Object

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

Field Detail

COLOR_PALETTE_IOD

public static final java.lang.String COLOR_PALETTE_IOD

The Constant COLOR_PALETTE_IOD.

See Also:

Constant Field Values

Constructor Detail

ColorPaletteIOD

public ColorPaletteIOD()

Instantiates a new image iod.

ColorPaletteIOD

public ColorPaletteIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - Transfer Syntax of IOD.

ColorPaletteIOD

public ColorPaletteIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes DictionaryReader in its superclass IOD.

Parameters:

objIDictionaryReader_ - Dictionary Reader used by the IOD.

ColorPaletteIOD

public ColorPaletteIOD(ITransferSyntax objITransferSyntax_,
               IDictionaryReader objIDictionaryReader_)

This constructor accepts the DictionaryReader and TransferSyntax from the user in its superclass IOD.

Parameters:

objITransferSyntax_ - Transfer Syntax of IOD.

objIDictionaryReader_ - Dictionary Reader used by the IOD.

ColorPaletteIOD

public ColorPaletteIOD(IDataSet objIDataSet_)

This constructor accepts the Data set from the user in its superclass IOD.

Parameters:

objIDataSet_ - the obj i data set_

ColorPaletteIOD

public ColorPaletteIOD(java.lang.String strFileName)
                throws java.io.IOException,
                       InvalidIODException

Creates IOD from a DICOM file containing corresponding DICOM data.

Parameters:

strFileName - DICOM File with absolute path.

Throws:

java.io.IOException - signals Exception caused due to wrong I/O operations.

ParseException - signals if some parse exceptions occurred.

InvalidIODException

Method Detail

getPaletteColorLookupTableModule

public PaletteColorLookupTableModule getPaletteColorLookupTableModule()

Retrieves pre-initialized instance of Palette Color Lookup Table Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

PaletteColorLookupTableModule - instance of PaletteColorLookupTableModule.

getSOPCommonModule

public SOPCommonModule getSOPCommonModule()

Retrieves pre-initialized instance of SOP Common Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

SOPCommonModule - instance of SOPCommonModule.

getICCProfileModule

public ICCProfileModule getICCProfileModule()

Retrieves pre-initialized instance of ICC Profile Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

ICCProfileModule - instance of ICCProfileModule.

getColorPaletteDefinitionModule

public ColorPaletteDefinitionModule getColorPaletteDefinitionModule()

Retrieves pre-initialized instance of Color Palette Definition Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

ColorPaletteDefinitionModule - instance of ColorPaletteDefinitionModule.

validate

public boolean validate()
                 throws InvalidIODException

This method validates Image IOD according to the Module Table given in The DICOM Standard. The validate method fails if one of the mandatory modules are absent or any of the modules are invalid. The validate method also checks for conditional modules.

Overrides:

validate in class IOD

Returns:

- status of validation as success or failure

Throws:

InvalidIODException - the invalid iod exception

dumpDICOMInfo

public void dumpDICOMInfo(IDicomStream objIDicomStream)
                   throws java.io.IOException

Dumps the Name of Module and corresponding Attributs of IOD.

Overrides:

dumpDICOMInfo in class NormalizedIOD

Parameters:

objIDicomStream - - the Stream on which the Data is to be written.

Throws:

java.io.IOException - - Exception is thrown indicating runtime failure of writing operation.

isModulePresent

public boolean isModulePresent(java.lang.String strModuleName)

Checks whether the Module is present in the IOD or not.

Overrides:

isModulePresent in class NormalizedIOD

Parameters:

strModuleName - String value of module name

Returns:

boolean - true if the module is present in the IOD, else false is returned.