cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class XAOrXRFAcquisitionModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.XAOrXRFAcquisitionModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class XAOrXRFAcquisitionModule
extends Module

\* This module describes attributes related to XA Or XRF Acquisition Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
XAOrXRFAcquisitionModule(IDataSet objIDataSet) Instantiates a new waveform identification module.

Method Summary

Methods

Modifier and Type	Method and Description
float	getAcquiredImageAreaDoseProduct() Retrieves Acquired Image Area Dose Product
double	getAcquisitionDuration() Retrieves the time in seconds needed to run the prescribed pulse sequence.
java.lang.String	getAnodeTargetMaterial() Retrieves primary material in the anode of the X-Ray source.
java.lang.String	getAveragePulseWidth() Returns Average width of X-Ray pulse in msec.
java.lang.String	getCArmPositionerTabletopRelationship() Sets C-arm Positioner TabletopRelationship.
float	getDistanceReceptorPlaneToDetectorHousing() Retrieves Distance Receptor Plane toDetector Housing
java.lang.String	getExposureInmAs() Gets the Exposure In mAs.
java.lang.String	getExposureTimeInms() Gets the Exposure Time in ms.
java.lang.String[]	getFocalSpots() Retrieves size of the focal spot in mm.
java.lang.String	getKVP() Gets the kVP.
java.lang.String	getPositionerType() Sets Positioner Type.
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	getRectificationType() Retrieves type of rectification used in the X-Ray generator.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
java.lang.String	getXRayReceptorType() Retrieves XRayReceptorType.
java.lang.String	getXRayTubeCurrentInmA() Gets the xray tube current.
void	setAcquiredImageAreaDoseProduct(float fAcquiredImageAreaDoseProduct) Sets Acquired Image Area Dose Product
void	setAcquisitionDuration(double dAcquisitionDuration) Sets the time in seconds needed to run the prescribed pulse sequence.
void	setAnodeTargetMaterial(EnumAnodeTargetMaterial enumAnodeTargetMaterial) Sets the primary material in the anode of the X-Ray source.
void	setAveragePulseWidth(java.lang.String strAveragePulseWidth) Sets Average width of X-Ray pulse in msec.
void	setCArmPositionerTabletopRelationship(EnumCArmPositionerTabletopRelationship enumCArmPositionerTabletopRelationship) Sets C-arm Positioner TabletopRelationship.
void	setDistanceReceptorPlaneToDetectorHousing(float fDistanceReceptorPlaneToDetectorHousing) Sets Distance Receptor Plane toDetector Housing
void	setExposureInmAs(java.lang.String strExposureTimeInms) The method is used to set Exposure Time in ms.
void	setExposureTimeInms(java.lang.String strExposureTimeInms) The method is used to set Exposure Time in ms.
void	setFocalSpots(java.lang.String[] arrStrFocalSpots) Sets size of the focal spot in mm.
void	setKVP(java.lang.String strKVP) The method is used to set Peak kilo voltage output of the x-ray generator used The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values.
void	setPositionerType(EnumPositionerType enumPositionerType) Sets Positioner Type.
void	setRadiationMode(EnumRadiationMode enumRadiationMode) Sets X-Ray radiation mode.
void	setRadiationSetting(EnumRadiationSetting enumRadiationSetting) Sets Identify the general level of X-Ray dose exposure.
void	setRectificationType(EnumRectificationType enumRectificationType) Sets type of rectification used in the X-Ray generator.Defined Terms:SINGLE PHASE,THREE PHASE,CONST POTENTIAL,
void	setXRayReceptorType(EnumXRayReceptorType enumXRayReceptorType) Sets X-Ray Receptor Type.
void	setXRayTubeCurrentInmA(java.lang.String strXRayTubeCurrentInmA) The method is used to set 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

XAOrXRFAcquisitionModule

public XAOrXRFAcquisitionModule(IDataSet objIDataSet)

Instantiates a new waveform identification module.

Parameters:

objIDataSet - the obj i data set

Method Detail

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.

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)

The method is used to set Peak kilo voltage output of the x-ray generator used The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strKVP - the str kvp

getKVP

public java.lang.String getKVP()

Gets the kVP.

Returns:

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

setXRayTubeCurrentInmA

public void setXRayTubeCurrentInmA(java.lang.String strXRayTubeCurrentInmA)

The method is used to set X-ray Tube Current in mA. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strXRayTubeCurrentInmA - :String value of X-ray Tube Current in mA.

getXRayTubeCurrentInmA

public java.lang.String getXRayTubeCurrentInmA()

Gets the xray tube current.

Returns:

the xray tube current

setExposureTimeInms

public void setExposureTimeInms(java.lang.String strExposureTimeInms)

The method is used to set Exposure Time in ms. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strExposureTimeInms - :String value of X-ray Tube Current in mA.

getExposureTimeInms

public java.lang.String getExposureTimeInms()

Gets the Exposure Time in ms.

Returns:

the Exposure Time in ms

setExposureInmAs

public void setExposureInmAs(java.lang.String strExposureTimeInms)

The method is used to set Exposure Time in ms. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strExposureInmAs - :String value of X-ray Tube Current in mA.

getExposureInmAs

public java.lang.String getExposureInmAs()

Gets the Exposure In mAs.

Returns:

the Exposure Time in mAs

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

setAcquisitionDuration

public void setAcquisitionDuration(double dAcquisitionDuration)

Sets the time in seconds needed to run the prescribed pulse sequence.

Parameters:

dAcquisitionDuration - - double value of Acquisition Duration.

getAcquisitionDuration

public double getAcquisitionDuration()

Retrieves the time in seconds needed to run the prescribed pulse sequence.

Returns:

double - double value of Acquisition Duration.

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

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

setXRayReceptorType

public void setXRayReceptorType(EnumXRayReceptorType enumXRayReceptorType)

Sets X-Ray Receptor Type. Enumerated Values: 1) IMG_INTENSIFIER 2) DIGITAL_DETECTOR

Parameters:

enumXRayReceptorType - the enum approval status

getXRayReceptorType

public java.lang.String getXRayReceptorType()

Retrieves XRayReceptorType.

Returns:

String - String value of XRayReceptorType.

setDistanceReceptorPlaneToDetectorHousing

public void setDistanceReceptorPlaneToDetectorHousing(float fDistanceReceptorPlaneToDetectorHousing)

Sets Distance Receptor Plane toDetector Housing

Parameters:

Distance - Receptor Plane toDetector Housing Float value of the Distance Receptor Plane toDetector Housing

getDistanceReceptorPlaneToDetectorHousing

public float getDistanceReceptorPlaneToDetectorHousing()

Retrieves Distance Receptor Plane toDetector Housing

Returns:

float - Float value of the Distance Receptor Plane toDetector Housing

setPositionerType

public void setPositionerType(EnumPositionerType enumPositionerType)

Sets Positioner Type. Defined Terms: CARM COLUMN MAMMOGRAPHIC PANORAMIC CEPHALOSTAT RIGID NONE

Parameters:

enumPositionerType - the enum positioner type

getPositionerType

public java.lang.String getPositionerType()

Sets Positioner Type.

Returns:

String - String value of Positioner Type

setCArmPositionerTabletopRelationship

public void setCArmPositionerTabletopRelationship(EnumCArmPositionerTabletopRelationship enumCArmPositionerTabletopRelationship)

Sets C-arm Positioner TabletopRelationship. YES NO

Parameters:

enumCArmPositionerTabletopRelationship - the enum CArmPositionerTabletopRelationship

getCArmPositionerTabletopRelationship

public java.lang.String getCArmPositionerTabletopRelationship()

Sets C-arm Positioner TabletopRelationship.

Returns:

String - String value of C-arm Positioner TabletopRelationship

setAcquiredImageAreaDoseProduct

public void setAcquiredImageAreaDoseProduct(float fAcquiredImageAreaDoseProduct)

Sets Acquired Image Area Dose Product

Parameters:

fAcquiredImageAreaDoseProduct - Float value of the Acquired Image Area Dose Product

getAcquiredImageAreaDoseProduct

public float getAcquiredImageAreaDoseProduct()

Retrieves Acquired Image Area Dose Product

Returns:

float - Float value of the Acquired Image Area Dose Product