3.10.1.5.1.7.1.2. opengate.contrib.tps.treatmentPlanPhsSource

3.10.1.5.1.7.1.2.1. Classes

TreatmentPlanPhsSource

3.10.1.5.1.7.1.2.2. Module Contents

class opengate.contrib.tps.treatmentPlanPhsSource.TreatmentPlanPhsSource(name, sim)

Bases: TreatmentPlanSource

name

rotation

translation = [0, 0, 0]

spots = None

phaseSpaceFolder = ''

phaseSpaceList_file_name = ''

phaseSpaceList

position_key_x = 'PrePositionLocal_X'

position_key_y = 'PrePositionLocal_Y'

position_key_z = 'PrePositionLocal_Z'

direction_key_x = 'PreDirectionLocal_X'

direction_key_y = 'PreDirectionLocal_Y'

direction_key_z = 'PreDirectionLocal_Z'

energy_key = 'KineticEnergy'

weight_key = 'Weight'

PDGCode_key = 'PDGCode'

generate_until_next_primary = False

primary_lower_energy_threshold = 0

primary_PDGCode = 0

n_sim = 0

sim

distance_source_to_isocenter = None

distance_stearmag_to_isocenter_x = None

distance_stearmag_to_isocenter_y = None

batch_size = None

__del__()

set_distance_source_to_isocenter(distance)

set_distance_stearmag_to_isocenter(distance_x, distance_y)

set_phaseSpaceList_file_name(file_name)

set_phaseSpaceFolder(folder_name)

initialize_tpPhssource()

verify_phs_files_exist(phs_dict)

Check if all the files in the dictionary exist. Returns True if all the files exist, False otherwise If one file does not exist, the program is aborted.

read_list_of_Phs(file_name: str, path_to_phsp='')

Read a list of Phs from a file.

3.10.1.5.1.7.1.2. Parameters

file_namestr

The name of the file to read from. File needs to have at least two columns First column is the energy in MeV which is the energy label Second column is the phase space file name

3.10.1.5.1.7.1.2. Returns

dictionary of Phs

verify_necessary_parameters_are_set()

This function checks whether all necessary parameters were set. E.g. not None It does not check sensibility