cdac.medinfo.sdk.dcm30_04.baselibs

Class IonControlPointVerificationSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.IonControlPointVerificationSequenceItem

All Implemented Interfaces:

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

public class IonControlPointVerificationSequenceItem
extends Item

This item class contains the methods to set, get and validate the attribute present in Ion Control Point Verification 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 value encoded in this Item
java.lang.String	getGantryAngle() Retrieves GantryAngle.
float[]	getGantryPitchAngle() Retrieves Gantry Pitch Angle in degrees of the radiation source.
java.lang.String	getGantryPitchRotationDirection() Retrieves Gantry Pitch Rotation Direction in this Item
java.lang.String	getGantryRotationDirection() Retrieves Gantry Rotation Direction value encoded in this Item Direction of Gantry Rotation when viewing gantry from isocenter, for segment following Control Point.
float[]	getHeadFixationAngle() Retrieves Head Fixation Angle.
IonWedgePositionSequence	getIonWedgePositionSequence() Retrieves pre-initialized object of Ion 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.
LateralSpreadingDeviceSettingsSequence	getLateralSpreadingDeviceSettingsSequence() Retrieves pre-initialized object of Lateral Spreading Device Settings 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	getMetersetRateSet() Retrieves MetersetRateSet
java.lang.String	getNominalBeamEnergy() Retrieves NominalBeamEnergy.
java.lang.String	getPatientSupportAngle() Retrieves Patient Support Angle.
java.lang.String	getPatientSupportRotationDirection() Retrieves type of the PatientSupportRotationDirection value encoded in this Item
RangeModulatorSettingsSequence	getRangeModulatorSettingsSequence() Retrieves pre-initialized object of Range Modulator Settings 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.
RangeShifterSettingsSequence	getRangeShifterSettingsSequence() Retrieves pre-initialized object of Range Shifter Settings 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	getReferencedControlPointIndex() Retrieves Referenced Control Point Index.
float	getSnoutPosition() Retrieves the Ratio of displayed pixels to source pixels,specified in one dimension.
java.lang.String	getTableTopLateralPosition() Retrieves TableTopLateralPosition.
java.lang.String	getTableTopLongitudinalPosition() Retrieves TableTopVerticalPosition.
float[]	getTableTopPitchAngle() Retrieves Table Top Pitch Angle.
java.lang.String	getTableTopPitchRotationDirection() Retrieves TableTopPitchRotationDirection type of the value encoded in this Item
float[]	getTableTopRollAngle() Retrieves Table Top Roll Angle.
java.lang.String	getTableTopRollRotationDirection() Retrieves type of the value encoded in this Item
java.lang.String	getTableTopVerticalPosition() Retrieves TableTopVerticalPosition.
void	setBeamLimitingDeviceAngle(java.lang.String strBeamLimitingDeviceAngle) Sets BeamLimitingDeviceAngle.
void	setBeamLimitingDeviceRotationDirection(EnumBeamLimitingDeviceRotationDirection enumBeamLimitingDeviceRotationDirection) Sets the BeamLimitingDeviceRotationDirection Defined in Terms of Enum Enumerated Values: CW : clockwise CC : counter-clockwise NONE : no rotation
void	setGantryAngle(java.lang.String strGantryAngle) Sets Gantry Angle.
void	setGantryPitchAngle(float[] arrHeadFixationAngle) Sets Gantry Pitch Angle in degrees of the radiation source, i.e., the rotation of the IEC GANTRY coordinate system about the X-axis of the IEC GANTRY coordinate system.
void	setGantryPitchRotationDirection(EnumGantryPitchRotationDirection enumGantryPitchRotationDirection) Sets the Gantry Pitch Rotation Direction Type Defined in Terms of enumGantryPitchRotationDirection Direction of Gantry Pitch Angle when viewing along the positive X-axis of the IEC GANTRY coordinate system, for segment following Control Point.
void	setGantryRotationDirection(EnumGantryRotationDirection enumGantryRotationDirection) Sets the Gantry Rotation Direction Defined in Terms of TEXT Direction of Gantry Rotation when viewing gantry from isocenter, for segment following Control Point.
void	setHeadFixationAngle(float[] arrHeadFixationAngle) Sets Angle in degrees of the head fixation for eye treatments with respect to the Table Top Pitch Angle (300A,0140) coordinate system.
void	setMetersetRateSet(float shMetersetRateSet) The specified speed of delivery of the specified dose in units specified by Primary Dosimeter Unit (300A,00B3) in referenced RT Plan per minute.
void	setNominalBeamEnergy(java.lang.String strNominalBeamEnergy) Sets NominalBeamEnergy.Nominal Beam Energy at control point.
void	setPatientSupportAngle(java.lang.String strPatientSupportAngle) Sets Patient Support Angle.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.
void	setPatientSupportRotationDirection(EnumPatientSupportRotationDirection enumPatientSupportRotationDirection) Sets the PatientSupportRotationDirection Defined in Terms of Enum Enumerated Values: CW : clockwise CC : counter-clockwise NONE : no rotation
void	setReferencedControlPointIndex(java.lang.String strReferencedControlPointIndex) Sets Referenced Control Point Index.
void	setSnoutPosition(float fSnoutPosition) Sets axial position in mm of the snout, measured from isocenter to the downstream side of the snout
void	setTableTopLateralPosition(java.lang.String strTableTopLateralPosition) Sets TableTopLateralPosition.
void	setTableTopLongitudinalPosition(java.lang.String strTableTopLongitudinalPosition) Sets TableTopLongitudinalPosition.
void	setTableTopPitchAngle(float[] arrTableTopPitchAngle) Sets Table Top Pitch Angle Table Top Pitch Angle in degrees, i.e., The rotation of the IEC TABLE TOP coordinate system about the X-axis of the IEC TABLE TOP coordinate system.
void	setTableTopPitchRotationDirection(EnumTableTopPitchRotationDirection enumTableTopPitchRotationDirection) Sets the TableTopPitchRotationDirection Defined in Terms of EnumTableTopPitchRotationDirection Enumerated Values: CW :clockwise CC :counter-clockwise NONE :no rotation
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 EnumTableTopRollRotationDirection Enumerated Values: CW :clockwise CC :counter-clockwise NONE :no rotation
void	setTableTopVerticalPosition(java.lang.String strTableTopVerticalPosition) Sets TableTopVerticalPosition.

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

setMetersetRateSet

public void setMetersetRateSet(float shMetersetRateSet)

The specified speed of delivery of the specified dose in units specified by Primary Dosimeter Unit (300A,00B3) in referenced RT Plan per minute.

Parameters:

shMetersetRateSet - short value of Rotation of right image.

getMetersetRateSet

public float getMetersetRateSet()

Retrieves MetersetRateSet

Returns:

short - short value of Rotation of Meterset Rate Set.

setNominalBeamEnergy

public void setNominalBeamEnergy(java.lang.String strNominalBeamEnergy)

Sets NominalBeamEnergy.Nominal Beam Energy at control point.

Parameters:

strNominalBeamEnergy - String value of Slice Thickness.

getNominalBeamEnergy

public java.lang.String getNominalBeamEnergy()

Retrieves NominalBeamEnergy.

Returns:

String - value of Nominal Beam Energy.

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

setGantryAngle

public void setGantryAngle(java.lang.String strGantryAngle)

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

Parameters:

strGantryAngle - String value of Slice Thickness.

getGantryAngle

public java.lang.String getGantryAngle()

Retrieves GantryAngle.

Returns:

String - value of GantryAngle.

setGantryRotationDirection

public void setGantryRotationDirection(EnumGantryRotationDirection enumGantryRotationDirection)

Sets the Gantry Rotation Direction Defined in Terms of TEXT Direction of Gantry Rotation when viewing gantry from isocenter, for segment following Control Point.

Parameters:

strGantryRotationDirection - type of the value encoded in this Item

getGantryRotationDirection

public java.lang.String getGantryRotationDirection()

Retrieves Gantry Rotation Direction value encoded in this Item Direction of Gantry Rotation when viewing gantry from isocenter, for segment following Control Point.

Returns:

String - Type of the value encoded in this Item

setBeamLimitingDeviceAngle

public void setBeamLimitingDeviceAngle(java.lang.String strBeamLimitingDeviceAngle)

Sets BeamLimitingDeviceAngle. Beam Limiting Device angle in degrees, i.e., orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system.

Parameters:

strSliceThickness - 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 BeamLimitingDeviceRotationDirection 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

getBeamLimitingDeviceRotationDirection

public java.lang.String getBeamLimitingDeviceRotationDirection()

Retrieves type of the value encoded in this Item

Returns:

String - Type of the value encoded in this Item

setPatientSupportAngle

public void setPatientSupportAngle(java.lang.String strPatientSupportAngle)

Sets Patient Support Angle.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:

strPatientSupportAngle - String value of Patient Support Angle.

getPatientSupportAngle

public java.lang.String getPatientSupportAngle()

Retrieves Patient Support Angle.

Returns:

String - value of PatientSupportAngle.

setPatientSupportRotationDirection

public void setPatientSupportRotationDirection(EnumPatientSupportRotationDirection enumPatientSupportRotationDirection)

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

Parameters:

strValueType - Specifies type of the value encoded in this Item

getPatientSupportRotationDirection

public java.lang.String getPatientSupportRotationDirection()

Retrieves type of the PatientSupportRotationDirection value encoded in this Item

Returns:

String - Type of the value encoded in this Item

setTableTopVerticalPosition

public void setTableTopVerticalPosition(java.lang.String strTableTopVerticalPosition)

Sets TableTopVerticalPosition.

Parameters:

strTableTopVerticalPosition - String value of Table Top Vertical Position.

getTableTopVerticalPosition

public java.lang.String getTableTopVerticalPosition()

Retrieves TableTopVerticalPosition.

Returns:

String - value of Table Top Vertical Position.

setTableTopLongitudinalPosition

public void setTableTopLongitudinalPosition(java.lang.String strTableTopLongitudinalPosition)

Sets TableTopLongitudinalPosition.

Parameters:

strTableTopLongitudinalPosition - String value of Table Top Vertical Position.

getTableTopLongitudinalPosition

public java.lang.String getTableTopLongitudinalPosition()

Retrieves TableTopVerticalPosition.

Returns:

String - value of Table Top Vertical Position.

setTableTopLateralPosition

public void setTableTopLateralPosition(java.lang.String strTableTopLateralPosition)

Sets TableTopLateralPosition.

Parameters:

TableTopLateralPosition - String value of Table Top Lateral Position.

getTableTopLateralPosition

public java.lang.String getTableTopLateralPosition()

Retrieves TableTopLateralPosition.

Returns:

String - value of Table Top Lateral Position.

setTableTopPitchAngle

public void setTableTopPitchAngle(float[] arrTableTopPitchAngle)

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

Parameters:

arrFMaskSubPixelShift - pair of floating point numbers

getTableTopPitchAngle

public float[] getTableTopPitchAngle()

Retrieves Table Top Pitch Angle.

Returns:

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

setTableTopPitchRotationDirection

public void setTableTopPitchRotationDirection(EnumTableTopPitchRotationDirection enumTableTopPitchRotationDirection)

Sets the TableTopPitchRotationDirection Defined in Terms of EnumTableTopPitchRotationDirection Enumerated Values: CW :clockwise CC :counter-clockwise NONE :no rotation

Parameters:

enumTableTopPitchRotationDirection - Specifies type of the value encoded in this Item

getTableTopPitchRotationDirection

public java.lang.String getTableTopPitchRotationDirection()

Retrieves TableTopPitchRotationDirection type of the value encoded in this Item

Returns:

enum - 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:

arrTableTopRollAngle - pair of floating point numbers

getTableTopRollAngle

public float[] getTableTopRollAngle()

Retrieves Table Top Roll Angle.

Returns:

float[] - Float Table Top Roll Angle.

setTableTopRollRotationDirection

public void setTableTopRollRotationDirection(EnumTableTopRollRotationDirection enumTableTopRollRotationDirection)

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

Parameters:

enumTableTopRollRotationDirection - 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:

enumTableTopRollRotationDirection - Type of the value encoded in this Item

setHeadFixationAngle

public void setHeadFixationAngle(float[] arrHeadFixationAngle)

Sets Angle in degrees of the head fixation for eye treatments with respect to the Table Top Pitch Angle (300A,0140) coordinate system. Positive head fixation angle is the same direction as positive Table Top Pitch.

Parameters:

arrHeadFixationAngle - pair of floating point numbers

getHeadFixationAngle

public float[] getHeadFixationAngle()

Retrieves Head Fixation Angle.

Returns:

float[] - Float array of Head Fixation Angle.

setGantryPitchAngle

public void setGantryPitchAngle(float[] arrHeadFixationAngle)

Sets Gantry Pitch Angle in degrees of the radiation source, i.e., the rotation of the IEC GANTRY coordinate system about the X-axis of the IEC GANTRY coordinate system.

Parameters:

arrHeadFixationAngle - pair of floating point numbers

getGantryPitchAngle

public float[] getGantryPitchAngle()

Retrieves Gantry Pitch Angle in degrees of the radiation source.

Returns:

float[] - Float array of Gantry Pitch Angle.

setGantryPitchRotationDirection

public void setGantryPitchRotationDirection(EnumGantryPitchRotationDirection enumGantryPitchRotationDirection)

Sets the Gantry Pitch Rotation Direction Type Defined in Terms of enumGantryPitchRotationDirection Direction of Gantry Pitch Angle when viewing along the positive X-axis of the IEC GANTRY coordinate system, for segment following Control Point.

Parameters:

enumGantryPitchRotationDirection - Specifies type of the value encoded in this Item

getGantryPitchRotationDirection

public java.lang.String getGantryPitchRotationDirection()

Retrieves Gantry Pitch Rotation Direction in this Item

Returns:

String - Type of the value encoded in this Item

setSnoutPosition

public void setSnoutPosition(float fSnoutPosition)

Sets axial position in mm of the snout, measured from isocenter to the downstream side of the snout

Parameters:

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

getSnoutPosition

public float getSnoutPosition()

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

getRangeShifterSettingsSequence

public RangeShifterSettingsSequence getRangeShifterSettingsSequence()

Retrieves pre-initialized object of Range Shifter Settings 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:

RangeShifterSettingsSequence - instance of Range Shifter Settings Sequence.

getLateralSpreadingDeviceSettingsSequence

public LateralSpreadingDeviceSettingsSequence getLateralSpreadingDeviceSettingsSequence()

Retrieves pre-initialized object of Lateral Spreading Device Settings 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:

LateralSpreadingDeviceSettingsSequence - instance of Lateral Spreading Device Settings Sequence.

getRangeModulatorSettingsSequence

public RangeModulatorSettingsSequence getRangeModulatorSettingsSequence()

Retrieves pre-initialized object of Range Modulator Settings 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:

RangeModulatorSettingsSequence - instance of Range Modulator Settings Sequence.

getIonWedgePositionSequence

public IonWedgePositionSequence getIonWedgePositionSequence()

Retrieves pre-initialized object of Ion 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:

IonWedgePositionSequence - instance of Ion Wedge Position Sequence.

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 Control Point Index.

getReferencedControlPointIndex

public java.lang.String getReferencedControlPointIndex()

Retrieves 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).

Returns:

String - value of Referenced Control Point Index.