python.samplers Namespace Reference

Classes
class	ConstSampler
class	ContinuousSampler
	Continuous distribution samplers. More...
class	CyclicSeqSampler
class	DiscreteSampler
	Discrete sequence samplers. More...
class	DisjointUniformSampler
class	EEtaMPhiSampler
class	ERapMPhiSampler
class	EThetaMPhiSampler
class	GaussianSampler
class	InvSampler
class	LogSampler
class	ModUniformSampler
class	MomSampler
	Momentum sampling. More...
class	MXYZSampler
class	NullMomSampler
class	ParticleSampler
class	PosSampler
	Beam-spot (origin vertex) sampling. More...
class	PtEtaMPhiSampler
class	PtRapMPhiSampler
class	PtThetaMPhiSampler
class	RandomSeqSampler
class	SampledParticle
class	Sampler
class	TH1Sampler
class	UniformSampler

Functions
def	mksampler (x)
	Convenience function for sampler-making from Python literals. More...

Variables
	PI = math.pi
	For convenience. More...
int	TWOPI = 2*math.pi
	RndmSeq = RandomSeqSampler
	Sequence = CyclicSeqSampler
	Alias: More...
dictionary	MASSES
	Combined samplers returning a particle configuration. More...

Function Documentation

mksampler()

def python.samplers.mksampler

(

x

)

Convenience function for sampler-making from Python literals.

Automatically cast the provided object to a sampler type. This is used
extensively inside the particle and position samplers, so that the user
can pass in a primitive type like a number or list and it will be
treated as if the more verbose sampler constructors had been called.

Behaviour:
 - if x can be called, i.e. x() is valid, we just return x;
 - a Python list (square brackets) will be converted to a continuous
   UniformSampler or DisjointUniformSampler;
 - a Python tuple (round brackets/parentheses) will be treated
   as a discrete CyclicSeqSampler;
 - a Python set (curly brackets/braces) will be treated
   as a discrete RandomSeqSampler;
 - otherwise a ConstSampler will be created from x, so that x is
   returned when the sampler is called.

Definition at line 245 of file samplers.py.

def mksampler(x):
    """
    Automatically cast the provided object to a sampler type. This is used
    extensively inside the particle and position samplers, so that the user
    can pass in a primitive type like a number or list and it will be
    treated as if the more verbose sampler constructors had been called.
 
    Behaviour:
     - if x can be called, i.e. x() is valid, we just return x;
     - a Python list (square brackets) will be converted to a continuous
       UniformSampler or DisjointUniformSampler;
     - a Python tuple (round brackets/parentheses) will be treated
       as a discrete CyclicSeqSampler;
     - a Python set (curly brackets/braces) will be treated
       as a discrete RandomSeqSampler;
     - otherwise a ConstSampler will be created from x, so that x is
       returned when the sampler is called.
    """
    if callable(x):
        return x
    elif type(x) is list:
        # NB: disjoint ranges can be given as nested lists, e.g. [(1,2), (4,5)]
        if len(x) == 2 and type(x[0]) in (int,float) and type(x[1]) in (int,float):
            return UniformSampler(*x)
        elif len(x) > 2 or (len(x) > 0 and type(x[0]) not in (int,float)):
            return DisjointUniformSampler(x)
        if len(x) < 2:
            raise Exception("Supplied list could not be converted to a continuous sampler")
    elif type(x) is tuple:
        return CyclicSeqSampler(*x)
    elif type(x) is set:
        return RandomSeqSampler(*x)
    else:
        return ConstSampler(x)
 
 

Variable Documentation

MASSES

dictionary python.samplers.MASSES

Initial value:

=  { 22   :    0.0, # photon
           11   :    0.5, # electron
           12   :    0.0, # nu_e
           13   :  105.7, # muon
           14   :    0.0, # nu_mu
           15   : 1777.8, # tau
           16   :    0.0, # nu_tau
           2212 :  938.0, # proton
           2112 :  940.0, # neutron
           111  :  135.0, # pi0
           211  :  140.0, # pi+-
           221  :  547.0, # eta
           321  :  494.0, # K+-
           311  :  598.0  # K0
           }

Combined samplers returning a particle configuration.

A default dictionary of particle masses (in MeV)

Definition at line 820 of file samplers.py.

PI

python.samplers.PI = math.pi

For convenience.

Definition at line 7 of file samplers.py.

RndmSeq

python.samplers.RndmSeq = RandomSeqSampler

Definition at line 220 of file samplers.py.

Sequence

python.samplers.Sequence = CyclicSeqSampler

Alias:

Definition at line 237 of file samplers.py.

TWOPI

int python.samplers.TWOPI = 2*math.pi

Definition at line 8 of file samplers.py.