cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class XRayAcquisitionModule

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.XRayAcquisitionModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class XRayAcquisitionModule
extends Module

\* This module specifies attributes related to XRay Acquisition.

Field Summary

Fields

Modifier and Type	Field and Description
static ISingleCollection<ITag>	objSingleCollection The obj single collection.

Constructor Summary

Constructors

Constructor and Description
XRayAcquisitionModule(IDataSet objIDataSet)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAveragePulseWidth() Returns Average width of X-Ray pulse in msec.
BasicPixelSpacingCalibrationMacro	getBasicPixelSpacingCalibrationMacro() Returns instance of Basic Pixel Spacing Calibration Macro.
java.lang.String	getExposure() Returns exposure expressed in mAs, for example calculated from Exposure Time.
java.lang.String	getExposureInuAs() Returns the exposure expressed in Micro As.
java.lang.String	getExposureTime() Return duration of X-Ray exposure in msec.
java.lang.String	getExposureTimeInuS() Return duration of X-Ray exposure in Micro seconds.
java.lang.String[]	getFieldOfViewDimensions() Returns type of filter(s) inserted into the X-Ray beam.
java.lang.String	getFieldOfViewShape() Returns shape of the Image Intensifier Field of View.
java.lang.String[]	getFocalSpots() Return Size of the focal spot in mm.
java.lang.String[]	getGrid() Returns the value that identifies the grid.
java.lang.String	getImageAndFluoroscopyAreaDoseProduct() Returns shape of the Image Intensifier Field of View.
java.lang.String[]	getImagerPixelSpacing() Return Physical distance measured at the front plane of the Image Receptor housing between the center of each pixel.
java.lang.String	getIntensifierSize() Returns diameter of X-Ray intensifier in mm.
java.lang.String	getKVP() Return Peak kilo voltage output of the X-Ray generator used.
java.lang.String	getRadiationMode() Returns X-Ray radiation mode.
java.lang.String	getRadiationSetting() Return Identify the general level of X-Ray dose exposure.
java.lang.String[]	getTypeOfFilters() Returns type of filter(s) inserted into the X-Ray beam.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
java.lang.String	getXRayTubeCurrentInMicroA() Return X-Ray Tube Current in MicroA.
java.lang.String	getXRayTubeCurrentInuA() Return X-Ray Tube Current in mA.
void	setAveragePulseWidth(java.lang.String strAveragePulseWidth) Sets Average width of X-Ray pulse in msec.
void	setExposure(java.lang.String strExposure) Sets the exposure expressed in mAs, for example calculated from Exposure Time and X-ray Tube Current.
void	setExposureInuAs(java.lang.String strExposureInuAs) Sets the exposure expressed in Micro As, for example calculated from Exposure Time and X-ray Tube Current.
void	setExposureTime(java.lang.String strExposureTime) Sets duration of X-Ray exposure in msec.
void	setExposureTimeInuS(java.lang.String strExposureTimeInuS) Sets duration of X-Ray exposure in msec.
void	setFieldOfViewDimensions(java.lang.String[] arrStrFieldOfViewDimensions) Sets Dimensions of the Image Intensifier Field of View in mm.
void	setFieldOfViewShape(EnumFieldOfViewShape enumFieldOfViewShape) Sets shape of the Image Intensifier Field of View.Defined Terms are: ROUND, RECTANGLE
void	setFocalSpots(java.lang.String[] arrStrFocalSpots) Sets Size of the focal spot in mm.
void	setGrid(EnumGrid[] enumGrid) Sets the value that identifies the grid.
void	setImageAndFluoroscopyAreaDoseProduct(java.lang.String strImageAndFluoroscopyAreaDoseProduct) Sets X-Ray dose, measured in dGy*cm*cm, to which the patient was exposed for the acquisition of this image plus any nondigitally recorded fluoroscopy which may have been performed to prepare for the acquisition of this image.
void	setImagerPixelSpacing(java.lang.String[] arrStrImagerPixelSpacing) Sets the Physical distance measured at the front plane of the Image Receptor housing between the center of each pixel.
void	setIntensifierSize(java.lang.String strIntensifierSize) Sets diameter of X-Ray intensifier in mm.
void	setKVP(java.lang.String strKVP) Sets Peak kilo voltage output of the X-Ray generator used.
void	setRadiationMode(EnumRadiationMode enumRadiationMode) Sets X-Ray radiation mode.
void	setRadiationSetting(EnumRadiationSetting enumRadiationSetting) Sets Identify the general level of X-Ray dose exposure.
void	setTypeOfFilters(java.lang.String[] arrStrTypeOfFilters) Sets type of filter(s) inserted into the X-Ray beam.
void	setXRayTubeCurrentInMicroA(java.lang.String strXRayTubeCurrentInMicroA) Sets X-Ray Tube Current in MicroA.
void	setXRayTubeCurrentInuA(java.lang.String strXRayTubeCurrentInuA) Sets X-Ray Tube Current in mA.
boolean	validateModule() This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

add, dumpDICOMInfo, getDictionaryReader, getTransferSyntax, isPresent, isPresent, iterator, remove

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

objSingleCollection

public static ISingleCollection<ITag> objSingleCollection

The obj single collection.

Constructor Detail

XRayAcquisitionModule

public XRayAcquisitionModule(IDataSet objIDataSet)

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types. Type 1,Type 2 are Mandatory: Mandatory Attributes have to present in the Module. Type 1C,2C are Conditional: Conditional Attributes' presence depend on a condition. If the condition is satisfied the Attribute has to be present. Type 3 are Optional Optional Attributes can be added as and when required.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

boolean - returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setKVP

public void setKVP(java.lang.String strKVP)

Sets Peak kilo voltage output of the X-Ray generator used.

Parameters:

strKVP - : String value of KVP

getKVP

public java.lang.String getKVP()

Return Peak kilo voltage output of the X-Ray generator used.

Returns:

String - String value of KVP

setRadiationSetting

public void setRadiationSetting(EnumRadiationSetting enumRadiationSetting)

Sets Identify the general level of X-Ray dose exposure.

Parameters:

enumRadiationSetting - Enum value of Radiation Setting .

getRadiationSetting

public java.lang.String getRadiationSetting()

Return Identify the general level of X-Ray dose exposure.

Returns:

String -String value of Radiation Setting .

setXRayTubeCurrentInuA

public void setXRayTubeCurrentInuA(java.lang.String strXRayTubeCurrentInuA)

Sets X-Ray Tube Current in mA.

Parameters:

strXRayTubeCurrentInuA - String value of X-Ray Tube Current in mA

getXRayTubeCurrentInuA

public java.lang.String getXRayTubeCurrentInuA()

Return X-Ray Tube Current in mA.

Returns:

String - String value of X-Ray Tube Current in mA

setXRayTubeCurrentInMicroA

public void setXRayTubeCurrentInMicroA(java.lang.String strXRayTubeCurrentInMicroA)

Sets X-Ray Tube Current in MicroA.

Parameters:

strXRayTubeCurrentInMicroA - String value of X-Ray Tube Current in MicroA

getXRayTubeCurrentInMicroA

public java.lang.String getXRayTubeCurrentInMicroA()

Return X-Ray Tube Current in MicroA.

Returns:

String - String value of X-Ray Tube Current in MicroA

setExposureTime

public void setExposureTime(java.lang.String strExposureTime)

Sets duration of X-Ray exposure in msec.

Parameters:

strExposureTime - String value of Exposure Time

getExposureTime

public java.lang.String getExposureTime()

Return duration of X-Ray exposure in msec.

Returns:

String - String value of Exposure Time

setExposureTimeInuS

public void setExposureTimeInuS(java.lang.String strExposureTimeInuS)

Sets duration of X-Ray exposure in msec.

Parameters:

strExposureTimeInuS - String value of Exposure Time in Micro Seconds

getExposureTimeInuS

public java.lang.String getExposureTimeInuS()

Return duration of X-Ray exposure in Micro seconds.

Returns:

String - String value of Exposure Time in Micro seconds

setExposure

public void setExposure(java.lang.String strExposure)

Sets the exposure expressed in mAs, for example calculated from Exposure Time and X-ray Tube Current.

Parameters:

strExposure - : String value of The exposure expressed in mAs

getExposure

public java.lang.String getExposure()

Returns exposure expressed in mAs, for example calculated from Exposure Time.

Returns:

String - String value of Exposure

setExposureInuAs

public void setExposureInuAs(java.lang.String strExposureInuAs)

Sets the exposure expressed in Micro As, for example calculated from Exposure Time and X-ray Tube Current.

Parameters:

strExposureInuAs - : String value of The exposure expressed in mAs

getExposureInuAs

public java.lang.String getExposureInuAs()

Returns the exposure expressed in Micro As.

Returns:

String - String value of Exposure in Micro As

setGrid

public void setGrid(EnumGrid[] enumGrid)

Sets the value that identifies the grid. Only a single value shall be present. Defined Terms are: IN = A Grid is positioned;NONE = No Grid is used.

Parameters:

enumGrid - the enum grid

getGrid

public java.lang.String[] getGrid()

Returns the value that identifies the grid.

Returns:

String[] - String array of Grid

setAveragePulseWidth

public void setAveragePulseWidth(java.lang.String strAveragePulseWidth)

Sets Average width of X-Ray pulse in msec.

Parameters:

strAveragePulseWidth - String value of Average Pulse Width

getAveragePulseWidth

public java.lang.String getAveragePulseWidth()

Returns Average width of X-Ray pulse in msec.

Returns:

String - String value of Average Pulse Width

setRadiationMode

public void setRadiationMode(EnumRadiationMode enumRadiationMode)

Sets X-Ray radiation mode. Defined Terms: CONTINUOUS, PULSED

Parameters:

enumRadiationMode - the enum radiation mode

getRadiationMode

public java.lang.String getRadiationMode()

Returns X-Ray radiation mode.

Returns:

String - String value of Radiation Mode

setTypeOfFilters

public void setTypeOfFilters(java.lang.String[] arrStrTypeOfFilters)

Sets type of filter(s) inserted into the X-Ray beam.

Parameters:

arrStrTypeOfFilters - String array of Type of Filters

getTypeOfFilters

public java.lang.String[] getTypeOfFilters()

Returns type of filter(s) inserted into the X-Ray beam.

Returns:

String - String value of Type Of Filters

setIntensifierSize

public void setIntensifierSize(java.lang.String strIntensifierSize)

Sets diameter of X-Ray intensifier in mm.

Parameters:

strIntensifierSize - String value of Intensifier Size

getIntensifierSize

public java.lang.String getIntensifierSize()

Returns diameter of X-Ray intensifier in mm.

Returns:

String - String value of Intensifier Size

setFieldOfViewShape

public void setFieldOfViewShape(EnumFieldOfViewShape enumFieldOfViewShape)

Sets shape of the Image Intensifier Field of View.Defined Terms are: ROUND, RECTANGLE

Parameters:

enumFieldOfViewShape - Enum value of Field of View Shape

getFieldOfViewShape

public java.lang.String getFieldOfViewShape()

Returns shape of the Image Intensifier Field of View.

Returns:

String - String value of Intensifier Size

setFieldOfViewDimensions

public void setFieldOfViewDimensions(java.lang.String[] arrStrFieldOfViewDimensions)

Sets Dimensions of the Image Intensifier Field of View in mm. If Rectangle, row dimension followed by column; if Round, diameter.

Parameters:

arrStrFieldOfViewDimensions - the arr str field of view dimensions

getFieldOfViewDimensions

public java.lang.String[] getFieldOfViewDimensions()

Returns type of filter(s) inserted into the X-Ray beam.

Returns:

String[] - String Array of Field Of View Dimensions

setImagerPixelSpacing

public void setImagerPixelSpacing(java.lang.String[] arrStrImagerPixelSpacing)

Sets the Physical distance measured at the front plane of the Image Receptor housing between the center of each pixel. Specified by a numeric pair - row spacing value (delimiter) column spacing value - in mm. In the case of CR, the front plane is defined to be the external surface of the CR plate closest to the patient and radiation source.

Parameters:

arrStrImagerPixelSpacing - the arr str imager pixel spacing

getImagerPixelSpacing

public java.lang.String[] getImagerPixelSpacing()

Return Physical distance measured at the front plane of the Image Receptor housing between the center of each pixel.

Returns:

String - String value of Imager Pixel Spacing.

getBasicPixelSpacingCalibrationMacro

public BasicPixelSpacingCalibrationMacro getBasicPixelSpacingCalibrationMacro()

Returns instance of Basic Pixel Spacing Calibration Macro.

Returns:

Instance of Basic Pixel Spacing Calibration Macro

setFocalSpots

public void setFocalSpots(java.lang.String[] arrStrFocalSpots)

Sets Size of the focal spot in mm. For devices with variable focal spot or multiple focal spots, small dimension followed by large dimension.

Parameters:

arrStrFocalSpots - String array of focal spots.

getFocalSpots

public java.lang.String[] getFocalSpots()

Return Size of the focal spot in mm.

Returns:

String[] - String array of Focal Spots.

setImageAndFluoroscopyAreaDoseProduct

public void setImageAndFluoroscopyAreaDoseProduct(java.lang.String strImageAndFluoroscopyAreaDoseProduct)

Sets X-Ray dose, measured in dGy*cm*cm, to which the patient was exposed for the acquisition of this image plus any nondigitally recorded fluoroscopy which may have been performed to prepare for the acquisition of this image.

Parameters:

strImageAndFluoroscopyAreaDoseProduct - the str image area dose product

getImageAndFluoroscopyAreaDoseProduct

public java.lang.String getImageAndFluoroscopyAreaDoseProduct()

Returns shape of the Image Intensifier Field of View.

Returns:

String - String value of ImageAndFluoroscopyAreaDoseProduct

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the vector of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

vector of Tags - returns the vector containing the collection of tags