cdac.medinfo.sdk.dcm30_04.dicommodel.rt

Class RTDoseIOD

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

cdac.medinfo.sdk.dcm30_04.dicommodel.rt.RTDoseIOD

public class RTDoseIOD
extends NonImageIOD

The focus for this Radiotherapy Dose IOD (RT Dose IOD) is to address the requirements for transfer of dose distributions calculated by radiotherapy treatment planning systems. These distributions may be represented as 2D or 3D grids, as isodose curves, or as named or unnamed dose points scattered throughout the volume. This IOD may also contain dose-volume histogram data, single or multi-frame overlays, audio annotations, and application-defined lookup tables. This IOD does not provide for definition of doses in beam or other coordinate systems. The application is responsible for transforming data in other, non-patient based coordinate systems to the patient based coordinate system described in C.7.6.2.1.1.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RTDoseIOD() Instantiates a new rT dose iod.
RTDoseIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
RTDoseIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
RTDoseIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
RTDoseIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
RTDoseIOD(java.lang.String strFileName) Creates RTDoseIOD IOD from a DICOM file containing RTDoseIOD 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.
ClinicalTrialSeriesModule	getClinicalTrialSeriesModule() Retrieves pre-initialized instance of Clinical Trial Series Module.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of Common Instance Reference Module.
FrameExtractionModule	getFrameExtractionModule() Retrieves pre-initialized instance of Frame Extraction Module .
FrameOfReferenceModule	getFrameOfReferenceModule() Retrieves pre-initialized instance of Frame Of Reference Module.
GeneralEquipmentModule	getGeneralEquipmentModule() Retrieves pre-initialized instance of General Equipment Module.
GeneralImageModule	getGeneralImageModule() Retrieves pre-initialized instance of General Image Module.
GeneralStudyModule	getGeneralStudyModule() Retrieves pre-initialized instance of General Study Module.
ImagePixelModule	getImagePixelModule() Retrieves pre-initialized instance of Image Pixel Module.
ImagePlaneModule	getImagePlaneModule() Retrieves pre-initialized instance of Image Plane Module.
ModalityLUTModule	getModalityLUTModule() Retrieves pre-initialized instance of Modality LUT Module.
MultiFrameModule	getMultiFrameModule() Retrieves pre-initialized instance of Multi Frame Module .
MultiFrameOverlayModule	getMultiFrameOverlayModule() Retrieves pre-initialized instance of Multi Frame Overlay Module .
OverlayPlaneModule	getOverlayPlaneModule() Retrieves pre-initialized instance of Overlay Plane Module.
PatientModule	getPatientModule() Retrieves pre-initialized instance of Patient Module.
PatientStudyModule	getPatientStudyModule() Retrieves pre-initialized instance of Patient Study Module.
ROIContourModule	getROIContourModule() Retrieves pre-initialized instance of ROI Contour Module .
RTDoseModule	getRTDoseModule() Retrieves pre-initialized instance of RT Dose Module .
RTDoseROIModule	getRTDoseROIModule() Retrieves pre-initialized instance of RT Dose ROI Module .
RTDVHModule	getRTDVHModule() Retrieves pre-initialized instance of RT DVH Module .
RTSeriesModule	getRTSeriesModule() Retrieves pre-initialized instance of RT Series Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
StructureSetModule	getStructureSetModule() Retrieves pre-initialized instance of Structure Set Module .
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates Non-Image IOD RTDoseIOD 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

Field Detail

RT_DOSE_IOD

public static final java.lang.String RT_DOSE_IOD

The Constant RT_DOSE_IOD.

See Also:

Constant Field Values

Constructor Detail

RTDoseIOD

public RTDoseIOD()

Instantiates a new rT dose iod.

RTDoseIOD

public RTDoseIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

RTDoseIOD

public RTDoseIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

RTDoseIOD

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

RTDoseIOD

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

RTDoseIOD

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

Creates RTDoseIOD IOD from a DICOM file containing RTDoseIOD 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 Clinical Trial 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:

ClinicalTrialSeriesModule - instance of ClinicalTrialSeriesModule.

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.

getGeneralEquipmentModule

public GeneralEquipmentModule getGeneralEquipmentModule()

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

GeneralEquipmentModule - instance of GeneralEquipmentModule.

getGeneralStudyModule

public GeneralStudyModule getGeneralStudyModule()

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

GeneralStudyModule - instance of GeneralStudyModule.

getPatientModule

public PatientModule getPatientModule()

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

PatientModule - instance of PatientModule.

getPatientStudyModule

public PatientStudyModule getPatientStudyModule()

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

PatientStudyModule - instance of PatientStudyModule.

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.

getRTSeriesModule

public RTSeriesModule getRTSeriesModule()

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

RTSeriesModule - instance of RTSeriesModule.

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.

getImagePlaneModule

public ImagePlaneModule getImagePlaneModule()

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

ImagePlaneModule - instance of ImagePlaneModule.

getModalityLUTModule

public ModalityLUTModule getModalityLUTModule()

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

ModalityLUTModule - instance of ModalityLUTModule.

getOverlayPlaneModule

public OverlayPlaneModule getOverlayPlaneModule()

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

OverlayPlaneModule - instance of OverlayPlaneModule.

getImagePixelModule

public ImagePixelModule getImagePixelModule()

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

ImagePixelModule - instance of ImagePixelModule.

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.

getMultiFrameOverlayModule

public MultiFrameOverlayModule getMultiFrameOverlayModule()

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

MultiFrameOverlayModule - instance of MultiFrameOverlayModule.

getRTDoseModule

public RTDoseModule getRTDoseModule()

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

RTDoseModule- instance of RTDoseModule.

getRTDVHModule

public RTDVHModule getRTDVHModule()

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

RTDVHModule - instance of RTDVHModule.

getROIContourModule

public ROIContourModule getROIContourModule()

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

ROIContourModule - instance of ROIContourModule.

getRTDoseROIModule

public RTDoseROIModule getRTDoseROIModule()

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

RTDoseROIModule - instance of RTDoseROIModule.

getStructureSetModule

public StructureSetModule getStructureSetModule()

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

StructureSetModule - instance of StructureSetModule.

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:

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

- instance of FrameExtractionModule.

validate

public boolean validate()
                 throws InvalidIODException

This method validates Non-Image IOD RTDoseIOD 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 NonImageIOD

Returns:

boolean - status of validation as 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 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 NonImageIOD

Parameters:

strModuleName - String value of module name

Returns:

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