cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class DXPositioningModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.DXPositioningModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class DXPositioningModule
extends Module

\* This module contains IOD Attributes that describe the positioning used in acquiring Digital X-Ray Images.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DXPositioningModule(IDataSet objIDataSet) Instantiates a new dX positioning module.

Method Summary

Methods

Modifier and Type	Method and Description
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	getColumnAngulation() Retrievs angle of the X-Ray beam in degree relative to an orthogonal axis to the detector plane.
java.lang.String	getCompressionForce() Retrievs the compression force applied to the body part during exposure, measured in Newtons.
java.lang.String	getDetectorPrimaryAngle() Retrievs angle of the X-Ray beam in the row direction in degrees relative to the normal to the detector plane.
java.lang.String	getDetectorSecondaryAngle() Retrievs 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 transmission source to the detector face.
java.lang.String	getDistanceSourceToPatient() Retrieves 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	getPaddleDescription() Return user-defined label identifier for Paddle Description.
PatientGantryRelationshipCodeSequence	getPatientGantryRelationshipCodeSequence() Return Sequence which describes the orientation of the patient with respect to the gantry.
PatientOrientationCodeSequence	getPatientOrientationCodeSequence() Return Sequence that describes the orientation of the patient with respect to gravity.
java.lang.String	getPatientPosition() Retrieves description of imaging subjects position relative to the equipment.
java.lang.String	getPositionerPrimaryAngle() Sets position of the X-Ray beam about the patient from the RAO to LAO direction where movement from RAO to vertical is positive, if Positioner Type (0018,1508) is CARM.
java.lang.String	getPositionerSecondaryAngle() Retrievs position of the X-Ray beam about the patient from the CAU to CRA direction where movement from RAO to vertical is positive, if Positioner Type (0018,1508) is CARM.
java.lang.String	getPositionerType() Sets Positioner Type.
ProjectionEponymousNameCodeSequence	getProjectionEponymousNameCodeSequence() Return a Sequence that describes the radiographic method of patient, tube and detector positioning to achieve a well described projection or view.
java.lang.String	getTableAngle() Retrievs angle of table plane in degrees relative to horizontal plane [Gravity plane].
java.lang.String	getTableType() Retrievs Table Type.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
ViewCodeSequence	getViewCodeSequence() Return Sequence that describes the projection of the anatomic region of interest on the image receptor.
java.lang.String	getViewPosition() Retrieves radiographic view of the image relative to the imaging subjects orientation.
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	setColumnAngulation(java.lang.String strColumnAngulation) Sets angle of the X-Ray beam in degree relative to an orthogonal axis to the detector plane.
void	setCompressionForce(java.lang.String strCompressionForce) Sets the compression force applied to the body part during exposure, measured in Newtons.
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 transmission source to the detector face.
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	setPaddleDescription(java.lang.String strPaddleDescription) Sets Paddle Description
void	setPatientPosition(EnumPatientPosition enumPatientPosition) Sets description of imaging subjects position relative to the equipment.
void	setPositionerPrimaryAngle(java.lang.String strPositionerPrimaryAngle) Sets position of the X-Ray beam about the patient from the RAO to LAO direction where movement from RAO to vertical is positive, if Positioner Type (0018,1508) is CARM.
void	setPositionerSecondaryAngle(java.lang.String strPositionerSecondaryAngle) Sets Position of the X-Ray beam about the patient from the CAU to CRA direction where movement from CAU to vertical is positive, if Positioner Type (0018,1508) is CARM.
void	setPositionerType(EnumPositionerType enumPositionerType) Sets Positioner Type.
void	setTableAngle(java.lang.String strTableAngle) Sets angle of table plane in degrees relative to horizontal plane [Gravity plane].
void	setTableType(EnumTableType enumTableType) Sets Table Type.
void	setViewPosition(EnumViewPosition enumViewPosition) Sets radiographic view of the image relative to the imaging subjects orientation.
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

DXPositioningModule

public DXPositioningModule(IDataSet objIDataSet)

Instantiates a new dX positioning 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:

true, if validate module

Throws:

InvalidModuleException - - If validation of Module fails

getProjectionEponymousNameCodeSequence

public ProjectionEponymousNameCodeSequence getProjectionEponymousNameCodeSequence()

Return a Sequence that describes the radiographic method of patient, tube and detector positioning to achieve a well described projection or view.

Returns:

- instance of ProjectionEponymousNameCodeSequence

setPatientPosition

public void setPatientPosition(EnumPatientPosition enumPatientPosition)

Sets description of imaging subjects position relative to the equipment.

Parameters:

enumPatientPosition - the enum patient position

getPatientPosition

public java.lang.String getPatientPosition()

Retrieves description of imaging subjects position relative to the equipment.

Returns:

the patient position

setViewPosition

public void setViewPosition(EnumViewPosition enumViewPosition)

Sets radiographic view of the image relative to the imaging subjects orientation.

Parameters:

enumViewPosition - the enum view position

getViewPosition

public java.lang.String getViewPosition()

Retrieves radiographic view of the image relative to the imaging subjects orientation.

Returns:

the view position

getViewCodeSequence

public ViewCodeSequence getViewCodeSequence()

Return Sequence that describes the projection of the anatomic region of interest on the image receptor.

Returns:

- instance of ViewCodeSequence

getPatientOrientationCodeSequence

public PatientOrientationCodeSequence getPatientOrientationCodeSequence()

Return Sequence that describes the orientation of the patient with respect to gravity.

Returns:

- instance of PatientOrientationCodeSequence

getPatientGantryRelationshipCodeSequence

public PatientGantryRelationshipCodeSequence getPatientGantryRelationshipCodeSequence()

Return Sequence which describes the orientation of the patient with respect to the gantry.

Returns:

- instance of PatientGantryRelationshipCodeSequence

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 value of Distance of Source To Patient

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 - - String value of 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

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

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

setPositionerPrimaryAngle

public void setPositionerPrimaryAngle(java.lang.String strPositionerPrimaryAngle)

Sets position of the X-Ray beam about the patient from the RAO to LAO direction where movement from RAO to vertical is positive, if Positioner Type (0018,1508) is CARM.

Parameters:

strPositionerPrimaryAngle - - String value of Positioner Primary Angle

getPositionerPrimaryAngle

public java.lang.String getPositionerPrimaryAngle()

Sets position of the X-Ray beam about the patient from the RAO to LAO direction where movement from RAO to vertical is positive, if Positioner Type (0018,1508) is CARM.

Returns:

String - String value of Positioner Primary Angle

setPositionerSecondaryAngle

public void setPositionerSecondaryAngle(java.lang.String strPositionerSecondaryAngle)

Sets Position of the X-Ray beam about the patient from the CAU to CRA direction where movement from CAU to vertical is positive, if Positioner Type (0018,1508) is CARM.

Parameters:

strPositionerSecondaryAngle - - String value of Positioner Secondary Angle

getPositionerSecondaryAngle

public java.lang.String getPositionerSecondaryAngle()

Retrievs position of the X-Ray beam about the patient from the CAU to CRA direction where movement from RAO to vertical is positive, if Positioner Type (0018,1508) is CARM.

Returns:

String - String value of Positioner Secondary Angle

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 toward higher numbered columns. Negative values indicate that the X-Ray beam is tilted toward lower numbered columns.

Parameters:

strDetectorPrimaryAngle - - String value of Detector Primary Angle

getDetectorPrimaryAngle

public java.lang.String getDetectorPrimaryAngle()

Retrievs angle of the X-Ray beam in the row direction in degrees relative to the normal to the detector plane.

Returns:

String - String value of Detector 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 toward lower numbered rows. Negative values indicate that the X-Ray beam is tilted toward higher numbered rows.

Parameters:

strDetectorSecondaryAngle - - String value of Detector Secondary Angle

getDetectorSecondaryAngle

public java.lang.String getDetectorSecondaryAngle()

Retrievs 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

setColumnAngulation

public void setColumnAngulation(java.lang.String strColumnAngulation)

Sets angle of the X-Ray beam in degree relative to an orthogonal axis to the detector plane. Positive values indicate that the tilt is toward the head of the table.

Parameters:

strColumnAngulation - - String value of Column Angulation

getColumnAngulation

public java.lang.String getColumnAngulation()

Retrievs angle of the X-Ray beam in degree relative to an orthogonal axis to the detector plane. Positive values indicate that the tilt is toward the head of the table.

Returns:

String - String value of Column Angulation

setTableType

public void setTableType(EnumTableType enumTableType)

Sets Table Type. Defined Terms: FIXED TILTING NONE

Parameters:

enumTableType - the enum table type

getTableType

public java.lang.String getTableType()

Retrievs Table Type.

Returns:

String - String value of Table Type.

setTableAngle

public void setTableAngle(java.lang.String strTableAngle)

Sets angle of table plane in degrees relative to horizontal plane [Gravity plane]. Positive values indicate that the head of the table is upward.

Parameters:

strTableAngle - - String value of Table Angle.

getTableAngle

public java.lang.String getTableAngle()

Retrievs angle of table plane in degrees relative to horizontal plane [Gravity plane]. Positive values indicate that the head of the table is upward.

Returns:

String - String value of Table Angle.

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

setCompressionForce

public void setCompressionForce(java.lang.String strCompressionForce)

Sets the compression force applied to the body part during exposure, measured in Newtons.

Parameters:

strCompressionForce - - String value of Compression Force

getCompressionForce

public java.lang.String getCompressionForce()

Retrievs the compression force applied to the body part during exposure, measured in Newtons.

Returns:

String - String value of Compression Force

setPaddleDescription

public void setPaddleDescription(java.lang.String strPaddleDescription)

Sets Paddle Description

Parameters:

strPaddleDescription - String value of Plate ID.

getPaddleDescription

public java.lang.String getPaddleDescription()

Return user-defined label identifier for Paddle Description.

Returns:

String - value of Paddle Description.

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:

- the customized collection containing the dataelement tags that beling to this module