cdac.medinfo.sdk.dcm30_04.dicommodel.ophthalmic

Class WideFieldOphthalmicPhotographyStereographicProjectionImageIOD

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

public class WideFieldOphthalmicPhotographyStereographicProjectionImageIOD
extends ImageIOD

The Wide Field Ophthalmic Photography Stereographic Projection Image IOD specifies a multi-frame image acquired on a digital photographic DICOM modality.

Author:

saloni

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
WideFieldOphthalmicPhotographyStereographicProjectionImageIOD() Instantiates a new digital intra oral x ray image iod.
WideFieldOphthalmicPhotographyStereographicProjectionImageIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
WideFieldOphthalmicPhotographyStereographicProjectionImageIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
WideFieldOphthalmicPhotographyStereographicProjectionImageIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
WideFieldOphthalmicPhotographyStereographicProjectionImageIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
WideFieldOphthalmicPhotographyStereographicProjectionImageIOD(java.lang.String strFileName) Creates XAImageIOD IOD from a DICOM file containing DigitalIntraOralXRay 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.
ClinicalTrialSeriesModule	getClinicalTrialSeriesModule() Retrieves pre-initialized instance of Contrast Bolus Module.
ClinicalTrialSubjectModule	getClinicalTrialSubjectModule() Retrieves pre-initialized instance of Clinical Trial Subject Module.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of Common Instance Reference Module.
EnhancedContrastBolusModule	getEnhancedContrastBolusModule() Retrieves pre-initialized instance of Contrast Bolus Module.
EnhancedGeneralEquipmentModule	getEnhancedGeneralEquipmentModule() Retrieves pre-initialized instance of SynchronizationModule.
FrameExtractionModule	getFrameExtractionModule() Retrieves pre-initialized instance of Frame Extraction 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 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.
SynchronizationModule	getSynchronizationModule() Retrieves pre-initialized instance of Synchronization Module.
WideFieldOphthalmicPhotographyQualityRatingModule	getWideFieldOphthalmicPhotographyQualityRatingModule() Retrieves pre-initialized instance of Wide Field Ophthalmic Photography Stereographic Projection Module.
WideFieldOphthalmicPhotographyStereographicProjectionModule	getWideFieldOphthalmicPhotographyStereographicProjectionModule() Retrieves pre-initialized instance of Wide Field Ophthalmic Photography Stereographic Projection Module.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates Digital XRay IOD according to the Module Table given in The DICOM Standard.

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

getGeneralEquipmentModule, getGeneralSeriesModule, getGeneralStudyModule, getImagePixelModule, getPatientModule, getPatientStudyModule

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

getClinicalTrialStudyModule

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

WIDE_FIELD_OPHTHALMIC_PHOTOGRAPHY_STEREO_GRAPHIC_PROJECTION_IMAGE_IOD

public static final java.lang.String WIDE_FIELD_OPHTHALMIC_PHOTOGRAPHY_STEREO_GRAPHIC_PROJECTION_IMAGE_IOD

The Constant XAImageIOD.

See Also:

Constant Field Values

Constructor Detail

WideFieldOphthalmicPhotographyStereographicProjectionImageIOD

public WideFieldOphthalmicPhotographyStereographicProjectionImageIOD()

Instantiates a new digital intra oral x ray image iod.

WideFieldOphthalmicPhotographyStereographicProjectionImageIOD

public WideFieldOphthalmicPhotographyStereographicProjectionImageIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

WideFieldOphthalmicPhotographyStereographicProjectionImageIOD

public WideFieldOphthalmicPhotographyStereographicProjectionImageIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

WideFieldOphthalmicPhotographyStereographicProjectionImageIOD

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

WideFieldOphthalmicPhotographyStereographicProjectionImageIOD

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

WideFieldOphthalmicPhotographyStereographicProjectionImageIOD

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

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

getClinicalTrialSeriesModule

public ClinicalTrialSeriesModule getClinicalTrialSeriesModule()

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

Overrides:

getClinicalTrialSeriesModule in class ImageIOD

Returns:

ContrastBolusModule - instance of ContrastBolusModule.

getClinicalTrialSubjectModule

public ClinicalTrialSubjectModule getClinicalTrialSubjectModule()

Retrieves pre-initialized instance of Clinical Trial Subject 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.

Overrides:

getClinicalTrialSubjectModule in class CompositeIOD

Returns:

ClinicalTrialSubjectModule - instance of ClinicalTrialSubjectModule.

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:

OphthalmicPhotographySeriesModule - instance of OphthalmicPhotographySeriesModule.

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:

SynchronizationModule - instance of SynchronizationModule.

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.

getEnhancedContrastBolusModule

public EnhancedContrastBolusModule getEnhancedContrastBolusModule()

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

ContrastBolusModule - instance of ContrastBolusModule.

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.

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:

CineModule - instance of MultiFrameModule.

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 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:

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

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:

OphthalmicPhotographyImageModule - instance of OphthalmicPhotographyImageModule.

getWideFieldOphthalmicPhotographyStereographicProjectionModule

public WideFieldOphthalmicPhotographyStereographicProjectionModule getWideFieldOphthalmicPhotographyStereographicProjectionModule()

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

WideFieldOphthalmicPhotographyStereographicProjectionModule - instance of WideFieldOphthalmicPhotographyStereographicProjectionModule.

getWideFieldOphthalmicPhotographyQualityRatingModule

public WideFieldOphthalmicPhotographyQualityRatingModule getWideFieldOphthalmicPhotographyQualityRatingModule()

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

WideFieldOphthalmicPhotographyStereographicProjectionModule - instance of WideFieldOphthalmicPhotographyStereographicProjectionModule.

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:

OcularRegionImagedModule - instance of OcularRegionImagedModule.

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.

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:

OphthalmicPhotographicParameters - instance of OphthalmicPhotographicParameters.

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.

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 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:

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.

validate

public boolean validate()
                 throws InvalidIODException

This method validates Digital XRay 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 - - throws when the IOD is invalid

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.