cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class XRayGenerationModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.XRayGenerationModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class XRayGenerationModule
extends Module

\* This module describes the attributes related to generation of X-rays 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
XRayGenerationModule(IDataSet objIDataSet) Instantiates a new x ray generation module.

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	getExposure() Retrieves exposure expressed in mAs, for example calculated from Exposure Time.
java.lang.String	getExposureControlMode() Retrieves the type of exposure control.
java.lang.String	getExposureControlModeDescription() Retrieves text description of the mechanism of exposure control.
java.lang.String	getExposureInuAs() Retrieves the exposure expressed in Micro As.
java.lang.String	getExposureStatus() Retrieves whether the exposure was normally completed or not.
java.lang.String	getExposureTime() Retrieves duration of X-Ray exposure in msec.
java.lang.String	getExposureTimeInuS() Retrieves duration of X-Ray exposure in msec.
java.lang.String[]	getFocalSpots() Retrieves size of the focal spot in mm.
java.lang.String	getGeneratorID() Return user-defined label identifier for Generator ID
java.lang.String	getKVP() Retrieves Peak kilo voltage output of the x-ray generator used.
java.lang.String	getPhototimerSetting() Retrieves nominal percentage phototimer setting, where a more positive value indicates greater exposure and a more negative value indicates less exposure.
java.lang.String	getRectificationType() Retrieves type of rectification used in the X-Ray generator.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the custom collection containing the list of DataElements belonging to the X-Ray Generation Module specified by DICOM Standard.
java.lang.String	getXRayTubeCurrent() Retrieves X-Ray Tube Current in mA.
java.lang.String	getXRayTubeCurrentInuA() Retrieves X-Ray Tube Current in MicroA.
void	setAnodeTargetMaterial(EnumAnodeTargetMaterial enumAnodeTargetMaterial) Sets the primary material in the anode of the X-Ray source.
void	setExposure(java.lang.String strExposure) Sets the exposure expressed in mAs, for example calculated from Exposure Time and X-ray Tube Current.
void	setExposureControlMode(EnumExposureControlMode enumExposureControlMode) Sets type of exposure control.
void	setExposureControlModeDescription(java.lang.String strExposureControlModeDescription) Sets text description of the mechanism of exposure control.
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	setExposureStatus(EnumExposureStatus enumExposureStatus) Sets whether the exposure was normally completed or not.
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 Sec.
void	setFocalSpots(java.lang.String[] arrStrFocalSpots) Sets size of the focal spot in mm.
void	setGeneratorID(java.lang.String strGeneratorID) Sets Generator ID
void	setKVP(java.lang.String strKVP) Sets Peak kilo voltage output of the x-ray generator used.
void	setPhototimerSetting(java.lang.String strPhototimerSetting) Sets nominal percentage phototimer setting, where a more positive value indicates greater exposure and a more negative value indicates less exposure.
void	setRectificationType(EnumRectificationType enumRectificationType) Sets type of rectification used in the X-Ray generator.Defined Terms:SINGLE PHASE,THREE PHASE,CONST POTENTIAL,
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

XRayGenerationModule

public XRayGenerationModule(IDataSet objIDataSet)

Instantiates a new x ray generation module.

Parameters:

objIDataSet - the obj i data set

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

Retrieves 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()

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

Parameters:

strExposureTimeInuS - the str exposure time in micro s

getExposureTimeInuS

public java.lang.String getExposureTimeInuS()

Retrieves duration of X-Ray exposure in msec.

Returns:

String - String value of Exposure Time in micro sec

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

Retrieves 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()

Retrieves the exposure expressed in Micro As.

Returns:

String - String value of Exposure in Micro As

setExposureControlMode

public void setExposureControlMode(EnumExposureControlMode enumExposureControlMode)

Sets type of exposure control. Defined Terms:MANUAL,AUTOMATIC.

Parameters:

enumExposureControlMode - - enum value of Exposure Control Mode.

getExposureControlMode

public java.lang.String getExposureControlMode()

Retrieves the type of exposure control.

Returns:

String - String value of Exposure Control Mode.

setExposureControlModeDescription

public void setExposureControlModeDescription(java.lang.String strExposureControlModeDescription)

Sets text description of the mechanism of exposure control. May describe the number and type of exposure sensors or position of the sensitive area of the imaging detector.

Parameters:

strExposureControlModeDescription - - String value of Exposure Control Mode Description

getExposureControlModeDescription

public java.lang.String getExposureControlModeDescription()

Retrieves text description of the mechanism of exposure control.

Returns:

String - String value of Exposure Control Mode Description

setExposureStatus

public void setExposureStatus(EnumExposureStatus enumExposureStatus)

Sets whether the exposure was normally completed or not. Defined Terms: NORMAL, ABORTED.

Parameters:

enumExposureStatus - - enum value of Exposure Status.

getExposureStatus

public java.lang.String getExposureStatus()

Retrieves whether the exposure was normally completed or not.

Returns:

String - String value of Exposure Control Mode Description

setPhototimerSetting

public void setPhototimerSetting(java.lang.String strPhototimerSetting)

Sets nominal percentage phototimer setting, where a more positive value indicates greater exposure and a more negative value indicates less exposure.

Parameters:

strPhototimerSetting - - String value of Phototimer Setting.

getPhototimerSetting

public java.lang.String getPhototimerSetting()

Retrieves nominal percentage phototimer setting, where a more positive value indicates greater exposure and a more negative value indicates less exposure.

Returns:

String - String value of Phototimer Setting.

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 Spot(s) values.

getFocalSpots

public java.lang.String[] getFocalSpots()

Retrieves size of the focal spot in mm.

Returns:

String[] - String array of Focal Spot(s) values.

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

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.

setGeneratorID

public void setGeneratorID(java.lang.String strGeneratorID)

Sets Generator ID

Parameters:

strGeneratorID - String value of Generator ID

getGeneratorID

public java.lang.String getGeneratorID()

Return user-defined label identifier for Generator ID

Returns:

String - value of Generator ID

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the custom collection containing the list of DataElements belonging to the X-Ray Generation Module specified by DICOM Standard.

Overrides:

getVectorOfKeys in class Module

Returns:

collection - custom collection containing the list of DataElements belonging to the X-Ray Generation Module