neuland_add_random_hitpar.ParValueSet Class Reference

Data structure containing all information to generate a random value. More...

Public Member Functions
	__init__ (self, **kwargs)
	Costructor.
	empty (cls)
	Factory method to create an invalid empty object.
	is_set (self)
	Query whether the object is valid or not.
	set (self, Mode mode, float offset, float amp, int period=100, float err=0.5)
	Set all parameters of random value generations with different mode and make the object valid.
	set_clock (self, **kwargs)
	Set all random generator parameter with the clock distribution.
	set_cos (self, **kwargs)
	Set all random generator parameter with the cosine distribution.
	set_uniform (self, **kwargs)
	Set all random generator parameter with the uniform distribution.
	unset (self)
	Make the object invalid.

Public Attributes
	mode = mode
	offset = offset
	amp = amp
	period = period
	err = err

Detailed Description

Definition at line 26 of file neuland_add_random_hitpar.py.

Constructor & Destructor Documentation

__init__()

neuland_add_random_hitpar.ParValueSet.__init__	(		self,
		**	kwargs )

Parameters

kwargs

key-pairs passed to set() member function.

Definition at line 31 of file neuland_add_random_hitpar.py.

Member Function Documentation

empty()

neuland_add_random_hitpar.ParValueSet.empty

(

cls

)

Returns

An invalid empty object.

Definition at line 40 of file neuland_add_random_hitpar.py.

is_set()

neuland_add_random_hitpar.ParValueSet.is_set

(

self

)

Definition at line 48 of file neuland_add_random_hitpar.py.

set()

neuland_add_random_hitpar.ParValueSet.set	(		self,
		Mode	mode,
		float	offset,
		float	amp,
		int	period = 100,
		float	err = 0.5 )

Parameters

mode	Set a mode value (enumerator from Mode).
offset	Set a offset value
amp	Set a amplitude value
period	Set period value if Mode.COSINE is chosen
err	Set an error value

Definition at line 52 of file neuland_add_random_hitpar.py.

set_clock()

neuland_add_random_hitpar.ParValueSet.set_clock	(		self,
		**	kwargs )

Parameters

kwargs

Key-value pairs passed to set() member function

Definition at line 70 of file neuland_add_random_hitpar.py.

set_cos()

neuland_add_random_hitpar.ParValueSet.set_cos	(		self,
		**	kwargs )

Parameters

kwargs

Key-value pairs passed to set() member function

Definition at line 77 of file neuland_add_random_hitpar.py.

set_uniform()

neuland_add_random_hitpar.ParValueSet.set_uniform	(		self,
		**	kwargs )

Parameters

kwargs

Key-value pairs passed to set() member function

Definition at line 84 of file neuland_add_random_hitpar.py.

unset()

neuland_add_random_hitpar.ParValueSet.unset

(

self

)

Definition at line 91 of file neuland_add_random_hitpar.py.

Member Data Documentation

amp

neuland_add_random_hitpar.ParValueSet.amp = amp

Definition at line 66 of file neuland_add_random_hitpar.py.

err

neuland_add_random_hitpar.ParValueSet.err = err

Definition at line 68 of file neuland_add_random_hitpar.py.

mode

neuland_add_random_hitpar.ParValueSet.mode = mode

Definition at line 64 of file neuland_add_random_hitpar.py.

offset

neuland_add_random_hitpar.ParValueSet.offset = offset

Definition at line 65 of file neuland_add_random_hitpar.py.

period

neuland_add_random_hitpar.ParValueSet.period = period

Definition at line 67 of file neuland_add_random_hitpar.py.

---

The documentation for this class was generated from the following file:

• neuland/util/neuland_add_random_hitpar.py