Rtplan_beam Class Reference

The Rtplan_beam class describes a single beam within an Rtplan. More...

#include <rtplan_beam.h>

Public Member Functions
	Rtplan_beam ()
	~Rtplan_beam ()
void	clear ()
Rtplan_control_pt *	add_control_pt ()
void	set_isocenter_from_control_points ()

Public Attributes
std::string	name
	Beam name.
std::string	description
	Beam description.
std::string	treatment_machine_name
std::string	treatment_delivery_type
std::string	manufacturer
std::string	institution_name
std::string	institution_address
std::string	institutional_department_name
std::string	manufacturer_model_name
float	virtual_source_axis_distances [2]
float	final_cumulative_meterset_weight
	Meterset at end of all control points.
std::string	beam_dose_specification_point
	Coordiates of point where beam dose is specified.
float	beam_dose
	Dose in Gy at beam specification point.
float	snout_position
float	gantry_angle
std::string	gantry_rotation_direction
float	beam_limiting_device_angle
std::string	beam_limiting_device_rotation_direction
float	patient_support_angle
std::string	patient_support_rotation_direction
float	table_top_vertical_position
float	table_top_longitudinal_position
float	table_top_lateral_position
float	table_top_pitch_angle
std::string	table_top_pitch_rotation_direction
float	table_top_roll_angle
std::string	table_top_roll_rotation_direction
float	gantry_pitch_angle
std::string	gantry_pitch_rotation_direction
float	isocenter_position [3]
std::vector< Rtplan_control_pt * >	cplist
	Control point list.

Detailed Description

The Rtplan_beam class describes a single beam within an Rtplan.

Constructor & Destructor Documentation

Rtplan_beam()

Rtplan_beam::Rtplan_beam

(

)

~Rtplan_beam()

Rtplan_beam::~Rtplan_beam

(

)

Member Function Documentation

add_control_pt()

Rtplan_control_pt * Rtplan_beam::add_control_pt

(

)

clear()

void Rtplan_beam::clear

(

)

set_isocenter_from_control_points()

void Rtplan_beam::set_isocenter_from_control_points

(

)

Member Data Documentation

beam_dose

float Rtplan_beam::beam_dose

Dose in Gy at beam specification point.

beam_dose_specification_point

std::string Rtplan_beam::beam_dose_specification_point

Coordiates of point where beam dose is specified.

beam_limiting_device_angle

float Rtplan_beam::beam_limiting_device_angle

beam_limiting_device_rotation_direction

std::string Rtplan_beam::beam_limiting_device_rotation_direction

cplist

std::vector<Rtplan_control_pt*> Rtplan_beam::cplist

Control point list.

description

std::string Rtplan_beam::description

Beam description.

final_cumulative_meterset_weight

float Rtplan_beam::final_cumulative_meterset_weight

Meterset at end of all control points.

gantry_angle

float Rtplan_beam::gantry_angle

gantry_pitch_angle

float Rtplan_beam::gantry_pitch_angle

gantry_pitch_rotation_direction

std::string Rtplan_beam::gantry_pitch_rotation_direction

gantry_rotation_direction

std::string Rtplan_beam::gantry_rotation_direction

institution_address

std::string Rtplan_beam::institution_address

institution_name

std::string Rtplan_beam::institution_name

institutional_department_name

std::string Rtplan_beam::institutional_department_name

isocenter_position

float Rtplan_beam::isocenter_position[3]

manufacturer

std::string Rtplan_beam::manufacturer

manufacturer_model_name

std::string Rtplan_beam::manufacturer_model_name

name

std::string Rtplan_beam::name

Beam name.

patient_support_angle

float Rtplan_beam::patient_support_angle

patient_support_rotation_direction

std::string Rtplan_beam::patient_support_rotation_direction

snout_position

float Rtplan_beam::snout_position

table_top_lateral_position

float Rtplan_beam::table_top_lateral_position

table_top_longitudinal_position

float Rtplan_beam::table_top_longitudinal_position

table_top_pitch_angle

float Rtplan_beam::table_top_pitch_angle

table_top_pitch_rotation_direction

std::string Rtplan_beam::table_top_pitch_rotation_direction

table_top_roll_angle

float Rtplan_beam::table_top_roll_angle

table_top_roll_rotation_direction

std::string Rtplan_beam::table_top_roll_rotation_direction

table_top_vertical_position

float Rtplan_beam::table_top_vertical_position

treatment_delivery_type

std::string Rtplan_beam::treatment_delivery_type

treatment_machine_name

std::string Rtplan_beam::treatment_machine_name

\other brief descriptions

virtual_source_axis_distances

float Rtplan_beam::virtual_source_axis_distances[2]

---

The documentation for this class was generated from the following files:

• src/base/rtplan_beam.h
• src/base/rtplan_beam.cxx