cdac.medinfo.sdk.dcm30_04.dicommodel.surfacescan

Class SurfaceScanMeshIOD

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.IOD

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.NormalizedIOD

cdac.medinfo.sdk.dcm30_04.dicommodel.surfacescan.SurfaceScanMeshIOD

public class SurfaceScanMeshIOD
extends NormalizedIOD

The Surface Scan Mesh IOD specifies a triangulated surface generated by an optical surface scanner or a 3D post-processing application.

Author:

saloni

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SURFACE_SCAN_MESH_IOD

Fields inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.NormalizedIOD

NORMALIZED_IOD

Constructor Summary

Constructors

Constructor and Description
SurfaceScanMeshIOD() Instantiates a new SurfaceScanMeshIOD
SurfaceScanMeshIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
SurfaceScanMeshIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
SurfaceScanMeshIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
SurfaceScanMeshIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
SurfaceScanMeshIOD(java.lang.String strFileName) Creates SurfaceScanMeshIOD IOD from a DICOM file containing SurfaceScanMeshIOD 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.
ClinicalTrialSeriesModule	getClinicalTrialSeriesModule() Retrieves pre-initialized instance of ClinicalTrialSeriesModule.
ClinicalTrialStudyModule	getClinicalTrialStudyModule() This method returns the ClinicalTrialStudyModule with preinitializing it.
ClinicalTrialSubjectModule	getClinicalTrialSubjectModule() Retrieves pre-initialized instance of ClinicalTrialSubjectModule.
EnhancedGeneralEquipmentModule	getEnhancedGeneralEquipmentModule() Retrieves pre-initialized instance of Frame Of Reference Module.
GeneralEquipmentModule	getGeneralEquipmentModule() Retrieves pre-initialized instance of GeneralEquipmentModule.
GeneralSeriesModule	getGeneralSeriesModule() Retrieves pre-initialized instance of GeneralSeriesModule.
GeneralStudyModule	getGeneralStudyModule() Retrieves pre-initialized instance of GeneralStudyModule.
OpticalSurfaceScannerSeriesModule	getOpticalSurfaceScannerSeriesModule() Retrieves pre-initialized instance of RT Series Module.
PatientModule	getPatientModule() Retrieves pre-initialized instance of PatientModule.
PatientStudyModule	getPatientStudyModule() Retrieves pre-initialized instance of PatientStudyModule.
ScanProcedureModule	getScanProcedureModule() Retrieves pre-initialized instance of RT Ion Tolerance Tables Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
SpecimenModule	getSpecimenModule() Retrieves pre-initialized instance of RT Patient Setup Module.
SurfaceMeshModule	getSurfaceMeshModule() Retrieves pre-initialized instance of GeneralEquipmentModule.
UVMappingModule	getUVMappingModule() Retrieves pre-initialized instance of RT Prescription Module.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates SURFACE_SCAN_MESH_IOD according to the Module Table given in The DICOM Standard.

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

SURFACE_SCAN_MESH_IOD

public static final java.lang.String SURFACE_SCAN_MESH_IOD

See Also:

Constant Field Values

Constructor Detail

SurfaceScanMeshIOD

public SurfaceScanMeshIOD()

Instantiates a new SurfaceScanMeshIOD

SurfaceScanMeshIOD

public SurfaceScanMeshIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

SurfaceScanMeshIOD

public SurfaceScanMeshIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

SurfaceScanMeshIOD

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

SurfaceScanMeshIOD

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

SurfaceScanMeshIOD

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

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

getPatientModule

public PatientModule getPatientModule()

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

getClinicalTrialSubjectModule

public ClinicalTrialSubjectModule getClinicalTrialSubjectModule()

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

ClinicalTrialSubjectModule - instance of ClinicalTrialSubjectModule.

getGeneralSeriesModule

public GeneralSeriesModule getGeneralSeriesModule()

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

GeneralSeriesModule - instance of GeneralSeriesModule.

getClinicalTrialSeriesModule

public ClinicalTrialSeriesModule getClinicalTrialSeriesModule()

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

getGeneralStudyModule

public GeneralStudyModule getGeneralStudyModule()

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

getPatientStudyModule

public PatientStudyModule getPatientStudyModule()

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

getClinicalTrialStudyModule

public ClinicalTrialStudyModule getClinicalTrialStudyModule()

This method returns the ClinicalTrialStudyModule with preinitializing it.

Returns:

the clinical trial study module

getOpticalSurfaceScannerSeriesModule

public OpticalSurfaceScannerSeriesModule getOpticalSurfaceScannerSeriesModule()

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:

- instance of OpticalSurfaceScannerSeriesModule.

getEnhancedGeneralEquipmentModule

public EnhancedGeneralEquipmentModule getEnhancedGeneralEquipmentModule()

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:

EnhancedGeneralEquipmentModule - instance of EnhancedGeneralEquipmentModule.

getGeneralEquipmentModule

public GeneralEquipmentModule getGeneralEquipmentModule()

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

getSurfaceMeshModule

public SurfaceMeshModule getSurfaceMeshModule()

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

SurfaceMeshModule - instance of SurfaceMeshModule.

getUVMappingModule

public UVMappingModule getUVMappingModule()

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

UVMappingModule - instance of UVMappingModule.

getScanProcedureModule

public ScanProcedureModule getScanProcedureModule()

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

ScanProcedureModule - instance of ScanProcedureModule.

getSpecimenModule

public SpecimenModule getSpecimenModule()

Retrieves pre-initialized instance of RT Patient Setup 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 SpecimenModule.

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.

validate

public boolean validate()
                 throws InvalidIODException

This method validates SURFACE_SCAN_MESH_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 IOD

Returns:

- 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 Attributes of Module.

Overrides:

dumpDICOMInfo in class NormalizedIOD

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 NormalizedIOD

Parameters:

strModuleName - String value of module name

Returns:

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