cdac.medinfo.sdk.dcm30_04.dicommodel.ophthalmic

Class OphthalmicPhotography8BitIOD

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

public class OphthalmicPhotography8BitIOD
extends ImageIOD

The Ophthalmic Photography 8 Bit Image IOD specifies a single-frame or a multi-frame image acquired on a digital photographic DICOM modality. This IOD can be used to encode single ophthalmic images and cine sequences.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the Name of IOD,Module and corresponding Attributs of Module.
AcquisitionContextModule	getAcquisitionContextModule() Retrieves pre-initialized instance of Acquisition Context Module.
CineModule	getCineModule() Retrieves pre-initialized instance of Cine Module.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of objCommon Instance Reference Module.
DeviceModule	getDeviceModule() Retrieves pre-initialized instance of Device Module.
EnhancedContrastBolusModule	getEnhancedContrastBolusModule() Retrieves pre-initialized instance of Enhanced Contrast Bolus Module.
FrameExtractionModule	getFrameExtractionModule() Retrieves pre-initialized instance of Frame Extraction Module.
GeneralImageModule	getGeneralImageModule() Retrieves pre-initialized instance of General Image Module.
ICCProfileModule	getICCProfileModule() Retrieves pre-initialized instance of ICCProfile Module.
MultiFrameModule	getMultiFrameModule() Retrieves pre-initialized instance of Multi Frame Module .
OcularRegionImagedModule	getOcularRegionImagedModule() Retrieves pre-initialized instance of Ocular Region Imaged Module.
OphthalmicPhotographicParametersModule	getOphthalmicPhotographicParametersModule() Retrieves pre-initialized instance of Ophthalmic Photographic Parameters Module.
OphthalmicPhotographyAcquisitionParametersModule	getOphthalmicPhotographyAcquisitionParametersModule() Retrieves pre-initialized instance of Ophthalmic Photography Acquisition Parameters Module.
OphthalmicPhotographyImageModule	getOphthalmicPhotographyImageModule() Retrieves pre-initialized instance of Ophthalmic Photography Image Module.
OphthalmicPhotographySeriesModule	getOphthalmicPhotographySeriesModule() Retrieves pre-initialized instance of Ophthalmic Photography Series Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
SpecimenIdentificationModule	getSpecimenIdentificationModule() Retrieves pre-initialized instance of Specimen Identification Module.
SynchronizationModule	getSynchronizationModule() Retrieves pre-initialized instance of Synchronization Module.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates Ophthalmic Photography 8 Bit Image IOD 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

OPHTHALMIC_PHOTOGRAPHY_8_BIT_IOD

public static final java.lang.String OPHTHALMIC_PHOTOGRAPHY_8_BIT_IOD

The Constant OPHTHALMIC_PHOTOGRAPHY_8_BIT_IOD.

See Also:

Constant Field Values

Constructor Detail

OphthalmicPhotography8BitIOD

public OphthalmicPhotography8BitIOD()

This constructor initializes the DataSet,TransferSyntax and DictionaryReader in its superclass IOD.

OphthalmicPhotography8BitIOD

public OphthalmicPhotography8BitIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

OphthalmicPhotography8BitIOD

public OphthalmicPhotography8BitIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DataSet and DictionaryReader in its superclass IOD.

Parameters:

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

OphthalmicPhotography8BitIOD

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

OphthalmicPhotography8BitIOD

public OphthalmicPhotography8BitIOD(ITransferSyntax objITransferSyntax_,
                            IDictionaryReader objIDictionaryReader_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

objIDictionaryReader_ - the obj i dictionary reader_

OphthalmicPhotography8BitIOD

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

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

validate

public boolean validate()
                 throws InvalidIODException

This method validates Ophthalmic Photography 8 Bit 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 ImageIOD

Returns:

- function status indicating success or failure.

Throws:

InvalidIODException - - this method will throw exception if IOD is invalid.

getCineModule

public CineModule getCineModule()

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

CineModule - instance of CineModule.

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:

objEnhancedContrastBolusModule - instance of EnhancedContrastBolusModule.

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.

getMultiFrameModule

public MultiFrameModule getMultiFrameModule()

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

MultiFrameModule - instance of MultiFrameModule.

getDeviceModule

public DeviceModule getDeviceModule()

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

DeviceModule - instance of DeviceModule.

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:

objAcquisitionContextModule - instance of objAcquisitionContextModule.

getOcularRegionImagedModule

public OcularRegionImagedModule getOcularRegionImagedModule()

Retrieves pre-initialized instance of Ocular Region Imaged 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:

objOcularRegionImagedModule - instance of OcularRegionImagedModule.

getOphthalmicPhotographicParametersModule

public OphthalmicPhotographicParametersModule getOphthalmicPhotographicParametersModule()

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

objOphthalmicPhotographicParametersModule - instance of OphthalmicPhotographicParametersModule.

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:

objOphthalmicPhotographyAcquisitionParametersModule - instance of OphthalmicPhotographyAcquisitionParametersModule.

getOphthalmicPhotographyImageModule

public OphthalmicPhotographyImageModule getOphthalmicPhotographyImageModule()

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

objOphthalmicPhotographyImageModule - instance of OphthalmicPhotographyImageModule.

getOphthalmicPhotographySeriesModule

public OphthalmicPhotographySeriesModule getOphthalmicPhotographySeriesModule()

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

objOphthalmicPhotographySeriesModule - instance of OphthalmicPhotographySeriesModule.

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

getSpecimenIdentificationModule

public SpecimenIdentificationModule getSpecimenIdentificationModule()

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

objSpecimenIdentificationModule - instance of SpecimenIdentificationModule.

getSynchronizationModule

public SynchronizationModule getSynchronizationModule()

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

objSynchronizationModule - instance of SynchronizationModule.

getICCProfileModule

public ICCProfileModule getICCProfileModule()

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

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.

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:

FrameExtractionModule - instance of FrameExtractionModule.

dumpDICOMInfo

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

Dumps the Name of IOD,Module and corresponding Attributs 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.