3.10.1.20.1.5. opengate.sources.phidsources

3.10.1.20.1.5.1. Classes

PhotonFromIonDecaySource	Manage a set of sources, one for each nuclide gamma lines, for all daughters of the given ion.
PhotonIonDecayIsomericTransitionExtractor	For a given ion, extract all possible gamma emission, with corresponding intensity
NumpyArrayHandler

3.10.1.20.1.5.2. Functions

update_tac_activity_ui(ui, g4_source)
print_phid_info(rad_name[, br, tab])
get_nuclide_from_name(rad_name)
get_nuclide_and_direct_progeny(z, a)
get_nuclide_progeny(nuclide[, intensity, parent])
atomic_relaxation_load(nuclide[, load_type])
atomic_relaxation_load_from_data_file_OLD(nuclide, ...)
atomic_relaxation_load_from_data_file_NEW1(nuclide, ...)
atomic_relaxation_load_from_data_file(nuclide, filename)
atomic_relaxation_load_from_iaea_website(a, rad_name)
atomic_relaxation_get_filename(nuclide_name)
atomic_relaxation_load_from_file(nuclide_name[, filename])
atomic_relaxation_store_to_file(nuclide_name, df[, ...])
atomic_relaxation_get_ene_weights_from_df(df)
atomic_relaxation_load_all_gammas(nuclide)
lc_read_csv(url)
isomeric_transition_get_filename(nuclide_name)
isomeric_transition_load(nuclide[, filename, half_life])
isomeric_transition_load_OLD(nuclide[, filename])
isomeric_transition_store(nuclide_name, data_to_save, ...)
isomeric_transition_store_df_to_file(nuclide_name, df)
isomeric_transition_load_from_df_file(nuclide_name, ...)
isomeric_transition_get_ene_weights_from_df(df, half_life)
isomeric_transition_load_from_iaea_website(a, rad_name)
isomeric_transition_load_from_file(filename)
isomeric_transition_extract_from_ion_decay(nuclide[, ...])
isomeric_transition_load_all_gammas(nuclide[, half_life])
isomeric_transition_read_g4_data(z, a[, ignore_zero_deex])
isomeric_transition_read_one_gamma_deex_channel_line(line)
get_tac_from_decay(ion_name, daughter, start_activity, ...)	The following will be modified according to the TAC:
gid_build_all_sub_sources(source)	Build all gamma sources for the given nuclide
gid_build_all_sub_sources_atomic_relaxation(ui, z, a)
gid_build_all_sub_sources_isomeric_transition(ui, z, a)	Build (or read from file) all isomeric transition gammas for all daughters in the decay
gid_build_one_sub_source(stype, ui, daughter, ene, w, ...)
isomeric_transition_get_n_greater_energy(nuclide, n)

3.10.1.20.1.5.3. Module Contents

class opengate.sources.phidsources.PhotonFromIonDecaySource(user_info)

Bases: opengate.sources.generic.GenericSource

Manage a set of sources, one for each nuclide gamma lines, for all daughters of the given ion. Each source will have: - activity managed by a TAC, corresponding to the Bateman equation during the time range - spectrum energy line for isomeric transition - spectrum energy line for atomic relaxation (fluo)

type_name = 'PhotonFromIonDecaySource'

static set_default_user_info(user_info)

__del__()

__getstate__()

ui_sub_sources

daughters

g4_sub_sources = []

log

create_g4_source()

initialize(run_timing_intervals)

add_to_source_manager(source_manager)

opengate.sources.phidsources.update_tac_activity_ui(ui, g4_source)

class opengate.sources.phidsources.PhotonIonDecayIsomericTransitionExtractor(z, a, verbose=False)

For a given ion, extract all possible gamma emission, with corresponding intensity

1. Create a ‘fake’ gate simulation because G4 engine must be initialized. This is done in a separate process. The function “_get_all_gamma_emissions” is used.

2. From the IonTable all the Decay Channels are extracted

   -> function ‘_get_all_decay_channels’

3. For one decay channel, we look all possible excitation levels

   This is read in the G4 data file G4LEVELGAMMADATA of the corresponding ion -> _get_gammas_for_one_channel -> _get_gammas_for_one_level

z

a

channels = None

gammas = []

verbose

extract()

_get_all_gamma_emissions(sim_engine)

_get_all_decay_channels()

_get_gammas_for_one_channel(channel)

_get_gammas_for_one_level(levels, level, br, p=1, tab='')

_level_daughter_info(d)

opengate.sources.phidsources.print_phid_info(rad_name, br=1.0, tab='')

opengate.sources.phidsources.get_nuclide_from_name(rad_name)

opengate.sources.phidsources.get_nuclide_and_direct_progeny(z, a)

opengate.sources.phidsources.get_nuclide_progeny(nuclide, intensity=1.0, parent=None)

opengate.sources.phidsources.atomic_relaxation_load(nuclide: radioactivedecay.Nuclide, load_type='local')

opengate.sources.phidsources.atomic_relaxation_load_from_data_file_OLD(nuclide, filename)

opengate.sources.phidsources.atomic_relaxation_load_from_data_file_NEW1(nuclide, filename)

opengate.sources.phidsources.atomic_relaxation_load_from_data_file(nuclide, filename)

opengate.sources.phidsources.atomic_relaxation_load_from_iaea_website(a, rad_name)

opengate.sources.phidsources.atomic_relaxation_get_filename(nuclide_name)

opengate.sources.phidsources.atomic_relaxation_load_from_file(nuclide_name, filename=None)

opengate.sources.phidsources.atomic_relaxation_store_to_file(nuclide_name, df, filename=None)

opengate.sources.phidsources.atomic_relaxation_get_ene_weights_from_df(df)

opengate.sources.phidsources.atomic_relaxation_load_all_gammas(nuclide: radioactivedecay.Nuclide)

opengate.sources.phidsources.lc_read_csv(url)

opengate.sources.phidsources.isomeric_transition_get_filename(nuclide_name)

opengate.sources.phidsources.isomeric_transition_load(nuclide: radioactivedecay.Nuclide, filename=None, half_life=None)

opengate.sources.phidsources.isomeric_transition_load_OLD(nuclide: radioactivedecay.Nuclide, filename=None)

opengate.sources.phidsources.isomeric_transition_store(nuclide_name, data_to_save, filename)

opengate.sources.phidsources.isomeric_transition_store_df_to_file(nuclide_name, df, filename=None)

opengate.sources.phidsources.isomeric_transition_load_from_df_file(nuclide_name, half_life, filename=None)

opengate.sources.phidsources.isomeric_transition_get_ene_weights_from_df(df, half_life)

opengate.sources.phidsources.isomeric_transition_load_from_iaea_website(a, rad_name)

opengate.sources.phidsources.isomeric_transition_load_from_file(filename)

opengate.sources.phidsources.isomeric_transition_extract_from_ion_decay(nuclide: radioactivedecay.Nuclide, verbose=False)

opengate.sources.phidsources.isomeric_transition_load_all_gammas(nuclide: radioactivedecay.Nuclide, half_life=None)

opengate.sources.phidsources.isomeric_transition_read_g4_data(z, a, ignore_zero_deex=True)

opengate.sources.phidsources.isomeric_transition_read_one_gamma_deex_channel_line(line)

opengate.sources.phidsources.get_tac_from_decay(ion_name, daughter, start_activity, start_time, end_time, bins)

The following will be modified according to the TAC: ui.start_time, ui.end_time, ui.activity.

param is ui.tac_from_decay_parameters param is a dict with: - nuclide: a Nuclide object from radioactivedecay module, with the main ion - daughter: the daughter for which we compute the intensity in the time intervals - bins: number of bins for the discretised TAC

• run_timing_intervals: is the list of time range from the Simulation

class opengate.sources.phidsources.NumpyArrayHandler

Bases: jsonpickle.handlers.BaseHandler

flatten(obj, data)

restore(obj)

opengate.sources.phidsources.gid_build_all_sub_sources(source)

Build all gamma sources for the given nuclide all isomeric transition gammas and all atomic relaxation fluo x-rays

opengate.sources.phidsources.gid_build_all_sub_sources_atomic_relaxation(ui, z, a, debug_first_daughter_only=False)

opengate.sources.phidsources.gid_build_all_sub_sources_isomeric_transition(ui, z, a)

Build (or read from file) all isomeric transition gammas for all daughters in the decay

opengate.sources.phidsources.gid_build_one_sub_source(stype, ui, daughter, ene, w, first_nuclide)

opengate.sources.phidsources.isomeric_transition_get_n_greater_energy(nuclide, n)