cdac.medinfo.sdk.dcm30_04.dicommodel.ophthalmic

Class CornealTopographyMapIOD

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.CornealTopographyMapIOD

public class CornealTopographyMapIOD
extends ImageIOD

The Corneal Topography Map IOD is generated by ophthalmic corneal topography mapping devices, such as reflection-based topographyand elevation-based tomography instruments to generate curvature and/or elevation measurements of corneal anterior and posteriorsurfaces that are presented topographically using a monochromatic image and a pseudo-color map.

Author:

saloni

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
CornealTopographyMapIOD() Instantiates a new CornealTopographyMapIOD.
CornealTopographyMapIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
CornealTopographyMapIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
CornealTopographyMapIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
CornealTopographyMapIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
CornealTopographyMapIOD(java.lang.String strFileName) Creates CornealTopographyMapIOD IOD from a DICOM file containing CornealTopographyMapIOD 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.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of Common Instance Reference Module.
CornealTopographyMapAnalysisModule	getCornealTopographyMapAnalysisModule() Retrieves pre-initialized instance of Corneal Topography Map Analysis Module .
CornealTopographyMapImageModule	getCornealTopographyMapImageModule() Retrieves pre-initialized instance of Corneal Topography Map Image Module.
CornealTopographyMapSeriesModule	getCornealTopographyMapSeriesModule() Retrieves pre-initialized instance of Corneal Topography Map Series Module.
EnhancedGeneralEquipmentModule	getEnhancedGeneralEquipmentModule() Retrieves pre-initialized instance of Enhanced General Equipment Module.
FrameOfReferenceModule	getFrameOfReferenceModule() Retrieves pre-initialized instance of Frame of Reference Module.
GeneralImageModule	getGeneralImageModule() Retrieves pre-initialized instance of General Image Module.
ICCProfileModule	getICCProfileModule() Retrieves pre-initialized instance of ICC Profile Module.
OphthalmicPhotographyAcquisitionParametersModule	getOphthalmicPhotographyAcquisitionParametersModule() Retrieves pre-initialized instance of Ophthalmic Photography Acquisition Parameters Module .
PaletteColorLookupTableModule	getPaletteColorLookupTableModule() Retrieves pre-initialized instance of Palette Color Look up 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 EnhancedMRColorImageIOD Modules 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

Field Detail

CORNEAL_TOPOGRAPHY_MAP_IOD

public static final java.lang.String CORNEAL_TOPOGRAPHY_MAP_IOD

The Constant CORNEAL_TOPOGRAPHY_MAP_IOD.

See Also:

Constant Field Values

Constructor Detail

CornealTopographyMapIOD

public CornealTopographyMapIOD()

Instantiates a new CornealTopographyMapIOD.

CornealTopographyMapIOD

public CornealTopographyMapIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

CornealTopographyMapIOD

public CornealTopographyMapIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

CornealTopographyMapIOD

public CornealTopographyMapIOD(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.

CornealTopographyMapIOD

public CornealTopographyMapIOD(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 .

CornealTopographyMapIOD

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

Creates CornealTopographyMapIOD IOD from a DICOM file containing CornealTopographyMapIOD 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

getFrameOfReferenceModule

public FrameOfReferenceModule getFrameOfReferenceModule()

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

FrameOfReferenceModule - instance of FrameOfReferenceModule.

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.

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.

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.

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:

objSOPCommonModule - instance of objSOPCommonModule.

getCommonInstanceReferenceModule

public CommonInstanceReferenceModule getCommonInstanceReferenceModule()

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

objSOPCommonModule - instance of CommonInstanceReferenceModule.

getCornealTopographyMapSeriesModule

public CornealTopographyMapSeriesModule getCornealTopographyMapSeriesModule()

Retrieves pre-initialized instance of Corneal Topography Map Series 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:

objCornealTopographyMapSeriesModule - instance of CornealTopographyMapSeriesModule.

getGeneralImageModule

public GeneralImageModule getGeneralImageModule()

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

GeneralImageModule - instance of GeneralImageModule.

getPaletteColorLookupTableModule

public PaletteColorLookupTableModule getPaletteColorLookupTableModule()

Retrieves pre-initialized instance of Palette Color Look up 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.

getCornealTopographyMapImageModule

public CornealTopographyMapImageModule getCornealTopographyMapImageModule()

Retrieves pre-initialized instance of Corneal Topography Map Image 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:

CornealTopographyMapImageModule - instance of CornealTopographyMapImageModule.

getCornealTopographyMapAnalysisModule

public CornealTopographyMapAnalysisModule getCornealTopographyMapAnalysisModule()

Retrieves pre-initialized instance of Corneal Topography Map Analysis 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:

CornealTopographyMapAnalysisModule - instance of CornealTopographyMapAnalysisModule.

getOphthalmicPhotographyAcquisitionParametersModule

public OphthalmicPhotographyAcquisitionParametersModule getOphthalmicPhotographyAcquisitionParametersModule()

Retrieves pre-initialized instance of Ophthalmic Photography Acquisition Parameters 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:

OphthalmicPhotographyAcquisitionParametersModule - instance of OphthalmicPhotographyAcquisitionParametersModule.

validate

public boolean validate()
                 throws InvalidIODException

This method validates EnhancedMRColorImageIOD Modules 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.