cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class XAPositionerModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.XAPositionerModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class XAPositionerModule
extends Module

\* This module contains IOD Attributes that describe a c-arm positioner typically used in acquiring X-Ray Angiographic Images.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
XAPositionerModule(IDataSet objIDataSet) Instantiates a new xA positioner module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDetectorPrimaryAngle() Return position of the X-Ray Image Intensifier about the patient from the RAO to LAO direction where movement from RAO to vertical is positive.
java.lang.String	getDetectorSecondaryAngle() Return Angle of the X-Ray beam in the column direction in degrees relative to the normal to the detector plane.
java.lang.String	getDistanceSourceToDetector() Return Distance in mm from source to detector.
java.lang.String	getDistanceSourceToPatient() Return Distance in mm from source to isocenter.
java.lang.String	getEstimatedRadiographicMagnificationFactor() Return Ratio of Source Image Receptor Distance (SID) over Source Object Distance (SOD).
java.lang.String	getPositionerMotion() Return the activity of the imaging devices.
java.lang.String	getPositionerPrimaryAngle() Return position of the X-Ray Image Intensifier about the patient from the RAO to LAO direction where movement from RAO to vertical is positive.
java.lang.String[]	getPositionerPrimaryAngleIncrement() Return Incremental change in primary positioner angle for each frame.
java.lang.String	getPositionerSecondaryAngle() Return position of the X-Ray Image Intensifier about the patient from the CAU to CRA direction where movement from CAU to vertical is positive.
java.lang.String[]	getPositionerSecondaryAngleIncrement() Return Incremental change in primary positioner angle for each frame.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setDetectorPrimaryAngle(java.lang.String strDetectorPrimaryAngle) Sets angle of the X-Ray beam in the row direction in degrees relative to the normal to the detector plane.
void	setDetectorSecondaryAngle(java.lang.String strDetectorSecondaryAngle) Sets Angle of the X-Ray beam in the column direction in degrees relative to the normal to the detector plane.
void	setDistanceSourceToDetector(java.lang.String strDistanceSourceToDetector) Sets Distance in mm from source to detector.
void	setDistanceSourceToPatient(java.lang.String strDistanceSourceToPatient) Sets Distance in mm from source to isocenter.
void	setEstimatedRadiographicMagnificationFactor(java.lang.String strEstimatedRadiographicMagnificationFactor) Sets Ratio of Source Image Receptor Distance (SID) over Source Object Distance (SOD).
void	setPositionerMotion(EnumPositionerMotion enumPositionerMotion) Sets value that is used to describe the activity of the imaging devices.
void	setPositionerPrimaryAngle(java.lang.String strPositionerPrimaryAngle) Sets position of the X-Ray Image Intensifier about the patient from the RAO to LAO direction where movement from RAO to vertical is positive.
void	setPositionerPrimaryAngleIncrement(java.lang.String[] arrStrPositionerPrimaryAngleIncrement) Sets Incremental change in primary positioner angle for each frame.
void	setPositionerSecondaryAngle(java.lang.String strPositionerSecondaryAngle) Sets position of the X-Ray Image Intensifier about the patient from the CAU to CRA direction where movement from CAU to vertical is positive.
void	setPositionerSecondaryAngleIncrement(java.lang.String[] arrStrPositionerSecondaryAngleIncrement) Sets Incremental change in secondary positioner angle for each frame.
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

XAPositionerModule

public XAPositionerModule(IDataSet objIDataSet)

Instantiates a new xA positioner 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

setDistanceSourceToPatient

public void setDistanceSourceToPatient(java.lang.String strDistanceSourceToPatient)

Sets Distance in mm from source to isocenter.

Parameters:

strDistanceSourceToPatient - the str distance source to patient

getDistanceSourceToPatient

public java.lang.String getDistanceSourceToPatient()

Return Distance in mm from source to isocenter.

Returns:

String - String value of Distance Source to Patient

setDistanceSourceToDetector

public void setDistanceSourceToDetector(java.lang.String strDistanceSourceToDetector)

Sets Distance in mm from source to detector.

Parameters:

strDistanceSourceToDetector - the str distance source to detector

getDistanceSourceToDetector

public java.lang.String getDistanceSourceToDetector()

Return Distance in mm from source to detector.

Returns:

String - String value of Distance Source to detector

setEstimatedRadiographicMagnificationFactor

public void setEstimatedRadiographicMagnificationFactor(java.lang.String strEstimatedRadiographicMagnificationFactor)

Sets Ratio of Source Image Receptor Distance (SID) over Source Object Distance (SOD).

Parameters:

strEstimatedRadiographicMagnificationFactor - the str estimated radiographic magnification factor

getEstimatedRadiographicMagnificationFactor

public java.lang.String getEstimatedRadiographicMagnificationFactor()

Return Ratio of Source Image Receptor Distance (SID) over Source Object Distance (SOD).

Returns:

String - String value of Estimated Radiographic Magnification Factor

setPositionerMotion

public void setPositionerMotion(EnumPositionerMotion enumPositionerMotion)

Sets value that is used to describe the activity of the imaging devices. Defined terms: DYNAMIC, STATIC. Required if Multi-frame data.

Parameters:

enumPositionerMotion - enum value of Positioner Motion

getPositionerMotion

public java.lang.String getPositionerMotion()

Return the activity of the imaging devices.

Returns:

String - String value of Positioner Motion

setPositionerPrimaryAngle

public void setPositionerPrimaryAngle(java.lang.String strPositionerPrimaryAngle)

Sets position of the X-Ray Image Intensifier about the patient from the RAO to LAO direction where movement from RAO to vertical is positive.

Parameters:

strPositionerPrimaryAngle - the str positioner primary angle

getPositionerPrimaryAngle

public java.lang.String getPositionerPrimaryAngle()

Return position of the X-Ray Image Intensifier about the patient from the RAO to LAO direction where movement from RAO to vertical is positive.

Returns:

String - String value of Positioner Primary Angle

setPositionerSecondaryAngle

public void setPositionerSecondaryAngle(java.lang.String strPositionerSecondaryAngle)

Sets position of the X-Ray Image Intensifier about the patient from the CAU to CRA direction where movement from CAU to vertical is positive.

Parameters:

strPositionerSecondaryAngle - the str positioner secondary angle

getPositionerSecondaryAngle

public java.lang.String getPositionerSecondaryAngle()

Return position of the X-Ray Image Intensifier about the patient from the CAU to CRA direction where movement from CAU to vertical is positive.

Returns:

String - String value of Positioner Secondary Angle

setPositionerPrimaryAngleIncrement

public void setPositionerPrimaryAngleIncrement(java.lang.String[] arrStrPositionerPrimaryAngleIncrement)

Sets Incremental change in primary positioner angle for each frame. Required if Positioner Motion is DYNAMIC.

Parameters:

arrStrPositionerPrimaryAngleIncrement - the arr str positioner primary angle increment

getPositionerPrimaryAngleIncrement

public java.lang.String[] getPositionerPrimaryAngleIncrement()

Return Incremental change in primary positioner angle for each frame.

Returns:

String[] - String array of Positioner Primary Angle Increment

setPositionerSecondaryAngleIncrement

public void setPositionerSecondaryAngleIncrement(java.lang.String[] arrStrPositionerSecondaryAngleIncrement)

Sets Incremental change in secondary positioner angle for each frame. Required if Positioner Motion is DYNAMIC.

Parameters:

arrStrPositionerSecondaryAngleIncrement - the arr str positioner secondary angle increment

getPositionerSecondaryAngleIncrement

public java.lang.String[] getPositionerSecondaryAngleIncrement()

Return Incremental change in primary positioner angle for each frame.

Returns:

String[] - String array of Positioner Secondary Angle Increment

setDetectorPrimaryAngle

public void setDetectorPrimaryAngle(java.lang.String strDetectorPrimaryAngle)

Sets angle of the X-Ray beam in the row direction in degrees relative to the normal to the detector plane. Positive values indicate that the X-Ray beam is tilted towards higher numbered columns. Negative values indicate that the X-Ray beam is tilted towards lower numbered columns.

Parameters:

strDetectorPrimaryAngle - the str detector primary angle

getDetectorPrimaryAngle

public java.lang.String getDetectorPrimaryAngle()

Return position of the X-Ray Image Intensifier about the patient from the RAO to LAO direction where movement from RAO to vertical is positive.

Returns:

String - String value of Positioner Primary Angle

setDetectorSecondaryAngle

public void setDetectorSecondaryAngle(java.lang.String strDetectorSecondaryAngle)

Sets Angle of the X-Ray beam in the column direction in degrees relative to the normal to the detector plane. Positive values indicate that the X-Ray beam is tilted towards lower numbered rows. Negative values indicate that the X-Ray beam is tilted towards higher numbered rows.

Parameters:

strDetectorSecondaryAngle - the str detector secondary angle

getDetectorSecondaryAngle

public java.lang.String getDetectorSecondaryAngle()

Return Angle of the X-Ray beam in the column direction in degrees relative to the normal to the detector plane.

Returns:

String - String value of Detector Secondary Angle

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