cdac.medinfo.sdk.dcm30_04.dicommodel.xray

Class DigitalXRayIOD

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

public class DigitalXRayIOD
extends ImageIOD

The Digital X-Ray (DX) Image Information Object Definition specifies an image that has been created by a digital projection radiography imaging device.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DigitalXRayIOD() Instantiates a new digital x ray iod.
DigitalXRayIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
DigitalXRayIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
DigitalXRayIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
DigitalXRayIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
DigitalXRayIOD(java.lang.String strFileName) Creates DigitalXRayIOD IOD from a DICOM file containing DigitalXRayIOD 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.
AcquisitionContextModule	getAcquisitionContextModule() Retrieves pre-initialized instance of Acquisition Context 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.
DisplayShutterModule	getDisplayShutterModule() Retrieves pre-initialized instance of Display Shutter Module.
DXAnatomyImagedModule	getDXAnatomyImagedModule() Retrieves pre-initialized instance of DX Anatomy Imaged Module.
DXDetectorModule	getDXDetectorModule() Retrieves pre-initialized instance of DX Detector Module.
DXImageModule	getDXImageModule() Retrieves pre-initialized instance of DX Image Module.
DXPositioningModule	getDXPositioningModule() Retrieves pre-initialized instance of DX Positioning Module.
DXSeriesModule	getDXSeriesModule() Retrieves pre-initialized instance of DX Series Module.
FrameOfReferenceModule	getFrameOfReferenceModule() Retrieves pre-initialized instance of Frame Of Reference Module.
GeneralImageModule	getGeneralImageModule() Retrieves pre-initialized instance of General Image Module.
ImageHistogramModule	getImageHistogramModule() Retrieves pre-initialized instance of Image Histogram Module.
InterventionModule	getInterventionModule() Retrieves pre-initialized instance of Intervention Module.
OverlayPlaneModule	getOverlayPlaneModule() Retrieves pre-initialized instance of Overlay Plane Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
SpecimenIdentificationModule	getSpecimenIdentificationModule() Retrieves pre-initialized instance of Specimen Identification Module.
SpecimenModule	getSpecimenModule() Retrieves pre-initialized instance of Specimen Module.
VOILUTModule	getVOILUTModule() Retrieves pre-initialized instance of VOI LUT Module.
XRayAcquisitionDoseModule	getXRayAcquisitionDoseModule() Retrieves pre-initialized instance of X-Ray Acquisition 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.
XRayCollimatorModule	getXRayCollimatorModule() Retrieves pre-initialized instance of XRay Collimator Module.
XRayFiltrationModule	getXRayFiltrationModule() Retrieves pre-initialized instance of XRay Filtration Module.
XRayGenerationModule	getXRayGenerationModule() Retrieves pre-initialized instance of XRay Generation Module.
XRayGridModule	getXRayGridModule() Retrieves pre-initialized instance of XRay Grid Module.
XRayTomographyAcquisitionModule	getXRayTomographyAcquisitionModule() Retrieves pre-initialized instance of XRay Tomography Acquisition Module.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates Digital XRay 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

DIGITAL_XRAY_IOD

public static final java.lang.String DIGITAL_XRAY_IOD

The Constant DIGITAL_XRAY_IOD.

See Also:

Constant Field Values

Constructor Detail

DigitalXRayIOD

public DigitalXRayIOD()

Instantiates a new digital x ray iod.

DigitalXRayIOD

public DigitalXRayIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

DigitalXRayIOD

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

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

DigitalXRayIOD

public DigitalXRayIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

DigitalXRayIOD

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

DigitalXRayIOD

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

Method Detail

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.

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.

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.

getDisplayShutterModule

public DisplayShutterModule getDisplayShutterModule()

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

DisplayShutterModule - instance of DisplayShutterModule.

getDXAnatomyImagedModule

public DXAnatomyImagedModule getDXAnatomyImagedModule()

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

DXAnatomyImagedModule - instance of DXAnatomyImagedModule.

getDXDetectorModule

public DXDetectorModule getDXDetectorModule()

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

DXDetectorModule - instance of DXDetectorModule.

getDXImageModule

public DXImageModule getDXImageModule()

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

DXImageModule - instance of DXImageModule.

getDXPositioningModule

public DXPositioningModule getDXPositioningModule()

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

DXPositioningModule - instance of DXPositioningModule.

getDXSeriesModule

public DXSeriesModule getDXSeriesModule()

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

DXSeriesModule - instance of DXSeriesModule.

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.

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.

getImageHistogramModule

public ImageHistogramModule getImageHistogramModule()

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

ImageHistogramModule - instance of ImageHistogramModule.

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.

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.

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.

getSpecimenIdentificationModule

public SpecimenIdentificationModule getSpecimenIdentificationModule()

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

SpecimenIdentificationModule - instance of SpecimenIdentificationModule.

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.

getXRayAcquisitionDoseModule

public XRayAcquisitionDoseModule getXRayAcquisitionDoseModule()

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

XRayAcquisitionDoseModule - instance of XRayAcquisitionDoseModule.

getXRayCollimatorModule

public XRayCollimatorModule getXRayCollimatorModule()

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

XRayCollimatorModule - instance of XRayCollimatorModule.

getXRayFiltrationModule

public XRayFiltrationModule getXRayFiltrationModule()

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

XRayFiltrationModule - instance of XRayFiltrationModule.

getXRayGenerationModule

public XRayGenerationModule getXRayGenerationModule()

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

XRayGenerationModule - instance of XRayGenerationModule.

getXRayGridModule

public XRayGridModule getXRayGridModule()

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

XRayGridModule - instance of XRayGridModule.

getXRayTomographyAcquisitionModule

public XRayTomographyAcquisitionModule getXRayTomographyAcquisitionModule()

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

XRayTomographyAcquisitionModule - instance of XRayTomographyAcquisitionModule.

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.

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.

validate

public boolean validate()
                 throws InvalidIODException

This method validates Digital XRay 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:

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