cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class ImageIOD

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

Direct Known Subclasses:

BreastTomosynthesisImageIOD, CornealTopographyMapIOD, CRIOD, CTIOD, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayIOD, EnhancedCTIOD, EnhancedMRColorImageIOD, EnhancedMRImageIOD, EnhancedPETImageIOD, EnhancedUSVolumeIOD, EnhancedXRayAngiographicImageIOD, EnhancedXRayRFImageIOD, HardcopyColorImageIOD, HardcopyGrayscaleImageIOD, IntravascularOCTIOD, LegacyConvertedEnhancedCTImageIOD, LegacyConvertedEnhancedMRImageIOD, LegacyConvertedEnhancedPETImageIOD, MRIOD, MultiFrameGrayscaleByteSCImageIOD, MultiFrameGrayscaleWordSCImageIOD, MultiFrameSingleBitSCImageIOD, MultiFrameTrueColorSCImageIOD, NMIOD, OphthalmicPhotography16BitIOD, OphthalmicPhotography8BitIOD, OphthalmicThicknessMapIOD, OphthalmicTomographyImageIOD, ParametricMapIOD, PETIOD, RTImageIOD, SCIOD, USIOD, USMultiFrameIOD, VideoEndoscopicIOD, VideoMicroscopicIOD, VideoPhotographicIOD, VLEndoscopicIOD, VLMicroscopicIOD, VLPhotographicIOD, VLSlideCoordinatesMicroscopicIOD, VLWholeSlideMicroscopyImageIOD, WideFieldOphthalmicPhotography3DCoordinatesImageIOD, WideFieldOphthalmicPhotographyStereographicProjectionImageIOD, XAImageIOD, XAOrXRFGrayscaleSoftcopyPresentationStateIOD, XRay3DAngiographicImageIOD, XRay3DCraniofacialImageIOD, XRayAngiographicIOD, XRayRadiationDoseSRIOD, XRFImageIOD

public abstract class ImageIOD
extends CompositeIOD

This class is the Base Class for all the IODs that contain image related Attributes. It contains the methods for getting the common Modules for the Image IOD.

Constructor Summary

Constructors

Constructor and Description
ImageIOD() Instantiates a new image iod.
ImageIOD(IDataSet objIDataSet_) This constructor accepts the Data set from the user in its superclass IOD.
ImageIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes DictionaryReader in its superclass IOD.
ImageIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
ImageIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor accepts the DictionaryReader and TransferSyntax from the user in its superclass IOD.
ImageIOD(java.lang.String strFileName) Creates IOD from a DICOM file containing corresponding DICOM data.

Method Summary

Methods

Modifier and Type	Method and Description
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the Name of Module and corresponding Attributs of IOD.
ClinicalTrialSeriesModule	getClinicalTrialSeriesModule() Gets the clinical trial series module.
GeneralEquipmentModule	getGeneralEquipmentModule() This method returns the GeneralEquipmentModule with preinitializing it.
GeneralSeriesModule	getGeneralSeriesModule() This method returns the GeneralSeriesModule with preinitializing it.
GeneralStudyModule	getGeneralStudyModule() This method returns the GeneralStudyModule with preinitializing it.
ImagePixelModule	getImagePixelModule() This method returns the ImagePixelModule with preinitializing it.
PatientModule	getPatientModule() This method returns the PatientModule with preinitializing it.
PatientStudyModule	getPatientStudyModule() This method returns the PatientStudyModule with preinitializing it.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates Image IOD according to the Module Table given in The DICOM Standard.

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

ImageIOD

public ImageIOD()

Instantiates a new image iod.

ImageIOD

public ImageIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - Transfer Syntax of IOD.

ImageIOD

public ImageIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes DictionaryReader in its superclass IOD.

Parameters:

objIDictionaryReader_ - Dictionary Reader used by the IOD.

ImageIOD

public ImageIOD(ITransferSyntax objITransferSyntax_,
        IDictionaryReader objIDictionaryReader_)

This constructor accepts the DictionaryReader and TransferSyntax from the user in its superclass IOD.

Parameters:

objITransferSyntax_ - Transfer Syntax of IOD.

objIDictionaryReader_ - Dictionary Reader used by the IOD.

ImageIOD

public ImageIOD(IDataSet objIDataSet_)

This constructor accepts the Data set from the user in its superclass IOD.

Parameters:

objIDataSet_ - the obj i data set_

ImageIOD

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

Creates IOD from a DICOM file containing corresponding DICOM data.

Parameters:

strFileName - DICOM File with absolute path.

Throws:

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

ParseException - signals if some parse exceptions occurred.

InvalidIODException

Method Detail

getPatientModule

public PatientModule getPatientModule()

This method returns the PatientModule with preinitializing it.

Returns:

the patient module

getGeneralStudyModule

public GeneralStudyModule getGeneralStudyModule()

This method returns the GeneralStudyModule with preinitializing it.

Returns:

the general study module

getPatientStudyModule

public PatientStudyModule getPatientStudyModule()

This method returns the PatientStudyModule with preinitializing it.

Returns:

the patient study module

getClinicalTrialSeriesModule

public ClinicalTrialSeriesModule getClinicalTrialSeriesModule()

Gets the clinical trial series module.

Returns:

the clinical trial series module

getGeneralSeriesModule

public GeneralSeriesModule getGeneralSeriesModule()

This method returns the GeneralSeriesModule with preinitializing it.

Returns:

the general series module

getGeneralEquipmentModule

public GeneralEquipmentModule getGeneralEquipmentModule()

This method returns the GeneralEquipmentModule with preinitializing it.

Returns:

the general equipment module

getImagePixelModule

public ImagePixelModule getImagePixelModule()

This method returns the ImagePixelModule with preinitializing it.

Returns:

the image pixel module

validate

public boolean validate()
                 throws InvalidIODException

This method validates 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 CompositeIOD

Returns:

- status of validation as success or failure

Throws:

InvalidIODException - the invalid iod exception

dumpDICOMInfo

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

Dumps the Name of Module and corresponding Attributs of IOD.

Overrides:

dumpDICOMInfo in class CompositeIOD

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 CompositeIOD

Parameters:

strModuleName - String value of module name

Returns:

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