NormalizationParameters

class ompy.NormalizationParameters(name, _Model__isfrozen=False, Z=None, _A=None, D0=None, Gg=None, Sn=None, Jtarget=None, Emin=0.0, _Emax=None, steps=101, spincutModel=None, _spincutPars=None, exclude_check_change=<factory>)[source]

Bases: Model

Storage for normalization parameters + some convenience functions

Note

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

  • exclude_check_change: List[str]

    Optional Parameters (do not check in is_changed). Defaults to [“A”, “Z”, “exclude_check_change”]

Attributes Summary

A

Mass number of the nucleus

D0

Average s-wave resonance spacing D0 [eV]

Emax

Max energy to integrate <Γγ> to

Emin

Min energy to integrate <Γγ> from

Gg

Total average radiative width [meV]

Jtarget

"Target" (A-1 nucleus) ground state spin

Sn

Neutron separation energy [MeV]

Z

Element number of the nucleus

spinMass

Wrapper to get "mass" in self.spincutPars

spincutModel

Spincut model

spincutPars

Parameters necessary for the spin cut model

steps

Number of steps in energy grid

Methods Summary

E_grid([retstep])

Wrapps np.linspace creates linearly spaced array from Emin to Emax

asdict()

return fields and properties as dict

get_parameters()

Returns a list of the names of the paramters

is_changed([include, exclude])

Wrapper of Model.is_changed()

load(path)

Loads own parameters from path

save(path)

Save the model parameters to path

Attributes Documentation

A

Mass number of the nucleus

D0: Optional[Tuple[float, float]] = None

Average s-wave resonance spacing D0 [eV]

Emax

Max energy to integrate <Γγ> to

Emin: float = 0.0

Min energy to integrate <Γγ> from

Gg: Optional[Tuple[float, float]] = None

Total average radiative width [meV]

Jtarget: Optional[float] = None

“Target” (A-1 nucleus) ground state spin

Sn: Optional[Tuple[float, float]] = None

Neutron separation energy [MeV]

Z: Optional[int] = None

Element number of the nucleus

spinMass

Wrapper to get “mass” in self.spincutPars

spincutModel: str = None

Spincut model

spincutPars

Parameters necessary for the spin cut model

steps: int = 101

Number of steps in energy grid

Methods Documentation

E_grid(retstep=True)[source]

Wrapps np.linspace creates linearly spaced array from Emin to Emax

Parameters:

retstep (bool, optional) – If True (default), returns stepsize

Return type:

Union[ndarray, Tuple[ndarray, float]]

Returns:

Samples of the array. If retstep is True, returns also spacing between the samples.

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=None)[source]

Wrapper of Model.is_changed()

Return type:

None

Note: List optional/convenience parameterts in

self.exclude_check_change.

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