cdac.medinfo.sdk.dcm30_04.dicommodel.ophthalmic

Class OphthalmicThicknessMapIOD

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.CompositeIOD

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ImageIOD

cdac.medinfo.sdk.dcm30_04.dicommodel.ophthalmic.OphthalmicThicknessMapIOD

public class OphthalmicThicknessMapIOD
extends ImageIOD

The Ophthalmic Thickness Map IOD is generated by ophthalmic thickness mapping devices, such as retinal nerve fiber layer analyzersand optic nerve head analyzers, to generate measurements that are presented topographically using a monochromatic image and a pseudo-color map.

Author:

saloni

Constructor Summary

Constructors

Constructor and Description
OphthalmicThicknessMapIOD() Instantiates a new OphthalmicThicknessMapIOD
OphthalmicThicknessMapIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
OphthalmicThicknessMapIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
OphthalmicThicknessMapIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
OphthalmicThicknessMapIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
OphthalmicThicknessMapIOD(java.lang.String strFileName) Creates OphthalmicThicknessMapIOD IOD from a DICOM file containing OphthalmicThicknessMapIOD DICOM data.

Method Summary

Methods

Modifier and Type	Method and Description
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the Name of IOD,Module and corresponding Attributes of Module.
AcquisitionContextModule	getAcquisitionContextModule() Retrieves pre-initialized instance of Acquisition Context Module.
BitmapDisplayShutterModule	getBitmapDisplayShutterModule() Retrieves pre-initialized instance of BitmapDisplayshutterModule.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of objCommon Instance Reference Module.
EnhancedGeneralEquipmentModule	getEnhancedGeneralEquipmentModule() Retrieves pre-initialized instance of Enhanced General Equipment Module.
GeneralImageModule	getGeneralImageModule() Retrieves pre-initialized instance of GeneralImageModule.
OphthalmicPhotographyAcquisitionParametersModule	getOphthalmicPhotographyAcquisitionParametersModule() Retrieves pre-initialized instance of OphthalmicPhotographyAcquisitionParametersModule.
OphthalmicThicknessMapModule	getOphthalmicThicknessMapModule() Retrieves pre-initialized instance of OphthalmicThicknessMapModule.
OphthalmicThicknessMapQualityRatingModule	getOphthalmicThicknessMapQualityRatingModule() Retrieves pre-initialized instance of OphthalmicThicknessMapQualityRatingModule.
OphthalmicThicknessMapSeriesModule	getOphthalmicThicknessMapSeriesModule() Retrieves pre-initialized instance of OphthalmicThicknessMapSeriesModule.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
SupplementalPaletteColorLookupTableModule	getSupplementalPaletteColorLookupTableModule() Retrieves pre-initialized instance of Supplemental Palette Color Lookup Table Module.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates OphthalmicThicknessMapIOD according to the Module Table given in The DICOM Standard.

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

getClinicalTrialSeriesModule, getGeneralEquipmentModule, getGeneralSeriesModule, getGeneralStudyModule, getImagePixelModule, getPatientModule, getPatientStudyModule

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

getClinicalTrialStudyModule, getClinicalTrialSubjectModule

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

Constructor Detail

OphthalmicThicknessMapIOD

public OphthalmicThicknessMapIOD()

Instantiates a new OphthalmicThicknessMapIOD

OphthalmicThicknessMapIOD

public OphthalmicThicknessMapIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

OphthalmicThicknessMapIOD

public OphthalmicThicknessMapIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

objIDictionaryReader_ - - specifies the DICOM Dictionary reader to be used .

OphthalmicThicknessMapIOD

public OphthalmicThicknessMapIOD(IDataSet objIDataSet_)

This constructor accepts the DataSet from the user in its superclass IOD.

Parameters:

objIDataSet_ - - specifies the data set to be set in the IOD.

OphthalmicThicknessMapIOD

public OphthalmicThicknessMapIOD(ITransferSyntax objITransferSyntax_,
                         IDictionaryReader objIDictionaryReader_)

This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.

Parameters:

objITransferSyntax_ - specifies the DICOM Standard defined TransfeSyntax.

objIDictionaryReader_ - specifies the DICOM Dictionary reader to be used .

OphthalmicThicknessMapIOD

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

Creates OphthalmicThicknessMapIOD IOD from a DICOM file containing OphthalmicThicknessMapIOD DICOM data.

Parameters:

strFileName - DICOM File with absolute path.

Throws:

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

ParseException - signals if some parse exceptions are occurred.

InvalidIODException - signals if some IOD exceptions are occurred.

Method Detail

getOphthalmicThicknessMapSeriesModule

public OphthalmicThicknessMapSeriesModule getOphthalmicThicknessMapSeriesModule()

Retrieves pre-initialized instance of OphthalmicThicknessMapSeriesModule. 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:

OphthalmicThicknessMapSeriesModule - instance of OphthalmicThicknessMapSeriesModule.

getEnhancedGeneralEquipmentModule

public EnhancedGeneralEquipmentModule getEnhancedGeneralEquipmentModule()

Retrieves pre-initialized instance of Enhanced General Equipment 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:

EnhancedGeneralEquipmentModule - instance of EnhancedGeneralEquipmentModule.

getGeneralImageModule

public GeneralImageModule getGeneralImageModule()

Retrieves pre-initialized instance of GeneralImageModule. 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:

GeneralImageModule - instance of GeneralImageModule.

getSupplementalPaletteColorLookupTableModule

public SupplementalPaletteColorLookupTableModule getSupplementalPaletteColorLookupTableModule()

Retrieves pre-initialized instance of Supplemental 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:

SupplementalPaletteColorLookupTableModule - instance of SupplementalPaletteColorLookupTableModule.

getBitmapDisplayShutterModule

public BitmapDisplayShutterModule getBitmapDisplayShutterModule()

Retrieves pre-initialized instance of BitmapDisplayshutterModule. 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:

BitmapDisplayShutterModule - instance of BitmapDisplayShutterModule.

getOphthalmicThicknessMapModule

public OphthalmicThicknessMapModule getOphthalmicThicknessMapModule()

Retrieves pre-initialized instance of OphthalmicThicknessMapModule. 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:

OphthalmicThicknessMapModule - instance of OphthalmicThicknessMapModule.

getOphthalmicThicknessMapQualityRatingModule

public OphthalmicThicknessMapQualityRatingModule getOphthalmicThicknessMapQualityRatingModule()

Retrieves pre-initialized instance of OphthalmicThicknessMapQualityRatingModule. 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:

OphthalmicThicknessMapQualityRatingModule - instance of OphthalmicThicknessMapQualityRatingModule.

getOphthalmicPhotographyAcquisitionParametersModule

public OphthalmicPhotographyAcquisitionParametersModule getOphthalmicPhotographyAcquisitionParametersModule()

Retrieves pre-initialized instance of OphthalmicPhotographyAcquisitionParametersModule. 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:

OphthalmicPhotographyAcquisitionParametersModule - instance of OphthalmicPhotographyAcquisitionParametersModule.

getAcquisitionContextModule

public AcquisitionContextModule getAcquisitionContextModule()

Retrieves pre-initialized instance of Acquisition Context 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:

AcquisitionContextModule - instance of AcquisitionContextModule.

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.

getCommonInstanceReferenceModule

public CommonInstanceReferenceModule getCommonInstanceReferenceModule()

Retrieves pre-initialized instance of objCommon Instance Reference 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:

CommonInstanceReferenceModule - instance of CommonInstanceReferenceModule.

validate

public boolean validate()
                 throws InvalidIODException

This method validates OphthalmicThicknessMapIOD 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 ImageIOD

Returns:

boolean - function status indicating success or failure.

Throws:

InvalidIODException - - throws when IOD is invalid.

dumpDICOMInfo

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

Dumps the Name of IOD,Module and corresponding Attributes of Module.

Overrides:

dumpDICOMInfo in class ImageIOD

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 ImageIOD

Parameters:

strModuleName - String value of module name

Returns:

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