cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class XRayTableModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.XRayTableModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class XRayTableModule
extends Module

\* This module contains Attributes that describe X-Ray images acquired with movement of the patient imaging table.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
XRayTableModule(IDataSet objIDataSet) Instantiates a new x ray table module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getTableAngle() Return angle of table plane in degrees relative to horizontal plane [Gravity plane].
java.lang.String[]	getTableLateralIncrement() Return Incremental change in Lateral position of the table relative to first frame of Multiframe image given in mm.
java.lang.String[]	getTableLongitudinalIncrement() Return Incremental change in Longitudinal position of the table relative to first frame of Multi-frame image in mm.
java.lang.String	getTableMotion() Return Table Motion.
java.lang.String[]	getTableVerticalIncrement() Return Incremental change in Vetical position of the table relative to first frame of Multiframe image given in mm.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setTableAngle(java.lang.String strTableAngle) Sets angle of table plane in degrees relative to horizontal plane [Gravity plane].
void	setTableLateralIncrement(java.lang.String[] arrStrLateralIncrement) Sets Incremental change in Lateral position of the table relative to first frame of Multiframe image given in mm.
void	setTableLongitudinalIncrement(java.lang.String[] arrStrLongitudinalIncrement) Sets Incremental change in Longitudinal position of the table relative to first frame of Multi-frame image in mm.
void	setTableMotion(EnumTableMotion enumTableMotion) Sets Table Motion value.
void	setTableVerticalIncrement(java.lang.String[] arrStrTableVerticalIncrement) Sets Incremental change in Vetical position of the table relative to first frame of Multiframe image given in mm.
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

XRayTableModule

public XRayTableModule(IDataSet objIDataSet)

Instantiates a new x ray table 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

setTableMotion

public void setTableMotion(EnumTableMotion enumTableMotion)

Sets Table Motion value. Defined terms: STATIC, DYNAMIC

Parameters:

enumTableMotion - Enum value of Table Motion

getTableMotion

public java.lang.String getTableMotion()

Return Table Motion.

Returns:

- String value of Table Motion

setTableVerticalIncrement

public void setTableVerticalIncrement(java.lang.String[] arrStrTableVerticalIncrement)

Sets Incremental change in Vetical position of the table relative to first frame of Multiframe image given in mm. Required if Table Motion is DYNAMIC.

Parameters:

arrStrTableVerticalIncrement - the arr str table vertical increment

getTableVerticalIncrement

public java.lang.String[] getTableVerticalIncrement()

Return Incremental change in Vetical position of the table relative to first frame of Multiframe image given in mm.

Returns:

String[] - String array of Table Vertical Increment

setTableLongitudinalIncrement

public void setTableLongitudinalIncrement(java.lang.String[] arrStrLongitudinalIncrement)

Sets Incremental change in Longitudinal position of the table relative to first frame of Multi-frame image in mm. Table motion towards LAO is positive.

Parameters:

arrStrLongitudinalIncrement - the arr str longitudinal increment

getTableLongitudinalIncrement

public java.lang.String[] getTableLongitudinalIncrement()

Return Incremental change in Longitudinal position of the table relative to first frame of Multi-frame image in mm. Table motion towards LAO is positive.

Returns:

String[] - String array of Table Longitudinal Increment

setTableLateralIncrement

public void setTableLateralIncrement(java.lang.String[] arrStrLateralIncrement)

Sets Incremental change in Lateral position of the table relative to first frame of Multiframe image given in mm. Table motion towards CRA is positive. Required if Table Motion is DYNAMIC.

Parameters:

arrStrLateralIncrement - the arr str lateral increment

getTableLateralIncrement

public java.lang.String[] getTableLateralIncrement()

Return Incremental change in Lateral position of the table relative to first frame of Multiframe image given in mm.

Returns:

String[] - String array of Table Lateral Increment

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

Parameters:

strTableAngle - the str table angle

getTableAngle

public java.lang.String getTableAngle()

Return angle of table plane in degrees relative to horizontal plane [Gravity plane].

Returns:

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