ResultsNormalized

class ompy.ResultsNormalized(name, _Model__isfrozen=False, nld=<factory>, gsf=<factory>, pars=<factory>, samples=<factory>, nld_model=<factory>, gsf_model_low=<factory>, gsf_model_high=<factory>)

Bases: Model

Class to store the results of the Oslo Method

Note

Due to a issue with automodapi #115, members using default_factory have to be documented explicitly here

nld: Union[Vector, List[Vector]]

normalized or initial, depending on method

Type:

(Vector or List[Vector])

gsf: Union[Vector, List[Vector]]

normalized or initial, depending on method

Type:

(Vector or List[Vector])

pars: List[Dict[str, Any]]

Parameters for the normalization/models used there

Type:

(List[Dict[str, Any]])

samples: List[Dict[str, Any]]

Samples from the posterior of the parameters

Type:

(List[Dict[str, Any]])

nld_model: List[Callable[..., Any]]

nld model for each nld

Type:

(List[Callable[…, Any]])

gsf_model_low: List[AbstractExtrapolationModel]

gsf model at low Eγ for each gsf

Type:

List[AbstractExtrapolationModel]

gsf_model_high: List[AbstractExtrapolationModel]

gsf model at high Eγ for each gsf

Type:

List[AbstractExtrapolationModel]

Methods Summary

asdict()	return fields and properties as dict
get_parameters()	Returns a list of the names of the paramters
is_changed([include, exclude])	Verify that defaults arguments have been changed
load(path)	Loads own parameters from path
save(path)	Save the model parameters to path

Methods Documentation

asdict()

return fields and properties as dict

Return type:

Dict[str, Any]

get_parameters()

Returns a list of the names of the paramters

Return type:

List[str]

is_changed(include=[], exclude=[])

Verify that defaults arguments have been changed

Parameters:

• include (List[str], optional) – List of attribute names be included in the check. Default is all attributes.

• exclude (List[str], optional) – List of attribute names to exclude be excluded from check. Default is none

Raises:

ValueError – If parameters are still the default values

Return type:

None

load(path)

Loads own parameters from path

Parameters:

path (Union[str, Path]) – Path to pickled file

Raises:

IOError – Path doesn’t exist

Return type:

None

save(path)

Save the model parameters to path

Parameters:

path (Union[str, Path]) – The path

Return type:

None