cdac.medinfo.sdk.dcm30_04.baselibs

Class ConventionalControlPointVerificationSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.ConventionalControlPointVerificationSequenceItem

All Implemented Interfaces:

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

public class ConventionalControlPointVerificationSequenceItem
extends Item

This item class contains the methods to set, get and validate the attribute present in Conventional Control PointVerification 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 type of the BeamLimitingDeviceRotationDirection value encoded in this Item
java.lang.String	getDoseRateSet() Retrieves Sets Dose Rate.
java.lang.String	getGantryAngle() Retrieves Gantry angle.
java.lang.String	getGantryRotationDirection() Retrieves type of the value encoded in this Item
java.lang.String	getNominalBeamEnergy() Retrieves Slice Thickness.
java.lang.String	getPatientSupportAngle() Retrieves PatientSupportAngle.
java.lang.String	getPatientSupportRotationDirection() Retrieves type of Value Patient Support Rotation Direction
java.lang.String	getReferencedControlPointIndex() Retrieves Referenced Control Point Index.
java.lang.String	getTableTopEccentricAngle() Retrieves Table Top Eccentric Axis Distance.
java.lang.String	getTableTopEccentricAxisDistance() Retrieves Table Top Eccentric Axis Distance.
java.lang.String	getTableTopEccentricRotationDirection() Retrieves type of the value encoded in this Item
java.lang.String	getTableTopLateralPosition() Retrieves Table Top Lateral Position
java.lang.String	getTableTopLongitudinalPosition() Retrieves Table Top Longitudinal Position
float[]	getTableTopPitchAngle() Retrieves Table Top Pitch Angle.
java.lang.String	getTableTopPitchRotationDirection() Retrieves Table Top Pitch Rotation Direction
float[]	getTableTopRollAngle() Retrieves Table Top Roll Angle.
java.lang.String	getTableTopRollRotationDirection() Retrieves type of the Table Top Roll Rotation Direction 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 Beam Limiting Device angle in degrees.
void	setBeamLimitingDeviceRotationDirection(EnumBeamLimitingDeviceRotationDirection enumBeamLimitingDeviceRotationDirection) Sets the Value Type Defined in Terms of Enum Enumerated Values: CW - clockwise CC - counter-clockwise NONE - no rotation
void	setDoseRateSet(java.lang.String strDoseRateSet) Sets Dose Rate to be set on treatment machine.
void	setGantryAngle(java.lang.String strGantryAngle) Sets Gantry Angle.Gantry angle in degrees of radiation source, orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system.
void	setGantryRotationDirection(EnumGantryRotationDirection enumGantryRotationDirection) Sets the Value Type Defined in Terms of Enum Enumerated Values: CW - clockwise CC - counter-clockwise NONE - no rotation
void	setNominalBeamEnergy(java.lang.String strNominalBeamEnergy) Sets Nominal Beam Energy at control point.
void	setPatientSupportAngle(java.lang.String strPatientSupportAngle) Sets PatientSupportAngle.
void	setPatientSupportRotationDirection(EnumPatientSupportRotationDirection enumPatientSupportRotationDirection) Sets the Value Patient Support Rotation Direction
void	setReferencedControlPointIndex(java.lang.String strReferencedControlPointIndex) Sets Referenced Control Point Index.
void	setTableTopEccentricAngle(java.lang.String strTableTopEccentricAngle) Sets Table Top EccentricAxisDistance.Uniquely identifies 0x300A,0x0125
void	setTableTopEccentricAxisDistance(java.lang.String strTableTopEccentricAxisDistance) Sets Table Top EccentricAxisDistance.Uniquely identifies 0x300A,0x0124
void	setTableTopEccentricRotationDirection(EnumTableTopEccentricRotationDirection enumTableTopEccentricRotationDirection) Sets the TableTopEccentricRotationDirection in Terms of TEXT
void	setTableTopLateralPosition(java.lang.String strTableTopLateralPosition) Sets TableTopLateralPosition
void	setTableTopLongitudinalPosition(java.lang.String strTableTopLongitudinalPosition) Sets TableTopLongitudinalPosition
void	setTableTopPitchAngle(float[] arrTableTopPitchAngle) Sets a pair of floating point numbers specifying the Table Top PitchAngle Table Top Pitch Angle in degrees.
void	setTableTopPitchRotationDirection(EnumTableTopPitchRotationDirection enumTableTopPitchRotationDirection) Sets the TableTopPitchRotationDirection Defined in Terms of TEXT
void	setTableTopRollAngle(float[] arrTableTopRollAngle) Table Top Roll Angle in degrees, i.e., The rotation of the IEC TABLE TOP coordinate system about the Y-axis of the IEC TABLE TOP coordinate system.
void	setTableTopRollRotationDirection(EnumTableTopRollRotationDirection enumTableTopRollRotationDirection) Sets the Value Type Defined in Terms of TableTopRollRotationDirection
void	setTableTopVerticalPosition(java.lang.String strTableTopVerticalPosition) Sets Table Top Vertical position in mm in the IEC TABLE TOP coordinate system.

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, validateForModule, write

Methods inherited from class java.lang.Object

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

Method Detail

setNominalBeamEnergy

public void setNominalBeamEnergy(java.lang.String strNominalBeamEnergy)

Sets Nominal Beam Energy at control point.

Parameters:

strNominalBeamEnergy - String value of Nominal Beam Energy.

getNominalBeamEnergy

public java.lang.String getNominalBeamEnergy()

Retrieves Slice Thickness.

Returns:

String - value of Nominal Beam Energy.

setDoseRateSet

public void setDoseRateSet(java.lang.String strDoseRateSet)

Sets Dose Rate to be set on treatment machine. Dose Rate to be set on treatment machine for segment beginning at current control point

Parameters:

strDoseRateSet - String value of Nominal Beam Energy.

getDoseRateSet

public java.lang.String getDoseRateSet()

Retrieves Sets Dose Rate.

Returns:

String - value of Nominal Beam Energy.

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.Gantry angle in degrees of radiation source, orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system.

Parameters:

strSliceThickness - String value of GantryAngle.

getGantryAngle

public java.lang.String getGantryAngle()

Retrieves Gantry angle.

Returns:

String - value of Gantry angle.

setGantryRotationDirection

public void setGantryRotationDirection(EnumGantryRotationDirection enumGantryRotationDirection)

Sets the Value Type Defined in Terms of Enum Enumerated Values: CW - clockwise CC - counter-clockwise NONE - no rotation

Parameters:

strGantryRotationDirection - Specifies type of the value encoded in this Item (0x300A,0x011F)

getGantryRotationDirection

public java.lang.String getGantryRotationDirection()

Retrieves type of the value encoded in this Item

Returns:

String - Type of the value encoded in this Item

setBeamLimitingDeviceAngle

public void setBeamLimitingDeviceAngle(java.lang.String strBeamLimitingDeviceAngle)

Sets Beam Limiting Device Beam Limiting Device angle in degrees.

Parameters:

strBeamLimitingDeviceAngle - String value of Slice Thickness.

getBeamLimitingDeviceAngle

public java.lang.String getBeamLimitingDeviceAngle()

Retrieves Beam Limiting Device Angle.

Returns:

String - value of BeamLimitingDeviceAngle.

setBeamLimitingDeviceRotationDirection

public void setBeamLimitingDeviceRotationDirection(EnumBeamLimitingDeviceRotationDirection enumBeamLimitingDeviceRotationDirection)

Sets the Value Type Defined in Terms of Enum Enumerated Values: CW - clockwise CC - counter-clockwise NONE - no rotation

Parameters:

strBeamLimitingDeviceRotationDirection - Specifies type of the value encoded in this Item (0x300A,0x0121)

getBeamLimitingDeviceRotationDirection

public java.lang.String getBeamLimitingDeviceRotationDirection()

Retrieves type of the BeamLimitingDeviceRotationDirection value encoded in this Item

Returns:

String - Type of the value encoded in this Item

setPatientSupportAngle

public void setPatientSupportAngle(java.lang.String strPatientSupportAngle)

Sets PatientSupportAngle. Patient Support angle in degrees, i.e., orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system

Parameters:

strSliceThickness - String value of Slice Thickness.

getPatientSupportAngle

public java.lang.String getPatientSupportAngle()

Retrieves PatientSupportAngle.

Returns:

String - value of Patient Support Angle.

setPatientSupportRotationDirection

public void setPatientSupportRotationDirection(EnumPatientSupportRotationDirection enumPatientSupportRotationDirection)

Sets the Value Patient Support Rotation Direction

Parameters:

enumPatientSupportRotationDirection - Specifies type of the value encoded in this Item

getPatientSupportRotationDirection

public java.lang.String getPatientSupportRotationDirection()

Retrieves type of Value Patient Support Rotation Direction

Returns:

String - Value Patient Support Rotation Direction encoded in this Item

setTableTopEccentricAxisDistance

public void setTableTopEccentricAxisDistance(java.lang.String strTableTopEccentricAxisDistance)

Sets Table Top EccentricAxisDistance.Uniquely identifies 0x300A,0x0124

Parameters:

strSliceThickness - String value of Slice Thickness.

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 EccentricAxisDistance.Uniquely identifies 0x300A,0x0125

Parameters:

strSliceThickness - String value of Table Top Eccentric Angle .

getTableTopEccentricAngle

public java.lang.String getTableTopEccentricAngle()

Retrieves Table Top Eccentric Axis Distance.

Returns:

String - value of Table Top Eccentric Axis Distance.

setTableTopEccentricRotationDirection

public void setTableTopEccentricRotationDirection(EnumTableTopEccentricRotationDirection enumTableTopEccentricRotationDirection)

Sets the TableTopEccentricRotationDirection in Terms of TEXT

Parameters:

strTableTopEccentricRotationDirection - Specifies type of the value encoded in this Item

getTableTopEccentricRotationDirection

public java.lang.String getTableTopEccentricRotationDirection()

Retrieves type of the value encoded in this Item

Returns:

String - Table Top Eccentric Rotation Direction

setTableTopVerticalPosition

public void setTableTopVerticalPosition(java.lang.String strTableTopVerticalPosition)

Sets Table Top Vertical position in mm in the IEC TABLE TOP coordinate system.

Parameters:

strSliceThickness - String value of Slice Thickness.

getTableTopVerticalPosition

public java.lang.String getTableTopVerticalPosition()

Retrieves Table Top Vertical position.

Returns:

String - value of able Top Vertical position.

setTableTopLongitudinalPosition

public void setTableTopLongitudinalPosition(java.lang.String strTableTopLongitudinalPosition)

Sets TableTopLongitudinalPosition

Parameters:

strTableTopLongitudinalPosition - value of Slice Thickness.

getTableTopLongitudinalPosition

public java.lang.String getTableTopLongitudinalPosition()

Retrieves Table Top Longitudinal Position

Returns:

String - value of TableTopLongitudinalPosition.

setTableTopLateralPosition

public void setTableTopLateralPosition(java.lang.String strTableTopLateralPosition)

Sets TableTopLateralPosition

Parameters:

strTableTopLateralPosition - value of Table Top Lateral Position.

getTableTopLateralPosition

public java.lang.String getTableTopLateralPosition()

Retrieves Table Top Lateral Position

Returns:

String - value of TableTopLateralPosition.

setTableTopPitchAngle

public void setTableTopPitchAngle(float[] arrTableTopPitchAngle)

Sets a pair of floating point numbers specifying the Table Top PitchAngle Table Top Pitch Angle in degrees. it from the contrast frame.

Parameters:

arrTableTopPitchAngle - pair of floating point numbers

getTableTopPitchAngle

public float[] getTableTopPitchAngle()

Retrieves Table Top Pitch Angle.

Returns:

float[] - Float array of TableTopPitchAngle.

setTableTopPitchRotationDirection

public void setTableTopPitchRotationDirection(EnumTableTopPitchRotationDirection enumTableTopPitchRotationDirection)

Sets the TableTopPitchRotationDirection Defined in Terms of TEXT

Parameters:

enumTableTopPitchRotationDirection - Specifies type of the value encoded in this Item

getTableTopPitchRotationDirection

public java.lang.String getTableTopPitchRotationDirection()

Retrieves Table Top Pitch Rotation Direction

Returns:

String - Type of the value encoded in this Item

setTableTopRollAngle

public void setTableTopRollAngle(float[] arrTableTopRollAngle)

Table Top Roll Angle in degrees, i.e., The rotation of the IEC TABLE TOP coordinate system about the Y-axis of the IEC TABLE TOP coordinate system.

Parameters:

arrFMaskSubPixelShift - pair of floating point numbers

getTableTopRollAngle

public float[] getTableTopRollAngle()

Retrieves Table Top Roll Angle.

Returns:

float[] - Float array of Table Top Roll Angle.

setTableTopRollRotationDirection

public void setTableTopRollRotationDirection(EnumTableTopRollRotationDirection enumTableTopRollRotationDirection)

Sets the Value Type Defined in Terms of TableTopRollRotationDirection

Parameters:

strTableTopRollRotationDirection - Specifies type of the value encoded in this Item

getTableTopRollRotationDirection

public java.lang.String getTableTopRollRotationDirection()

Retrieves type of the Table Top Roll Rotation Direction encoded in this Item

Returns:

String - Type of the value encoded in this Item

setReferencedControlPointIndex

public void setReferencedControlPointIndex(java.lang.String strReferencedControlPointIndex)

Sets Referenced Control Point Index. Uniquely identifies Control Point specified by Control Point Index (300A,0112) within the Beam referenced by Referenced Beam Number (300C,0006).

Parameters:

strReferencedControlPointIndex - String value of Referenced Reference Image Number.

getReferencedControlPointIndex

public java.lang.String getReferencedControlPointIndex()

Retrieves Referenced Control Point Index.

Returns:

String - value of Referenced Control Point Index.