opengate.contrib.tps.treatmentPlanPhsSource
===========================================

.. py:module:: opengate.contrib.tps.treatmentPlanPhsSource


Classes
-------

.. autoapisummary::

   opengate.contrib.tps.treatmentPlanPhsSource.TreatmentPlanPhsSource


Module Contents
---------------

.. py:class:: TreatmentPlanPhsSource(name, sim)

   Bases: :py:obj:`TreatmentPlanSource`


   .. py:attribute:: name


   .. py:attribute:: rotation


   .. py:attribute:: translation
      :value: [0, 0, 0]



   .. py:attribute:: spots
      :value: None



   .. py:attribute:: phaseSpaceFolder
      :value: ''



   .. py:attribute:: phaseSpaceList_file_name
      :value: ''



   .. py:attribute:: phaseSpaceList


   .. py:attribute:: position_key_x
      :value: 'PrePositionLocal_X'



   .. py:attribute:: position_key_y
      :value: 'PrePositionLocal_Y'



   .. py:attribute:: position_key_z
      :value: 'PrePositionLocal_Z'



   .. py:attribute:: direction_key_x
      :value: 'PreDirectionLocal_X'



   .. py:attribute:: direction_key_y
      :value: 'PreDirectionLocal_Y'



   .. py:attribute:: direction_key_z
      :value: 'PreDirectionLocal_Z'



   .. py:attribute:: energy_key
      :value: 'KineticEnergy'



   .. py:attribute:: weight_key
      :value: 'Weight'



   .. py:attribute:: PDGCode_key
      :value: 'PDGCode'



   .. py:attribute:: generate_until_next_primary
      :value: False



   .. py:attribute:: primary_lower_energy_threshold
      :value: 0



   .. py:attribute:: primary_PDGCode
      :value: 0



   .. py:attribute:: n_sim
      :value: 0



   .. py:attribute:: sim


   .. py:attribute:: distance_source_to_isocenter
      :value: None



   .. py:attribute:: distance_stearmag_to_isocenter_x
      :value: None



   .. py:attribute:: distance_stearmag_to_isocenter_y
      :value: None



   .. py:attribute:: batch_size
      :value: None



   .. py:method:: __del__()


   .. py:method:: set_distance_source_to_isocenter(distance)


   .. py:method:: set_distance_stearmag_to_isocenter(distance_x, distance_y)


   .. py:method:: set_phaseSpaceList_file_name(file_name)


   .. py:method:: set_phaseSpaceFolder(folder_name)


   .. py:method:: initialize_tpPhssource()


   .. py:method:: 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.



   .. py:method:: read_list_of_Phs(file_name: str, path_to_phsp='')

      Read a list of Phs from a file.

      Parameters
      ----------
      file_name : str
          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
      Returns
      -------
      dictionary of Phs



   .. py:method:: verify_necessary_parameters_are_set()

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