cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class XRayAcquisitionDoseModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.XRayAcquisitionDoseModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class XRayAcquisitionDoseModule
extends Module

\* This module describes the attributes related to dose delivery from an X-Ray source during the acquisition of an X-Ray image.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
XRayAcquisitionDoseModule(IDataSet objIDataSet)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAnodeTargetMaterial() Retrieves primary material in the anode of the X-Ray source.
java.lang.String	getBodyPartThickness() Retrievs the average thickness in mm of the body part examined when compressed, if compression has been applied during exposure.
java.lang.String	getCommentsOnRadiationDose() Retrieves User-defined comments on any special conditions related to radiation dose encountered during the acquisition of this image.
java.lang.String	getDistanceSourceToDetector() Return Distance in mm from transmission source to the detector face.
java.lang.String	getDistanceSourceToEntrance() Retrieves Distance in mm from the source to the surface of the patient closest to the source during the acquisition of this image.
java.lang.String	getDistanceSourceToPatient() Retrieves Distance in mm from source to isocenter.
short	getEntranceDose() Retrieves Average entrance dose value measured in dGy.
java.lang.String	getEntranceDoseInMGy() Retrieves Average entrance dose value measured in mGy.
short[]	getExposedArea() Retrieves Typical dimension of the exposed area at the detector plane.
java.lang.String	getExposure() Returns exposure expressed in mAs, for example calculated from Exposure Time.
ExposureIndexMacro	getExposureIndexMacro() Returns instance of Basic Pixel Spacing Calibration Macro.
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	getHalfValueLayer() Retrieves the thickness of Aluminum in mm required to reduce the X-Ray Output (0040,0312) by a factor of two.
java.lang.String	getImageAndFluoroscopyAreaDoseProduct() Returns shape of the Image Intensifier Field of View.
java.lang.String	getKVP() Retrieves Peak kilo voltage output of the x-ray generator used.
java.lang.String	getOrganDose() Retrieves Average organ dose value measured in dGy during the acquisition of this image.
java.lang.String	getOrganExposed() Retrieves Organ to which Organ Dose (0040,0316) applies.
java.lang.String	getRectificationType() Retrieves type of rectification used in the X-Ray generator.
java.lang.String	getRelativeXRayExposure() Retrieves the Relative x-ray exposure on the plate.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the custom collection containing the list of DataElements belonging to the XRay Acquisition Dose Module specified by DICOM Standard.
XRayFiltrationMacro	getXRayFiltrationMacro() Returns instance of Basic Pixel Spacing Calibration Macro.
java.lang.String	getXRayOutput() Retrieves X-Ray output at the patient entrance surface and kVp used to acquire the image, measured in mGy/mAs.
java.lang.String	getXRayTubeCurrent() Retrieves X-Ray Tube Current in mA.
java.lang.String	getXRayTubeCurrentInuA() Return X-Ray Tube Current in MicroA.
void	setAnodeTargetMaterial(EnumAnodeTargetMaterial enumAnodeTargetMaterial) Sets the primary material in the anode of the X-Ray source.
void	setBodyPartThickness(java.lang.String strBodyPartThickness) Sets the average thickness in mm of the body part examined when compressed, if compression has been applied during exposure.
void	setCommentsOnRadiationDose(java.lang.String strCommentsOnRadiationDose) Sets User-defined comments on any special conditions related to radiation dose encountered during the acquisition of this image.
void	setDistanceSourceToDetector(java.lang.String strDistanceSourceToDetector) Sets Distance in mm from transmission source to the detector face.
void	setDistanceSourceToEntrance(java.lang.String strDistanceSourceToEntrance) Sets Distance in mm from the source to the surface of the patient closest to the source during the acquisition of this image.
void	setDistanceSourceToPatient(java.lang.String strDistanceSourceToPatient) Sets Distance in mm from source to isocenter.
void	setEntranceDose(short shEntranceDose) Sets Average entrance dose value measured in dGy at the surface of the patient during the acquisition of this image.
void	setEntranceDoseInMGy(java.lang.String strEntranceDoseInMGy) Sets Average entrance dose value measured in mGy at the surface of the patient during the acquisition of this image.
void	setExposedArea(short[] arrShExposedArea) Sets Typical dimension of the exposed area at the detector plane.
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 micro second.
void	setHalfValueLayer(java.lang.String strHalfValueLayer) Sets the thickness of Aluminum in mm required to reduce the X-Ray Output (0040,0312) by a factor of two.
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	setKVP(java.lang.String strKVP) Sets Peak kilo voltage output of the x-ray generator used.
void	setOrganDose(java.lang.String strOrganDose) Sets Average organ dose value measured in dGy during the acquisition of this image.
void	setOrganExposed(EnumOrganExposed enumOrganExposed) Sets Organ to which Organ Dose (0040,0316) applies.
void	setRectificationType(EnumRectificationType enumRectificationType) Sets type of rectification used in the X-Ray generator.Defined Terms:SINGLE PHASE,THREE PHASE,CONST POTENTIAL,
void	setRelativeXRayExposure(java.lang.String strRelativeXRayExposure) Sets the Relative x-ray exposure on the plate.
void	setXRayOutput(java.lang.String strXRayOutput) The X-Ray output at the patient entrance surface and kVp used to acquire the image, measured in mGy/mAs.
void	setXRayTubeCurrent(java.lang.String strXRayTubeCurrent) Sets X-Ray Tube Current in MilliA.
void	setXRayTubeCurrentInuA(java.lang.String strXRayTubeCurrentInuA) Sets X-Ray Tube Current in MicroA.
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

XRayAcquisitionDoseModule

public XRayAcquisitionDoseModule(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()

Retrieves Peak kilo voltage output of the x-ray generator used.

Returns:

String - String value of KVP

setXRayTubeCurrent

public void setXRayTubeCurrent(java.lang.String strXRayTubeCurrent)

Sets X-Ray Tube Current in MilliA.

Parameters:

strXRayTubeCurrent - the str x ray tube current

getXRayTubeCurrent

public java.lang.String getXRayTubeCurrent()

Retrieves X-Ray Tube Current in mA.

Returns:

String - String value of X-Ray Tube Current

setXRayTubeCurrentInuA

public void setXRayTubeCurrentInuA(java.lang.String strXRayTubeCurrentInuA)

Sets X-Ray Tube Current in MicroA.

Parameters:

strXRayTubeCurrentInuA - the str x ray tube current in micro a

getXRayTubeCurrentInuA

public java.lang.String getXRayTubeCurrentInuA()

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 - the str 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 micro second.

Parameters:

strExposureTimeInuS - the str exposure time in micro s

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 Micro As

getExposureInuAs

public java.lang.String getExposureInuAs()

Returns the exposure expressed in Micro As.

Returns:

String - String value of Exposure in Micro As

setDistanceSourceToDetector

public void setDistanceSourceToDetector(java.lang.String strDistanceSourceToDetector)

Sets Distance in mm from transmission source to the detector face. Required if Image Type (0008,0008) Value 4 is TRANSMISSION, Value 3 is not TOMO, and a sequence Item is present.

Parameters:

strDistanceSourceToDetector - the str distance source to detector

getDistanceSourceToDetector

public java.lang.String getDistanceSourceToDetector()

Return Distance in mm from transmission source to the detector face.

Returns:

String - String value of Distance Source to Detector

setDistanceSourceToPatient

public void setDistanceSourceToPatient(java.lang.String strDistanceSourceToPatient)

Sets Distance in mm from source to isocenter.

Parameters:

strDistanceSourceToPatient - :String value of Distance of Source To Patient

getDistanceSourceToPatient

public java.lang.String getDistanceSourceToPatient()

Retrieves Distance in mm from source to isocenter.

Returns:

String - String value of DistanceSource To Patient.

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 Image Area Dose Product

setBodyPartThickness

public void setBodyPartThickness(java.lang.String strBodyPartThickness)

Sets the average thickness in mm of the body part examined when compressed, if compression has been applied during exposure.

Parameters:

strBodyPartThickness - the str body part thickness

getBodyPartThickness

public java.lang.String getBodyPartThickness()

Retrievs the average thickness in mm of the body part examined when compressed, if compression has been applied during exposure.

Returns:

String - String value of Body Part Thickness

setRelativeXRayExposure

public void setRelativeXRayExposure(java.lang.String strRelativeXRayExposure)

Sets the Relative x-ray exposure on the plate. Meaning of values is implementation specific. May be used to adjust the dynamic range of the plate digitizer (scanner).

Parameters:

strRelativeXRayExposure - the str relative x ray exposure

getRelativeXRayExposure

public java.lang.String getRelativeXRayExposure()

Retrieves the Relative x-ray exposure on the plate.

Returns:

String - String value of Relative X-ray Exposure.

setEntranceDose

public void setEntranceDose(short shEntranceDose)

Sets Average entrance dose value measured in dGy at the surface of the patient during the acquisition of this image.

Parameters:

shEntranceDose - - short value of Entrance Dose.

getEntranceDose

public short getEntranceDose()

Retrieves Average entrance dose value measured in dGy.

Returns:

short - short value of Entrance Dose.

setEntranceDoseInMGy

public void setEntranceDoseInMGy(java.lang.String strEntranceDoseInMGy)

Sets Average entrance dose value measured in mGy at the surface of the patient during the acquisition of this image.

Parameters:

strEntranceDoseInMGy - - String value of Entrance Dose In MGy.

getEntranceDoseInMGy

public java.lang.String getEntranceDoseInMGy()

Retrieves Average entrance dose value measured in mGy.

Returns:

String - String value of Entrance Dose In MGy.

setExposedArea

public void setExposedArea(short[] arrShExposedArea)

Sets Typical dimension of the exposed area at the detector plane. If Rectangular: row dimension followed by column; if Round: diameter. Measured in cm.

Parameters:

arrShExposedArea - - short array of Exposed Area.

getExposedArea

public short[] getExposedArea()

Retrieves Typical dimension of the exposed area at the detector plane.

Returns:

short[] - short array of Exposed Area.

setDistanceSourceToEntrance

public void setDistanceSourceToEntrance(java.lang.String strDistanceSourceToEntrance)

Sets Distance in mm from the source to the surface of the patient closest to the source during the acquisition of this image.

Parameters:

strDistanceSourceToEntrance - - String value of Distance Source To Entrance.

getDistanceSourceToEntrance

public java.lang.String getDistanceSourceToEntrance()

Retrieves Distance in mm from the source to the surface of the patient closest to the source during the acquisition of this image.

Returns:

String - String value of Distance Source To Entrance.

setCommentsOnRadiationDose

public void setCommentsOnRadiationDose(java.lang.String strCommentsOnRadiationDose)

Sets User-defined comments on any special conditions related to radiation dose encountered during the acquisition of this image.

Parameters:

strCommentsOnRadiationDose - - String value of Comments on Radiation Dose.

getCommentsOnRadiationDose

public java.lang.String getCommentsOnRadiationDose()

Retrieves User-defined comments on any special conditions related to radiation dose encountered during the acquisition of this image.

Returns:

String - String value of Comments on Radiation Dose.

setXRayOutput

public void setXRayOutput(java.lang.String strXRayOutput)

The X-Ray output at the patient entrance surface and kVp used to acquire the image, measured in mGy/mAs.

Parameters:

strXRayOutput - String value of XRay Output

getXRayOutput

public java.lang.String getXRayOutput()

Retrieves X-Ray output at the patient entrance surface and kVp used to acquire the image, measured in mGy/mAs.

Returns:

String - String value of X-Ray Output.

setHalfValueLayer

public void setHalfValueLayer(java.lang.String strHalfValueLayer)

Sets the thickness of Aluminum in mm required to reduce the X-Ray Output (0040,0312) by a factor of two.

Parameters:

strHalfValueLayer - - String value of Half Value Layer.

getHalfValueLayer

public java.lang.String getHalfValueLayer()

Retrieves the thickness of Aluminum in mm required to reduce the X-Ray Output (0040,0312) by a factor of two.

Returns:

String - String value of Half Value Layer.

setOrganDose

public void setOrganDose(java.lang.String strOrganDose)

Sets Average organ dose value measured in dGy during the acquisition of this image.

Parameters:

strOrganDose - - String value of Organ Dose.

getOrganDose

public java.lang.String getOrganDose()

Retrieves Average organ dose value measured in dGy during the acquisition of this image.

Returns:

String - String value of Organ Dose.

setOrganExposed

public void setOrganExposed(EnumOrganExposed enumOrganExposed)

Sets Organ to which Organ Dose (0040,0316) applies. Defined Terms:BREAST,GONADS,BONE MARROW,FETUS,LENS.

Parameters:

enumOrganExposed - - Enum value of Organ Exposed.

getOrganExposed

public java.lang.String getOrganExposed()

Retrieves Organ to which Organ Dose (0040,0316) applies.

Returns:

String - String value of Organ Exposed.

setAnodeTargetMaterial

public void setAnodeTargetMaterial(EnumAnodeTargetMaterial enumAnodeTargetMaterial)

Sets the primary material in the anode of the X-Ray source. Defined Terms: TUNGSTEN,MOLYBDENUM,RHODIUM.

Parameters:

enumAnodeTargetMaterial - - enum value of the primary material in the anode of the X-Ray source.

getAnodeTargetMaterial

public java.lang.String getAnodeTargetMaterial()

Retrieves primary material in the anode of the X-Ray source.

Returns:

String - String value of Anode Target Material.

setRectificationType

public void setRectificationType(EnumRectificationType enumRectificationType)

Sets type of rectification used in the X-Ray generator.Defined Terms:SINGLE PHASE,THREE PHASE,CONST POTENTIAL,

Parameters:

enumRectificationType - - enum value of Rectification Type.

getRectificationType

public java.lang.String getRectificationType()

Retrieves type of rectification used in the X-Ray generator.

Returns:

String - String value of Rectification Type.

getXRayFiltrationMacro

public XRayFiltrationMacro getXRayFiltrationMacro()

Returns instance of Basic Pixel Spacing Calibration Macro.

Returns:

Instance of Basic Pixel Spacing Calibration Macro

getExposureIndexMacro

public ExposureIndexMacro getExposureIndexMacro()

Returns instance of Basic Pixel Spacing Calibration Macro.

Returns:

Instance of Basic Pixel Spacing Calibration Macro

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the custom collection containing the list of DataElements belonging to the XRay Acquisition Dose Module specified by DICOM Standard.

Overrides:

getVectorOfKeys in class Module

Returns:

collection - custom collection containing the list of DataElements belonging to the XRay Acquisition Dose Module