cdac.medinfo.sdk.dcm30_04.dicommodel.rt

Class RTStructureSetIOD

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

public class RTStructureSetIOD
extends NonImageIOD

The focus for this Radiotherapy Structure Set IOD (RT Structure Set IOD) is to address the requirements for transfer of patient structures and related data defined on CT scanners, virtual simulation workstations, treatment planning systems and similar devices. This IOD may also contain audio curve annotations.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RTStructureSetIOD() Instantiates a new rT structure set iod.
RTStructureSetIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
RTStructureSetIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
RTStructureSetIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
RTStructureSetIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
RTStructureSetIOD(java.lang.String strFileName) Creates RTStructureSetIOD IOD from a DICOM file containing RTStructureSetIOD 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.
ClinicalTrialSeriesModule	getClinicalTrialSeriesModule() Retrieves pre-initialized instance of Clinical Trial Series Module.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of Common Instance Reference Module.
GeneralEquipmentModule	getGeneralEquipmentModule() Retrieves pre-initialized instance of General Equipment Module.
GeneralStudyModule	getGeneralStudyModule() Retrieves pre-initialized instance of General Study Module.
static java.lang.String	getINVALID_RT_STRUCTURE_SET_IOD() Gets the iNVALI d_ r t_ structur e_ se t_ iod.
ModalityLUTModule	getModalityLUTModule() Retrieves pre-initialized instance of Modality LUT 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.
RTROIObservationsModule	getRTROIObservationsModule() Retrieves pre-initialized instance of RT ROI Observations 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 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_STRUCTURE_SET_IOD

public static final java.lang.String RT_STRUCTURE_SET_IOD

The Constant RT_STRUCTURE_SET_IOD.

See Also:

Constant Field Values

Constructor Detail

RTStructureSetIOD

public RTStructureSetIOD()

Instantiates a new rT structure set iod.

RTStructureSetIOD

public RTStructureSetIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

RTStructureSetIOD

public RTStructureSetIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

RTStructureSetIOD

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

RTStructureSetIOD

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

RTStructureSetIOD

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

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

validate

public boolean validate()
                 throws InvalidIODException

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

Returns:

boolean - status of validation as success or failure

Throws:

InvalidIODException - - throws when the IOD is invalid.

getINVALID_RT_STRUCTURE_SET_IOD

public static java.lang.String getINVALID_RT_STRUCTURE_SET_IOD()

Gets the iNVALI d_ r t_ structur e_ se t_ iod.

Returns:

the iNVALI d_ r t_ structur e_ se t_ iod

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.

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.

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.

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.

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.

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.

getRTROIObservationsModule

public RTROIObservationsModule getRTROIObservationsModule()

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

RTROIObservationsModule - instance of RTROIObservationsModule.

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.

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.

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.

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.