cdac.medinfo.sdk.dcm30_04.dicommodel.ophthalmic

Class OphthalmicTomographyImageIOD

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

public class OphthalmicTomographyImageIOD
extends ImageIOD

The Ophthalmic Tomography Image IOD specifies a single-frame or a multi-frame image acquired on an Ophthalmic Tomographymodality. This IOD can be used to encode both single and multi-frame ophthalmic images.

Author:

saloni

Constructor Summary

Constructors

Constructor and Description
OphthalmicTomographyImageIOD() Instantiates a new OphthalmicTomographyImageIOD.
OphthalmicTomographyImageIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
OphthalmicTomographyImageIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
OphthalmicTomographyImageIOD(ITransferSyntax objITransferSyntax_) null This constructor initializes the TransferSyntax in its superclass IOD.
OphthalmicTomographyImageIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
OphthalmicTomographyImageIOD(java.lang.String strFileName) Creates OphthalmicTomographyImageIOD from a DICOM file containing OphthalmicTomographyImageIOD 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.
CardiacSynchronizationModule	getCardiacSynchronizationModule() Retrieves pre-initialized instance of Cardiac Synchronization Module.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of Common Instance Reference Module.
EnhancedContrastBolusModule	getEnhancedContrastBolusModule() Retrieves pre-initialized instance of Enhanced Contrast/Bolus Module.
EnhancedGeneralEquipmentModule	getEnhancedGeneralEquipmentModule() Retrieves pre-initialized instance of Enhanced General Equipment Module.
FrameExtractionModule	getFrameExtractionModule() Retrieves pre-initialized instance of Frame Extraction Module.
FrameOfReferenceModule	getFrameOfReferenceModule() Retrieves pre-initialized instance of Frame of Reference Module.
MultiFrameDimensionModule	getMultiFrameDimensionModule() Retrieves pre-initialized instance of Multi-frame Dimension Groups Module.
MultiFrameFunctionalGroupsModule	getMultiFrameFunctionalGroupsModule() Retrieves pre-initialized instance of Multi-frame Functional Groups Module.
OcularRegionImagedModule	getOcularRegionImagedModule() Retrieves pre-initialized instance of OcularRegionImagedModule.
OphthalmicTomographyAcquisitionParametersModule	getOphthalmicTomographyAcquisitionParametersModule() Retrieves pre-initialized instance of OphthalmicTomographyAcquisitionParametersModule.
OphthalmicTomographyImageModule	getOphthalmicTomographyImageModule() Retrieves pre-initialized instance of OphthalmicTomographyImageModule.
OphthalmicTomographyParametersModule	getOphthalmicTomographyParametersModule() Retrieves pre-initialized instance of OphthalmicTomographyParametersModule.
OphthalmicTomographySeriesModule	getOphthalmicTomographySeriesModule() Retrieves pre-initialized instance ofOphthalmicTomographySeriesModule.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
SynchronizationModule	getSynchronizationModule() Retrieves pre-initialized instance of SynchronizationModule.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates OphthalmicTomographyImageIOD 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

OphthalmicTomographyImageIOD

public OphthalmicTomographyImageIOD()

Instantiates a new OphthalmicTomographyImageIOD.

OphthalmicTomographyImageIOD

public OphthalmicTomographyImageIOD(ITransferSyntax objITransferSyntax_)

null This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

OphthalmicTomographyImageIOD

public OphthalmicTomographyImageIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

OphthalmicTomographyImageIOD

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

OphthalmicTomographyImageIOD

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

OphthalmicTomographyImageIOD

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

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

getOphthalmicTomographySeriesModule

public OphthalmicTomographySeriesModule getOphthalmicTomographySeriesModule()

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

OphthalmicTomographySeriesModule - instance of OphthalmicTomographySeriesModule.

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.

getEnhancedContrastBolusModule

public EnhancedContrastBolusModule getEnhancedContrastBolusModule()

Retrieves pre-initialized instance of Enhanced Contrast/Bolus 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:

EnhancedContrastBolusModule - instance of EnhancedContrastBolusModule.

getSynchronizationModule

public SynchronizationModule getSynchronizationModule()

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

SynchronizationModule - instance of SynchronizationModule.

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.

getMultiFrameFunctionalGroupsModule

public MultiFrameFunctionalGroupsModule getMultiFrameFunctionalGroupsModule()

Retrieves pre-initialized instance of Multi-frame Functional Groups 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:

MultiFrameFunctionalGroupsModule - instance of MultiFrameFunctionalGroupsModule.

getMultiFrameDimensionModule

public MultiFrameDimensionModule getMultiFrameDimensionModule()

Retrieves pre-initialized instance of Multi-frame Dimension Groups 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:

MultiFrameDimensionModule - instance of MultiFrameDimensionModule.

getCardiacSynchronizationModule

public CardiacSynchronizationModule getCardiacSynchronizationModule()

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

CardiacSynchronizationModule - instance of CardiacSynchronizationModule.

getOphthalmicTomographyImageModule

public OphthalmicTomographyImageModule getOphthalmicTomographyImageModule()

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

OphthalmicTomographyImageModule - instance of OphthalmicTomographyImageModule.

getOphthalmicTomographyAcquisitionParametersModule

public OphthalmicTomographyAcquisitionParametersModule getOphthalmicTomographyAcquisitionParametersModule()

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

OphthalmicTomographyAcquisitionParametersModule - instance of OphthalmicTomographyAcquisitionParametersModule.

getOphthalmicTomographyParametersModule

public OphthalmicTomographyParametersModule getOphthalmicTomographyParametersModule()

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

OphthalmicTomographyParametersModule - instance of OphthalmicTomographyParametersModule.

getOcularRegionImagedModule

public OcularRegionImagedModule getOcularRegionImagedModule()

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

OcularRegionImagedModule - instance of OcularRegionImagedModule.

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.

getFrameExtractionModule

public FrameExtractionModule getFrameExtractionModule()

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

objFrameExtractionModule - instance of FrameExtractionModule.

validate

public boolean validate()
                 throws InvalidIODException

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