ModelParameterArray

class ModelParameterArray(model=None)[source]

Bases: object

This class provide and interface to handle an array of ModelParameter objects.

par_array

list of ModelParameter objects

Type:

list

Attributes Summary

best_fit_par_table

names

par_table

Methods Summary

add_par(par)

adds a new ModelParameter object to the par_array

del_par(par)

free_all()

freeze_all()

get(par_name, arg)

gets the argument of a given parameter

get_par_by_name(name[, verbose])

selects a parameter by name

get_par_by_type(par_type)

get parameter by type

reset_dependencies()

set(par_name, *args, **keywords)

sets to a given value a given parameter

show_best_fit_pars([getstring])

show_pars([getstring, names_list, sort_key])

Attributes Documentation

best_fit_par_table
names
par_table

Methods Documentation

add_par(par)[source]

adds a new ModelParameter object to the par_array

del_par(par)[source]
free_all()[source]
freeze_all()[source]
get(par_name, arg)[source]

gets the argument of a given parameter

Parameters:

  • par_name ((str) name of the parameter) –

  • arg (keyword) –

Examples

if parameters is a ModelParameterArray object:

parameters.get('R')
parameters.get('frozen')
get_par_by_name(name, verbose=False)[source]

selects a parameter by name

Parameters:

name ((str) parameter name) –

Returns:

item

Return type:

the ModelParameter element of the par_array with the corresponding name

get_par_by_type(par_type)[source]

get parameter by type

reset_dependencies()[source]
set(par_name, *args, **keywords)[source]

sets to a given value a given parameter

Parameters:

  • par_name ((str) name of the parameter) –

  • keywords (keywords to set the value or the range of the parameter) –

Examples

if parameters is a ModelParameterArray object:

parameters.set('R',val=1E16)
parameters.set('R',fit_range=[1E16,1E17])
show_best_fit_pars(getstring=False)[source]
show_pars(getstring=False, names_list=None, sort_key=None)[source]