python.samplers.ParticleSampler Class Reference

Inheritance diagram for python.samplers.ParticleSampler:

Collaboration diagram for python.samplers.ParticleSampler:

Public Member Functions
def	__init__ (self, pid=999, mom=NullMomSampler(), n=1, pos=PosSampler(0, 0, 0))
def	pid (self)
def	pid (self, x)
def	n (self)
def	n (self, x)
def	shoot (self)
def	__call__ (self)

Public Attributes
	pid
	mom
	n
	pos
	massdict
	mass_override

Private Attributes
	_pid
	_n

Detailed Description

A simple N-independent-particle sampler.

Definition at line 853 of file samplers.py.

Constructor & Destructor Documentation

__init__()

def python.samplers.ParticleSampler.__init__	(		self,
			pid = 999,
			mom = NullMomSampler(),
			n = 1,
			pos = PosSampler(0, 0, 0)
	)

Definition at line 858 of file samplers.py.

    def __init__(self, pid=999,
                 mom=NullMomSampler(),      # noqa: B008 (re-using same ConstSampler)
                 n=1,
                 pos=PosSampler(0, 0, 0)):  # noqa: B008 (re-using same ConstSampler)
        self.pid = pid
        self.mom = mom
        self.n = n
        self.pos = pos
        self.massdict = MASSES
        self.mass_override = True
 

Member Function Documentation

__call__()

def python.samplers.Sampler.__call__ (   self )

inherited

This is the call method that will actually be used (so that normal
functions can also be passed in as samplers).

Definition at line 17 of file samplers.py.

    def __call__(self):
        """This is the call method that will actually be used (so that normal
        functions can also be passed in as samplers)."""
        return self.shoot()
 

n() [1/2]

def python.samplers.ParticleSampler.n

(

self

)

Definition at line 878 of file samplers.py.

    def n(self):
        "Particle number sampler"
        return self._n

n() [2/2]

def python.samplers.ParticleSampler.n	(		self,
			x
	)

Definition at line 882 of file samplers.py.

    def n(self, x):
        self._n = mksampler(x)
 

pid() [1/2]

def python.samplers.ParticleSampler.pid

(

self

)

Definition at line 870 of file samplers.py.

    def pid(self):
        "Particle ID code sampler"
        return self._pid

pid() [2/2]

def python.samplers.ParticleSampler.pid	(		self,
			x
	)

Definition at line 874 of file samplers.py.

    def pid(self, x):
        self._pid = mksampler(x)
 

shoot()

def python.samplers.ParticleSampler.shoot

(

self

)

Reimplemented from python.samplers.Sampler.

Definition at line 885 of file samplers.py.

    def shoot(self):
        "Return a vector of sampled particles"
        numparticles = self.n()
        rtn = []
        for i in range(numparticles):
            
            pid = self.pid()
            p = SampledParticle(pid)
            
            if self.mass_override and abs(pid) in self.massdict:
                m = self.massdict[abs(pid)]
                self.mom.mass = m
                p.mass = m
            # TODO: Should the particle generated_mass be set from the sampler by default?
            
            p.mom = self.mom()
            p.pos = self.pos()
            
            rtn.append(p)
        return rtn

Member Data Documentation

_n

python.samplers.ParticleSampler._n

private

Definition at line 883 of file samplers.py.

_pid

python.samplers.ParticleSampler._pid

private

Definition at line 875 of file samplers.py.

mass_override

python.samplers.ParticleSampler.mass_override

Definition at line 864 of file samplers.py.

massdict

python.samplers.ParticleSampler.massdict

Definition at line 863 of file samplers.py.

mom

python.samplers.ParticleSampler.mom

Definition at line 860 of file samplers.py.

n

python.samplers.ParticleSampler.n

Definition at line 861 of file samplers.py.

pid

python.samplers.ParticleSampler.pid

Definition at line 859 of file samplers.py.

pos

python.samplers.ParticleSampler.pos

Definition at line 862 of file samplers.py.

---

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

• samplers.py