JetBase

Contents

JetBase#

class jetset.jet_model.JetBase(cosmo=None, name='test', emitters_type='electrons', emitters_distribution='pl', emitters_distribution_log_values=False, beaming_expr='delta', jet_workplace=None, verbose=None, nu_size=500, clean_work_dir=True, geometry='spherical', **keywords)[source]#

Bases: Model

JetBase class. This is the base class for the jet models providing the interface to the C code, giving full access to the physical parameters and providing the methods to run the code. The object will store the the physical parameters in the :Jet.parameters which is ModelParameterArray object, i.e. a collection of JetParameter objects. All the physical parameters are also accessible as attributes of the :Jet.parameters

Attributes Summary

Methods Summary

add_EC_component([EC_components_list, disk_type])

Method to add external Compton components

add_SSC_component([state])

add_basic_components()

add_sync_component([state])

available_emitters_distributions()

debug_SSC()

debug_synch()

del_EC_component(EC_components_list[, disk_type])

Remove EC components

del_par_from_dic(model_dic)

del_spectral_component(name)

energetic_report([verbose])

eval(**kwargs)

get_DL_cm([eval_model])

get_IC_mode()

get_IC_nu_size()

get_SED_peak([peak_name, freq_range, log_log])

get_beaming(**kwargs)

get_component_peak([comp_name, log_log])

get_emiss_lim()

get_emitters_distribution_name()

get_external_field_transf()

get_flag()

get_path()

get_seed_nu_size()

get_spectral_component_by_name(name[, verbose])

get_spectral_component_names_list()

get_verbosity()

lin_func(lin_nu, init[, phys_output, ...])

list_spectral_components()

load_model(*args, **kwargs)

make_conical_jet([R, theta_open, ...])

Convenience method to set functional dependency of parameters to have conical jet

plot_model([plot_obj, clean, label, comp, ...])

plot the model

save_model(file_name)

sed_table([restframe])

Provide the astropy table with SED spectral components

set_EC_dependencies()

Convenience method to set the functional dependency of BLR and DT radius according to the disk luminosity

set_IC_nu_size(val)

set_blob(**kwargs)

set_emiss_lim(val)

set_emitters_distribution([distr, ...])

set_emitting_region(beaming_expr, emitters_type)

sets the emitting region

set_external_field_transf(val)

set_external_fields(**kwargs)

set_flag(flag)

set_gamma_grid_size(val)

set_nu_grid_size(val)

set_num_c_threads(N)

set_path(path[, clean_work_dir])

set_seed_nu_size(val)

set_verbosity(val)

show_emitters_distribution()

show_model()

shortcut to ModelParametersArray.show_pars method shows all the paramters in the model

show_spectral_components()

switch_Norm_distr_OFF()

switch_Norm_distr_ON()

Attributes Documentation

IC_adaptive_e_binning#
IC_nu_size#
Norm_distr#
gamma_grid_size#
geometry#
nu_grid_size#
nu_max#
nu_min#
nu_seed_size#
nu_size#
spectral_components_list#

provides a list of the spectral components

Return type:

list of spectral components

Methods Documentation

add_EC_component(EC_components_list=[], disk_type=None)[source]#

Method to add external Compton components

Parameters:
  • EC_components_list (list, optional) – list of components to add, by default []

  • disk_type (str, optional) – the type of the disk, by default ‘BB’

Raises:
  • RuntimeError – _description_

  • RuntimeError – _description_

add_SSC_component(state='on')[source]#
add_basic_components()[source]#
add_sync_component(state='self-abs')[source]#
static available_emitters_distributions()[source]#
debug_SSC()[source]#
debug_synch()[source]#
del_EC_component(EC_components_list, disk_type='BB')[source]#

Remove EC components

Parameters:
  • EC_components_list (list) – list of the components to remove

  • disk_type (str, optional) – by default ‘BB’

Raises:

RuntimeError – _description_

del_par_from_dic(model_dic)[source]#
del_spectral_component(name)[source]#
energetic_report(verbose=True)[source]#
eval(**kwargs)#
get_DL_cm(eval_model=False)[source]#
get_IC_mode()[source]#
get_IC_nu_size()[source]#
get_SED_peak(peak_name=None, freq_range=None, log_log=False)[source]#
get_beaming(**kwargs)#
get_component_peak(comp_name=None, log_log=False)[source]#
get_emiss_lim()[source]#
get_emitters_distribution_name()[source]#
get_external_field_transf()[source]#
get_flag()[source]#
get_path()[source]#
get_seed_nu_size()[source]#
get_spectral_component_by_name(name, verbose=True)[source]#
get_spectral_component_names_list()[source]#
get_verbosity()[source]#
lin_func(lin_nu, init, phys_output=False, update_emitters=True)[source]#
list_spectral_components()[source]#
classmethod load_model(*args, **kwargs)#
make_conical_jet(R=None, theta_open=5.0, theta_open_min=1, theta_open_max=10)[source]#

Convenience method to set functional dependency of parameters to have conical jet

Parameters:
  • R (double, optional) – , by default None

  • theta_open (double, optional) – semi opening angle of the jet in deg, by default 5

  • theta_open_min (int, optional) – min value for theta_open, by default 1

  • theta_open_max (int, optional) – max value for theta_open, by default 10

Raises:

RuntimeError

plot_model(plot_obj=None, clean=False, label=None, comp=None, sed_data=None, color=None, auto_label=True, line_style='-', frame='obs', density=False)[source]#

plot the model

Parameters:
  • plot_obj (_type_, optional) – _description_, by default None

  • clean (bool, optional) – _description_, by default False

  • label (_type_, optional) – _description_, by default None

  • comp (_type_, optional) – _description_, by default None

  • sed_data (_type_, optional) – _description_, by default None

  • color (_type_, optional) – _description_, by default None

  • auto_label (bool, optional) – _description_, by default True

  • line_style (str, optional) – _description_, by default ‘-’

  • frame (str, optional) – _description_, by default ‘obs’

  • density (bool, optional) – _description_, by default False

Returns:

_description_

Return type:

_type_

save_model(file_name)[source]#
sed_table(restframe='obs')[source]#

Provide the astropy table with SED spectral components

Parameters:

restframe (str, optional) – , by default ‘obs’

Return type:

astropy table

set_EC_dependencies()[source]#

Convenience method to set the functional dependency of BLR and DT radius according to the disk luminosity

set_IC_nu_size(val)[source]#
set_blob(**kwargs)#
set_emiss_lim(val)[source]#
set_emitters_distribution(distr=None, log_values=False, emitters_type='electrons', init=True)[source]#
set_emitting_region(beaming_expr, emitters_type)[source]#

sets the emitting region

Parameters:
  • beaming_expr (str)

  • emitters_type (str)

set_external_field_transf(val)[source]#
set_external_fields(**kwargs)#
set_flag(flag)[source]#
set_gamma_grid_size(val)[source]#
set_nu_grid_size(val)[source]#
set_num_c_threads(N)[source]#
set_path(path, clean_work_dir=True)[source]#
set_seed_nu_size(val)[source]#
set_verbosity(val)[source]#
show_emitters_distribution()[source]#
show_model()[source]#

shortcut to ModelParametersArray.show_pars method shows all the paramters in the model

show_spectral_components()[source]#
switch_Norm_distr_OFF()[source]#
switch_Norm_distr_ON()[source]#