cdac.medinfo.sdk.dcm30_04.dicommodel.xray

Class XRay3DCraniofacialImageIOD

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.xray.XRay3DCraniofacialImageIOD

public class XRay3DCraniofacialImageIOD
extends ImageIOD

This class defines the Information Object for multi-dimensional reconstructed cone beam X-Ray Craniofacial Images and includesthose data elements and information objects necessary for the interchange of Multi-dimensional X-Ray volumes.

Author:

saloni

Constructor Summary

Constructors

Constructor and Description
XRay3DCraniofacialImageIOD() Instantiates a new XRay3DCraniofacialImageIOD.
XRay3DCraniofacialImageIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
XRay3DCraniofacialImageIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
XRay3DCraniofacialImageIOD(ITransferSyntax objITransferSyntax_) null This constructor initializes the TransferSyntax in its superclass IOD.
XRay3DCraniofacialImageIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
XRay3DCraniofacialImageIOD(java.lang.String strFileName) Creates XRay3DCraniofacialImageIOD from a DICOM file containing XRayAngiografic 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.
AcquisitionContextModule	getAcquisitionContextModule() Retrieves pre-initialized instance of Acquisition Context Module.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of Common Instance Reference Module.
DeviceModule	getDeviceModule() Retrieves pre-initialized instance of Device Module.
EnhancedContrastBolusModule	getEnhancedContrastBolusModule() Retrieves pre-initialized instance of Enhanced Contrast/Bolus Module.
EnhancedGeneralEquipmentModule	getEnhancedGeneralEquipmentModule() Retrieves pre-initialized instance of Enhanced General Equipment Module.
EnhancedSeriesModule	getEnhancedSeriesModule() Retrieves pre-initialized instance of Enhanced Series Module.
FrameExtractionModule	getFrameExtractionModule() Retrieves pre-initialized instance of Frame Extraction Module.
FrameOfReferenceModule	getFrameOfReferenceModule() Retrieves pre-initialized instance of Frame of Reference Module.
ImageEquipmentCoordinateRelationshipModule	getImageEquipmentCoordinateRelationshipModule() Retrieves pre-initialized instance of Image - Equipment Coordinate Relationship Module.
InterventionModule	getInterventionModule() Retrieves pre-initialized instance of Intervention Module.
MultiFrameDimensionModule	getMultiFrameDimensionModule() Retrieves pre-initialized instance of Multi-frame Dimension Groups Module.
MultiFrameFunctionalGroupsModule	getMultiFrameFunctionalGroupsModule() Retrieves pre-initialized instance of Multi-frame Functional Groups Module.
PatientOrientationModule	getPatientOrientationModule() Retrieves pre-initialized instance of Patient Orientation Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
SpecimenModule	getSpecimenModule() Retrieves pre-initialized instance of Specimen Module.
XRay3DCraniofacialAcquisitionModule	getXRay3DCraniofacialAcquisitionModule() Retrieves pre-initialized instance of X-Ray 3D Craniofacial Acquisition Module.
XRay3DCraniofacialImageContributingSourcesModule	getXRay3DCraniofacialImageContributingSourcesModule() Retrieves pre-initialized instance of X-Ray 3D Craniofacial Image ContributingSources Module.
XRay3DImageModule	getXRay3DImageModule() Retrieves pre-initialized instance of X-Ray 3D Image Module.
XRay3DReconstructionModule	getXRay3DReconstructionModule() Retrieves pre-initialized instance of X-Ray 3D Reconstruction Module.
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

XRay3DCraniofacialImageIOD

public XRay3DCraniofacialImageIOD()

Instantiates a new XRay3DCraniofacialImageIOD.

XRay3DCraniofacialImageIOD

public XRay3DCraniofacialImageIOD(ITransferSyntax objITransferSyntax_)

null This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

XRay3DCraniofacialImageIOD

public XRay3DCraniofacialImageIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

XRay3DCraniofacialImageIOD

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

XRay3DCraniofacialImageIOD

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

XRay3DCraniofacialImageIOD

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

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

getEnhancedSeriesModule

public EnhancedSeriesModule getEnhancedSeriesModule()

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

EnhancedSeriesModule - instance of EnhancedSeriesModule.

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.

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.

getEnhancedContrastBolusModule

public EnhancedContrastBolusModule getEnhancedContrastBolusModule()

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

EnhancedContrastBolusModule - instance of EnhancedContrastBolusModule.

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.

getInterventionModule

public InterventionModule getInterventionModule()

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

InterventionModule - instance of InterventionModule.

getAcquisitionContextModule

public AcquisitionContextModule getAcquisitionContextModule()

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

AcquisitionContextModule - instance of AcquisitionContextModule.

getMultiFrameFunctionalGroupsModule

public MultiFrameFunctionalGroupsModule getMultiFrameFunctionalGroupsModule()

Retrieves pre-initialized instance of Multi-frame Functional Groups 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:

MultiFrameFunctionalGroupsModule - instance of MultiFrameFunctionalGroupsModule.

getMultiFrameDimensionModule

public MultiFrameDimensionModule getMultiFrameDimensionModule()

Retrieves pre-initialized instance of Multi-frame Dimension Groups 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:

MultiFrameDimensionModule - instance of MultiFrameDimensionModule.

getPatientOrientationModule

public PatientOrientationModule getPatientOrientationModule()

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

PatientOrientationModule - instance of PatientOrientationModule.

getImageEquipmentCoordinateRelationshipModule

public ImageEquipmentCoordinateRelationshipModule getImageEquipmentCoordinateRelationshipModule()

Retrieves pre-initialized instance of Image - Equipment Coordinate Relationship 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:

ImageEquipmentCoordinateRelationshipModule - instance of ImageEquipmentCoordinateRelationshipModule.

getSpecimenModule

public SpecimenModule getSpecimenModule()

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

SpecimenModule - instance of SpecimenModule.

getXRay3DImageModule

public XRay3DImageModule getXRay3DImageModule()

Retrieves pre-initialized instance of X-Ray 3D 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:

XRay3DImageModule - instance of XRay3DImageModule.

getXRay3DCraniofacialImageContributingSourcesModule

public XRay3DCraniofacialImageContributingSourcesModule getXRay3DCraniofacialImageContributingSourcesModule()

Retrieves pre-initialized instance of X-Ray 3D Craniofacial Image ContributingSources 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:

XRay3DCraniofacialImageContributingSourcesModule - instance of XRay3DCraniofacialImageContributingSourcesModule.

getXRay3DCraniofacialAcquisitionModule

public XRay3DCraniofacialAcquisitionModule getXRay3DCraniofacialAcquisitionModule()

Retrieves pre-initialized instance of X-Ray 3D Craniofacial Acquisition 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:

XRay3DCraniofacialAcquisitionModule - instance of XRay3DCraniofacialAcquisitionModule.

getXRay3DReconstructionModule

public XRay3DReconstructionModule getXRay3DReconstructionModule()

Retrieves pre-initialized instance of X-Ray 3D Reconstruction 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:

XRay3DReconstructionModule - instance of XRay3DReconstructionModule.

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.

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:

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

objFrameExtractionModule - instance of FrameExtractionModule.

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.