cdac.medinfo.sdk.dcm30_04.dicommodel.sr

Class XRayRadiationDoseSRIOD

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.sr.XRayRadiationDoseSRIOD

public class XRayRadiationDoseSRIOD
extends ImageIOD

The X-Ray Radiation Dose SR IOD is used to convey the exposure characteristics and dose from X-Rays generated by imaging devices.

Author:

saloni

Constructor Summary

Constructors

Constructor and Description
XRayRadiationDoseSRIOD() Instantiates a new XRay3DCraniofacialImageIOD.
XRayRadiationDoseSRIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
XRayRadiationDoseSRIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
XRayRadiationDoseSRIOD(ITransferSyntax objITransferSyntax_) null This constructor initializes the TransferSyntax in its superclass IOD.
XRayRadiationDoseSRIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
XRayRadiationDoseSRIOD(java.lang.String strFileName) Creates XRayRadiationDoseSRIOD from a DICOM file containing XRayRadiationDoseSRIOD 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.
EnhancedGeneralEquipmentModule	getEnhancedGeneralEquipmentModule() Retrieves pre-initialized instance of Enhanced General Equipment Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
SRDocumentContentModule	getSRDocumentContentModule() Retrieves pre-initialized instance of SRDocumentContentModule.
SRDocumentGeneralModule	getSRDocumentGeneralModule() Retrieves pre-initialized instance of SRDocumentGeneralModule.
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 X-Ray 3D Craniofacial Image IOD 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

Constructor Detail

XRayRadiationDoseSRIOD

public XRayRadiationDoseSRIOD()

Instantiates a new XRay3DCraniofacialImageIOD.

XRayRadiationDoseSRIOD

public XRayRadiationDoseSRIOD(ITransferSyntax objITransferSyntax_)

null This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

XRayRadiationDoseSRIOD

public XRayRadiationDoseSRIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

XRayRadiationDoseSRIOD

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

XRayRadiationDoseSRIOD

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

XRayRadiationDoseSRIOD

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

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

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.

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.

getSRDocumentGeneralModule

public SRDocumentGeneralModule getSRDocumentGeneralModule()

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

SRDocumentGeneralModule - instance of SRDocumentGeneralModule.

getSRDocumentContentModule

public SRDocumentContentModule getSRDocumentContentModule()

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

SRDocumentContentModule - instance of SRDocumentContentModule.

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.

validate

public boolean validate()
                 throws InvalidIODException

This method validates X-Ray 3D Craniofacial Image IOD 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.