cdac.medinfo.sdk.dcm30_04.dicommodel.rt

Class RTImageIOD

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.rt.RTImageIOD

public class RTImageIOD
extends ImageIOD

The focus for this Radiotherapy Image IOD (RT Image IOD) is to address the requirements for image transfer found in general radiotherapy applications performed on conventional simulators, virtual simulators, and portal imaging devices.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RTImageIOD() Instantiates a new rT image iod.
RTImageIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
RTImageIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
RTImageIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
RTImageIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
RTImageIOD(java.lang.String strFileName) Creates RTImageIOD IOD from a DICOM file containing RTImageIOD 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.
ApprovalModule	getApprovalModule() Retrieves pre-initialized instance of Approval Module.
CineModule	getCineModule() Retrieves pre-initialized instance of Cine Module.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of Common Instance Reference Module.
ContrastBolusModule	getContrastBolusModule() Retrieves pre-initialized instance of Contrast Bolus Module.
DeviceModule	getDeviceModule() Retrieves pre-initialized instance of Device Module.
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.
ModalityLUTModule	getModalityLUTModule() Retrieves pre-initialized instance of Modality LUT Module.
MultiFrameModule	getMultiFrameModule() Retrieves pre-initialized instance of Multi Frame Module.
RTImageModule	getRTImageModule() Retrieves pre-initialized instance of RT Image Module.
RTSeriesModule	getRTSeriesModule() Retrieves pre-initialized instance of RT Series Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
VOILUTModule	getVOILUTModule() Retrieves pre-initialized instance of VOI LUT Module.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates RT 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

RT_IMAGE_IOD

public static final java.lang.String RT_IMAGE_IOD

The Constant RT_IMAGE_IOD.

See Also:

Constant Field Values

Constructor Detail

RTImageIOD

public RTImageIOD()

Instantiates a new rT image iod.

RTImageIOD

public RTImageIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

RTImageIOD

public RTImageIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

RTImageIOD

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

RTImageIOD

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

RTImageIOD

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

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

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.

getApprovalModule

public ApprovalModule getApprovalModule()

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

ApprovalModule - instance of ApprovalModule.

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.

getContrastBolusModule

public ContrastBolusModule getContrastBolusModule()

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.

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.

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.

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.

getRTImageModule

public RTImageModule getRTImageModule()

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

RTImageModule - instance of RTImageModule.

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.

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.

getVOILUTModule

public VOILUTModule getVOILUTModule()

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

VOILUTModule - instance of VOILUTModule.

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

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