cdac.medinfo.sdk.dcm30_04.dicommodel.xray

Class XRFImageIOD

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

public class XRFImageIOD
extends ImageIOD

The focus for this X-Ray RF Image IOD (XRF IOD) is to address the requirements for image transfer found in general Radiofluoroscopic applications performed on a table with a column.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
XRFImageIOD() Instantiates a new xRF image iod.
XRFImageIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
XRFImageIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
XRFImageIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
XRFImageIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
XRFImageIOD(java.lang.String strFileName) Creates XRFImageIOD IOD from a DICOM file containing XRFImageIOD 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.
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.
DisplayShutterModule	getDisplayShutterModule() Retrieves pre-initialized instance of Display Shutter Module.
DXDetectorModule	getDXDetectorModule() Retrieves pre-initialized instance of DX Detector Module.
FrameExtractionModule	getFrameExtractionModule() Retrieves pre-initialized instance of Frame Extraction Module.
FramePointersModule	getFramePointersModule() Retrieves pre-initialized instance of Frame Pointers Module.
GeneralImageModule	getGeneralImageModule() Retrieves pre-initialized instance of General Image Module.
InterventionModule	getInterventionModule() Retrieves pre-initialized instance of Intervention Module.
MaskModule	getMaskModule() Retrieves pre-initialized instance of Mask Module.
ModalityLUTModule	getModalityLUTModule() Retrieves pre-initialized instance of Modality LUT Module.
MultiFrameModule	getMultiFrameModule() Retrieves pre-initialized instance of Multi Frame Module.
MultiFrameOverlayModule	getMultiFrameOverlayModule() Retrieves pre-initialized instance of Multi Frame Overlay Module.
OverlayPlaneModule	getOverlayPlaneModule() Retrieves pre-initialized instance of Overlay Plane Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
SpecimenModule	getSpecimenModule() Retrieves pre-initialized instance of Specimen Module.
SynchronizationModule	getSynchronizationModule() Retrieves pre-initialized instance of Synchronization Module.
VOILUTModule	getVOILUTModule() Retrieves pre-initialized instance of VOI LUT Module.
XRayAcquisitionModule	getXRayAcquisitionModule() Retrieves pre-initialized instance of XRay Acquisition Module.
XRayCollimatorModule	getXRayCollimatorModule() Retrieves pre-initialized instance of XRay Collimator Module.
XRayImageModule	getXRayImageModule() Retrieves pre-initialized instance of XRay Image Module.
XRayTableModule	getXRayTableModule() Retrieves pre-initialized instance of XRay Table Module.
XRayTomographyAcquisitionModule	getXRayTomographyAcquisitionModule() Retrieves pre-initialized instance of XRay Tomography Acquisition Module.
XRFPositionerModule	getXRFPositionerModule() Retrieves pre-initialized instance of XRF Positioner Module.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates XRF 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

XRF_IMAGE_IOD

public static final java.lang.String XRF_IMAGE_IOD

The Constant XRF_IMAGE_IOD.

See Also:

Constant Field Values

Constructor Detail

XRFImageIOD

public XRFImageIOD()

Instantiates a new xRF image iod.

XRFImageIOD

public XRFImageIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

XRFImageIOD

public XRFImageIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

XRFImageIOD

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

XRFImageIOD

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

XRFImageIOD

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

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

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.

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.

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.

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.

getFramePointersModule

public FramePointersModule getFramePointersModule()

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

FramePointersModule - instance of FramePointersModule.

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.

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.

getMaskModule

public MaskModule getMaskModule()

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

MaskModule - instance of MaskModule.

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.

getMultiFrameOverlayModule

public MultiFrameOverlayModule getMultiFrameOverlayModule()

Retrieves pre-initialized instance of Multi Frame Overlay 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:

MultiFrameOverlayModule - instance of MultiFrameOverlayModule.

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.

getXRFPositionerModule

public XRFPositionerModule getXRFPositionerModule()

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

XRFPositionerModule - instance of XRFPositionerModule.

getXRayAcquisitionModule

public XRayAcquisitionModule getXRayAcquisitionModule()

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

XRayAcquisitionModule - instance of XRayAcquisitionModule.

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.

getXRayImageModule

public XRayImageModule getXRayImageModule()

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

XRayImageModule - instance of XRayImageModule.

getXRayTableModule

public XRayTableModule getXRayTableModule()

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

XRayTableModule - instance of XRayTableModule.

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.

getSynchronizationModule

public SynchronizationModule getSynchronizationModule()

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

SynchronizationModule - instance of SynchronizationModule.

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.

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.

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.

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