cdac.medinfo.sdk.dcm30_04.baselibs

Class ControlPointSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.ControlPointSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class ControlPointSequenceItem
extends Item

This item class contains the methods to set,get and validate the attribute present in Control Point Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBeamLimitingDeviceAngle() Retrieves Beam Limiting Device Angle.
BeamLimitingDevicePositionSequence	getBeamLimitingDevicePositionSequence() Retrieves pre-initialized object of Beam Limiting Device Position Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
java.lang.String	getBeamLimitingDeviceRotationDirection() Retrieves Beam Limiting Device Rotation Direction.
java.lang.String	getControlPointIndex() Retrieves Index of current Control Point, starting at 0 for first Control Point.
java.lang.String	getCumulativeMetersetWeight() Retrieves Cumulative weight to current control point.
java.lang.String	getDoseRateSet() Retrieves Dose Rate to be set on treatment machine for segment beginning at current control point (e.g.
java.lang.String	getGantryAngle() Retrieves Gantry angle of radiation source.
java.lang.String	getGantryRotationDirection() Retrieves Gantry Rotation Direction.
java.lang.String[]	getIsocenterPosition() Retrieves Isocenter coordinates (x,y,z) in the patient based coordinate system.
java.lang.String	getNominalBeamEnergy() Retrieves Nominal Beam Energy at control point (MV/MeV).
java.lang.String	getPatientSupportAngle() Retrieves Patient Support Angle.
java.lang.String	getPatientSupportRotationDirection() Retrieves Patient Support Rotation Direction.
ReferencedDoseReferenceSequence	getReferencedDoseReferenceSequence() Retrieves pre-initialized object of Referenced Dose Reference Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
float	getSourcetoExternalContourDistance() Retrieves the Ratio of displayed pixels to source pixels,specified in one dimension.
java.lang.String	getSourcetoSurfaceDistance() Retrieves Source to Patient Surface distance (mm).
java.lang.String[]	getSurfaceEntryPoint() Retrieves Patient surface entry point coordinates (x,y,z) in the patient based coordinate system .
java.lang.String	getTableTopEccentricAngle() Retrieves Table Top Eccentric Angle.
java.lang.String	getTableTopEccentricAxisDistance() Retrieves Table Top Eccentric Axis Distance.
java.lang.String	getTableTopEccentricRotationDirection() Retrieves Table Top Eccentric Rotation Direction.
java.lang.String	getTableTopLateralPosition() Retrieves Table Top Lateral Position.
java.lang.String	getTableTopLongitudinalPosition() Retrieves Table Top Longitudinal Position.
float	getTableTopPitchAngle() Retrieves fTableTopPitchAngle
java.lang.String	getTableTopPitchRotationDirection() Retrieves type of the value encoded in this Item
float	getTableTopRollAngle() Retrieves the Ratio of displayed pixels to source pixels,specified in one dimension.
java.lang.String	getTableTopRollRotationDirection() Retrieves type of the value encoded in this Item
java.lang.String	getTableTopVerticalPosition() Retrieves Table Top Vertical Position.
WedgePositionSequence	getWedgePositionSequence() Retrieves pre-initialized object of Wedge Position Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
void	setBeamLimitingDeviceAngle(java.lang.String strBeamLimitingDeviceAngle) Sets Beam Limiting Device Angle.
void	setBeamLimitingDeviceRotationDirection(EnumBeamLimitingDeviceRotationDirection enumBeamLimitingDeviceRotationDirection) Sets Beam Limiting Device Rotation Direction.
void	setControlPointIndex(java.lang.String strControlPointIndex) Sets Index of current Control Point, starting at 0 for first Control Point.
void	setCumulativeMetersetWeight(java.lang.String strCumulativeMetersetWeight) Sets Cumulative weight to current control point.
void	setDoseRateSet(java.lang.String strDoseRateSet) Sets Dose Rate to be set on treatment machine for segment beginning at current control point (e.g.
void	setGantryAngle(java.lang.String strGantryAngle) Sets Gantry angle of radiation source, i.e.
void	setGantryRotationDirection(EnumGantryRotationDirection enumGantryRotationDirection) Sets Gantry Rotation Direction.
void	setIsocenterPosition(java.lang.String[] arrIsocenterPosition) Sets Isocenter coordinates (x,y,z) in the patient based coordinate system.
void	setNominalBeamEnergy(java.lang.String strNominalBeamEnergy) Sets Nominal Beam Energy at control point (MV/MeV).
void	setPatientSupportAngle(java.lang.String strPatientSupportAngle) Sets Patient Support Angle.
void	setPatientSupportRotationDirection(EnumPatientSupportRotationDirection enumPatientSupportRotationDirection) Sets Patient Support Rotation Direction.
void	setSourcetoExternalContourDistance(float fSourcetoExternalContourDistance) Sets source to External Contour distance (mm) including devices associatedwith the patient anatomy model.
void	setSourcetoSurfaceDistance(java.lang.String strSourcetoSurfaceDistance) Sets Source to Patient Surface distance (mm).
void	setSurfaceEntryPoint(java.lang.String[] arrSurfaceEntryPoint) Sets Patient surface entry point coordinates (x,y,z) in the patient based coordinate system .
void	setTableTopEccentricAngle(java.lang.String strTableTopEccentricAngle) Sets Table Top Eccentric Angle.
void	setTableTopEccentricAxisDistance(java.lang.String strTableTopEccentricAxisDistance) Sets Table Top Eccentric Axis Distance.
void	setTableTopEccentricRotationDirection(EnumTableTopEccentricRotationDirection enumTableTopEccentricRotationDirection) Sets Table Top Eccentric Rotation Direction.
void	setTableTopLateralPosition(java.lang.String strTableTopLateralPosition) Sets Table Top Lateral Position.
void	setTableTopLongitudinalPosition(java.lang.String strTableTopLongitudinalPosition) Sets Table Top Longitudinal Position.
void	setTableTopPitchAngle(float fTableTopPitchAngle) Sets the Ratio of displayed pixels to source pixels,specified in one dimension.
void	setTableTopPitchRotationDirection(EnumTableTopPitchRotationDirection enumTableTopPitchRotationDirection) Sets Direction of Table Top Pitch Rotation when viewing the table along the positive X-axis of the IEC TABLE TOP coordinate system, for segmentfollowing Control Point.
void	setTableTopRollAngle(float fTableTopRollAngle) Sets Table Top Roll Angle, i.e., the rotation of the IEC TABLE TOP coordinatesystem about the IEC Y-axis of the IEC TABLE TOP coordinate system(degrees).
void	setTableTopRollRotationDirection(EnumTableTopRollRotationDirection enumTableTopRollRotationDirection) Sets Direction of Table Top Pitch Rotation when viewing the table along the positive X-axis of the IEC TABLE TOP coordinate system, for segmentfollowing Control Point.
void	setTableTopVerticalPosition(java.lang.String strTableTopVerticalPosition) Sets Table Top Vertical Position.
boolean	validateForModule() Validates all the attributes in ControlPointSequenceItem that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Item

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setControlPointIndex

public void setControlPointIndex(java.lang.String strControlPointIndex)

Sets Index of current Control Point, starting at 0 for first Control Point.

Parameters:

strControlPointIndex - String value of Control Point Index.

getControlPointIndex

public java.lang.String getControlPointIndex()

Retrieves Index of current Control Point, starting at 0 for first Control Point.

Returns:

String - value of Control Point Index.

setCumulativeMetersetWeight

public void setCumulativeMetersetWeight(java.lang.String strCumulativeMetersetWeight)

Sets Cumulative weight to current control point. It is always zero for first item in Control Point Sequence and Cumulative Meterset Weight for the final item in Control Point Sequence shall always be equal to Final Cumulative Meterset Weight.

Parameters:

strCumulativeMetersetWeight - String value of Cumulative Meterset Weight.

getCumulativeMetersetWeight

public java.lang.String getCumulativeMetersetWeight()

Retrieves Cumulative weight to current control point.

Returns:

String - value of Cumulative Meterset Weight.

getReferencedDoseReferenceSequence

public ReferencedDoseReferenceSequence getReferencedDoseReferenceSequence()

Retrieves pre-initialized object of Referenced Dose Reference Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

ReferencedDoseReferenceSequence - instance of Referenced Dose Reference Sequence.

setNominalBeamEnergy

public void setNominalBeamEnergy(java.lang.String strNominalBeamEnergy)

Sets Nominal Beam Energy at control point (MV/MeV).

Parameters:

strNominalBeamEnergy - String value of Nominal Beam Energy.

getNominalBeamEnergy

public java.lang.String getNominalBeamEnergy()

Retrieves Nominal Beam Energy at control point (MV/MeV).

Returns:

String - value of Nominal Beam Energy.

setDoseRateSet

public void setDoseRateSet(java.lang.String strDoseRateSet)

Sets Dose Rate to be set on treatment machine for segment beginning at current control point (e.g. MU/min).

Parameters:

strDoseRateSet - String value of Dose Rate Set.

getDoseRateSet

public java.lang.String getDoseRateSet()

Retrieves Dose Rate to be set on treatment machine for segment beginning at current control point (e.g. MU/min).

Returns:

String - value of Dose Rate Set.

getWedgePositionSequence

public WedgePositionSequence getWedgePositionSequence()

Retrieves pre-initialized object of Wedge Position Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

WedgePositionSequence - instance of Wedge Position Sequence.

getBeamLimitingDevicePositionSequence

public BeamLimitingDevicePositionSequence getBeamLimitingDevicePositionSequence()

Retrieves pre-initialized object of Beam Limiting Device Position Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

BeamLimitingDevicePositionSequence - instance of Beam Limiting Device Position Sequence.

setGantryAngle

public void setGantryAngle(java.lang.String strGantryAngle)

Sets Gantry angle of radiation source, i.e. orientation of IEC GANTRY coordinate system with respect to IEC FIXED REFERENCE coordinate system (degrees).

Parameters:

strGantryAngle - String value of Gantry Angle.

getGantryAngle

public java.lang.String getGantryAngle()

Retrieves Gantry angle of radiation source.

Returns:

String - value of Gantry Angle.

setGantryRotationDirection

public void setGantryRotationDirection(EnumGantryRotationDirection enumGantryRotationDirection)

Sets Gantry Rotation Direction. Direction of Gantry Rotation when viewing gantry from isocenter, for segment beginning at current Control Point. Enumerated Values: CW = clockwise CC = counter-clockwise NONE = no rotation

Parameters:

enumGantryRotationDirection - Enum value of Gantry Rotation Direction.

getGantryRotationDirection

public java.lang.String getGantryRotationDirection()

Retrieves Gantry Rotation Direction.

Returns:

String - value of Gantry Rotation Direction.

setBeamLimitingDeviceAngle

public void setBeamLimitingDeviceAngle(java.lang.String strBeamLimitingDeviceAngle)

Sets Beam Limiting Device Angle. i.e. orientation of IEC BEAM LIMITING DEVICE coordinate system with respect to IEC GANTRY coordinate system (degrees).

Parameters:

strBeamLimitingDeviceAngle - String value of Beam Limiting Device Angle.

getBeamLimitingDeviceAngle

public java.lang.String getBeamLimitingDeviceAngle()

Retrieves Beam Limiting Device Angle.

Returns:

String - value of Beam Limiting Device Angle.

setBeamLimitingDeviceRotationDirection

public void setBeamLimitingDeviceRotationDirection(EnumBeamLimitingDeviceRotationDirection enumBeamLimitingDeviceRotationDirection)

Sets Beam Limiting Device Rotation Direction. Direction of Beam Limiting Device Rotation when viewing beam limiting device (collimator) from radiation source, for segment beginning at current Control Point. Enumerated Values: CW = clockwise, CC = counter-clockwise, NONE = no rotation.

Parameters:

enumBeamLimitingDeviceRotationDirection - Enum value of Beam Limiting Device Rotation Direction.

getBeamLimitingDeviceRotationDirection

public java.lang.String getBeamLimitingDeviceRotationDirection()

Retrieves Beam Limiting Device Rotation Direction.

Returns:

String - value of Beam Limiting Device Rotation Direction.

setPatientSupportAngle

public void setPatientSupportAngle(java.lang.String strPatientSupportAngle)

Sets Patient Support Angle. i.e. orientation of IEC PATIENT SUPPORT (turntable) coordinate system with respect to IEC FIXED REFERENCE coordinate system (degrees).

Parameters:

strPatientSupportAngle - String value of Patient Support Angle.

getPatientSupportAngle

public java.lang.String getPatientSupportAngle()

Retrieves Patient Support Angle.

Returns:

String - value of Patient Support Angle.

setPatientSupportRotationDirection

public void setPatientSupportRotationDirection(EnumPatientSupportRotationDirection enumPatientSupportRotationDirection)

Sets Patient Support Rotation Direction. Direction of Patient Support Rotation when viewing table from above, for segment beginning at current Control Point. Enumerated Values: CW = clockwise, CC = counter-clockwise, NONE = no rotation.

Parameters:

enumPatientSupportRotationDirection - Enum value of Patient Support Rotation Direction.

getPatientSupportRotationDirection

public java.lang.String getPatientSupportRotationDirection()

Retrieves Patient Support Rotation Direction.

Returns:

String - value of Patient Support Rotation Direction.

setTableTopEccentricAxisDistance

public void setTableTopEccentricAxisDistance(java.lang.String strTableTopEccentricAxisDistance)

Sets Table Top Eccentric Axis Distance. Distance (positive) from the IEC PATIENT SUPPORT vertical axis to the IEC TABLE TOP ECCENTRIC vertical axis (mm).

Parameters:

strTableTopEccentricAxisDistance - String value of Table Top Eccentric Axis Distance.

getTableTopEccentricAxisDistance

public java.lang.String getTableTopEccentricAxisDistance()

Retrieves Table Top Eccentric Axis Distance.

Returns:

String - value of Table Top Eccentric Axis Distance.

setTableTopEccentricAngle

public void setTableTopEccentricAngle(java.lang.String strTableTopEccentricAngle)

Sets Table Top Eccentric Angle. Table Top (non-isocentric) angle, i.e. orientation of IEC TABLE TOP ECCENTRIC coordinate system with respect to IEC PATIENT SUPPORT coordinate system (degrees).

Parameters:

strTableTopEccentricAngle - String value of Table Top Eccentric Angle.

getTableTopEccentricAngle

public java.lang.String getTableTopEccentricAngle()

Retrieves Table Top Eccentric Angle.

Returns:

String - value of Table Top Eccentric Angle.

setTableTopEccentricRotationDirection

public void setTableTopEccentricRotationDirection(EnumTableTopEccentricRotationDirection enumTableTopEccentricRotationDirection)

Sets Table Top Eccentric Rotation Direction. Direction of Table Top Eccentric Rotation when viewing table from above, for segment beginning at current Control Point. Enumerated Values: CW = clockwise, CC = counter-clockwise, NONE = no rotation.

Parameters:

enumTableTopEccentricRotationDirection - Enum value of Table Top Eccentric Rotation Direction.

getTableTopEccentricRotationDirection

public java.lang.String getTableTopEccentricRotationDirection()

Retrieves Table Top Eccentric Rotation Direction.

Returns:

String - value of Table Top Eccentric Rotation Direction.

setTableTopPitchAngle

public void setTableTopPitchAngle(float fTableTopPitchAngle)

Sets the Ratio of displayed pixels to source pixels,specified in one dimension.

Parameters:

fTableTopPitchAngle - Float value of the Ratio of displayed pixels to source pixels

getTableTopPitchAngle

public float getTableTopPitchAngle()

Retrieves fTableTopPitchAngle

Returns:

float - Float value of the Ratio of displayed pixels to source pixels

setTableTopPitchRotationDirection

public void setTableTopPitchRotationDirection(EnumTableTopPitchRotationDirection enumTableTopPitchRotationDirection)

Sets Direction of Table Top Pitch Rotation when viewing the table along the positive X-axis of the IEC TABLE TOP coordinate system, for segmentfollowing Control Point.

Parameters:

strValueType - Specifies type of the value encoded in this Item

getTableTopPitchRotationDirection

public java.lang.String getTableTopPitchRotationDirection()

Retrieves type of the value encoded in this Item

Returns:

String - Type of the value encoded in this Item

setTableTopRollAngle

public void setTableTopRollAngle(float fTableTopRollAngle)

Sets Table Top Roll Angle, i.e., the rotation of the IEC TABLE TOP coordinatesystem about the IEC Y-axis of the IEC TABLE TOP coordinate system(degrees).

Parameters:

fPresentationPixelMagnificationRatio - Float value of the Ratio of displayed pixels to source pixels

getTableTopRollAngle

public float getTableTopRollAngle()

Retrieves the Ratio of displayed pixels to source pixels,specified in one dimension.

Returns:

float - Float value of the Ratio of displayed pixels to source pixels

setTableTopRollRotationDirection

public void setTableTopRollRotationDirection(EnumTableTopRollRotationDirection enumTableTopRollRotationDirection)

Sets Direction of Table Top Pitch Rotation when viewing the table along the positive X-axis of the IEC TABLE TOP coordinate system, for segmentfollowing Control Point.

Parameters:

strValueType - Specifies type of the value encoded in this Item

getTableTopRollRotationDirection

public java.lang.String getTableTopRollRotationDirection()

Retrieves type of the value encoded in this Item

Returns:

String - Type of the value encoded in this Item

setTableTopVerticalPosition

public void setTableTopVerticalPosition(java.lang.String strTableTopVerticalPosition)

Sets Table Top Vertical Position. Table Top Vertical position in IEC TABLE TOP coordinate system (mm).

Parameters:

strTableTopVerticalPosition - String value of Table Top Vertical Position.

getTableTopVerticalPosition

public java.lang.String getTableTopVerticalPosition()

Retrieves Table Top Vertical Position.

Returns:

String - value of Table Top Vertical Position.

setTableTopLongitudinalPosition

public void setTableTopLongitudinalPosition(java.lang.String strTableTopLongitudinalPosition)

Sets Table Top Longitudinal Position. Table Top Longitudinal position in IEC TABLE TOP coordinate system (mm).

Parameters:

strTableTopLongitudinalPosition - String value of Table Top Longitudinal Position.

getTableTopLongitudinalPosition

public java.lang.String getTableTopLongitudinalPosition()

Retrieves Table Top Longitudinal Position.

Returns:

String - value of Table Top Longitudinal Position.

setTableTopLateralPosition

public void setTableTopLateralPosition(java.lang.String strTableTopLateralPosition)

Sets Table Top Lateral Position. Table Top Lateral position in IEC TABLE TOP coordinate system (mm).

Parameters:

strTableTopLateralPosition - String value of Table Top Lateral Position.

getTableTopLateralPosition

public java.lang.String getTableTopLateralPosition()

Retrieves Table Top Lateral Position.

Returns:

String - value of Table Top Lateral Position.

setIsocenterPosition

public void setIsocenterPosition(java.lang.String[] arrIsocenterPosition)

Sets Isocenter coordinates (x,y,z) in the patient based coordinate system.

Parameters:

arrIsocenterPosition - String array of Isocenter Position.

getIsocenterPosition

public java.lang.String[] getIsocenterPosition()

Retrieves Isocenter coordinates (x,y,z) in the patient based coordinate system.

Returns:

String - array of Isocenter Position.

setSurfaceEntryPoint

public void setSurfaceEntryPoint(java.lang.String[] arrSurfaceEntryPoint)

Sets Patient surface entry point coordinates (x,y,z) in the patient based coordinate system .

Parameters:

arrSurfaceEntryPoint - String array of Surface Entry Point.

getSurfaceEntryPoint

public java.lang.String[] getSurfaceEntryPoint()

Retrieves Patient surface entry point coordinates (x,y,z) in the patient based coordinate system .

Returns:

String - array of Surface Entry Point.

setSourcetoSurfaceDistance

public void setSourcetoSurfaceDistance(java.lang.String strSourcetoSurfaceDistance)

Sets Source to Patient Surface distance (mm).

Parameters:

strSourcetoSurfaceDistance - String value of Source to Surface Distance.

getSourcetoSurfaceDistance

public java.lang.String getSourcetoSurfaceDistance()

Retrieves Source to Patient Surface distance (mm).

Returns:

String - value of Source to Surface Distance

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in ControlPointSequenceItem that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.

setSourcetoExternalContourDistance

public void setSourcetoExternalContourDistance(float fSourcetoExternalContourDistance)

Sets source to External Contour distance (mm) including devices associatedwith the patient anatomy model.

Parameters:

fSourcetoExternalContourDistance - Float value of the Ratio of displayed pixels to source pixels

getSourcetoExternalContourDistance

public float getSourcetoExternalContourDistance()

Retrieves the Ratio of displayed pixels to source pixels,specified in one dimension.

Returns:

float - Float value of the Ratio of displayed pixels to source pixels