ModelParameterArray

ModelParameterArray#

class jetset.model_parameters.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`	Best fit par table.
`names`	Names.
`par_table`	Par table.

Methods Summary

`add_par`(par)	adds a new `ModelParameter` object to the par_array
`del_par`(par)	Del par.
`free_all`()	Free all.
`freeze_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
`get_pars_by_type`(par_type)	get parameter by type
`reset_dependencies`()	Reset dependencies.
`set`(par_name, args, *keywords)	sets to a given value a given parameter
`show_best_fit_pars`([getstring])	Display best fit pars.
`show_pars`([getstring, names_list, sort_key])	Display pars.

Attributes Documentation

best_fit_par_table#

Best fit par table.

Returns:: Requested value.
Return type:: object

names#

Names.

Returns:: Requested value.
Return type:: object

par_table#

Par table.

Returns:: Requested value.
Return type:: object

Methods Documentation

add_par(par)[source]#: adds a new ModelParameter object to the par_array

del_par(par)[source]#

Del par.

Parameters:: par (object) – Parameter controlling par.

free_all()[source]#: Free all.

freeze_all()[source]#: Freeze all.

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

get_pars_by_type(par_type)[source]#: get parameter by type

reset_dependencies()[source]#: Reset dependencies.

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]#

Display best fit pars.

Parameters:: getstring (bool, optional) – Parameter controlling getstring.
Returns:: Computed result.
Return type:: object

show_pars(getstring=False, names_list=None, sort_key=None)[source]#

Display pars.

Parameters:

getstring (bool, optional) – Parameter controlling getstring.
names_list (object, optional) – List of names.
sort_key (object, optional) – Parameter controlling sort key.

Returns:

Computed result.

Return type:

object

ModelParameterArray

Contents

ModelParameterArray#