generalShell

This module contains the general fitting and simulation programs.

FnTemplate

class generalShell.fitting.FnTemplate.FnTemplate(particles=[], accepted=None, raw=None)

This class represents a single gamp event. That is to say that this class contains a set of particles and a flag to specify if this event is accepted into the filtered data set.

__init__(particles=[], accepted=None, raw=None)

FnTemplate class default constructor.

Kwargs:

particles (list): A list of generalFitting items.

accepted (bool): Flag to denote if the FnTemplate instance is accepted.

raw (bool): Flag to denote if the FnTemplate instance is raw.

writeGamp(outputFile)

This function writes a gamp event instance to an output file.

Args:

outputFile (file): Output .gamp file to write the event instance to.

writeGampIfAccepted(outputFile)

This function writes a gamp event instance to an output file, but only if the accepted data member of said gamp event instance is True.

Args:

outputFile (file): Output .gamp file to write the event instance to.

generalFitting

class generalShell.fitting.generalFitting.generalFitting(particleID=None, particleCharge=None, particleXMomentum=None, particleYMomentum=None, particleZMomentum=None, particleE=None)

This class represents a particle described in a single line of a .gamp file.

__init__(particleID=None,particleCharge=None,particleXMomentum=None,particleYMomentum=None, particleZMomentum=None,particleE=None)

generalFitting class default constructor.

Kwargs:

particleID (int): Key used to lookup the type of this particle.

particleCharge (float): The electric charge value of this particle.

particleXMomentum (float): X-direction momentum of this particle.

particleYMomentum (float): Y-direction momentum of this particle.

particleZMomentum (float): Z-direction momentum of this particle.

particleE (float): Total energy of this particle.

toString()

Returns a string of the particle data members delimited by newlines.

FnSimTemplate

class generalShell.fitting.FnSimTemplate.FnSimTemplate(cR=1.0, wR=[], w0=1.0, r0=0.5, phase=0.0)

This class represents a FnSimTemplate.

__init__(cR=1.0, wR=[], w0=1.0, r0=0.5, phase=0.0)

Default constructor for FnSimTemplate class.

Kwargs:

cR (float): Percent of this FnSimTemplate in a set of FnSimTemplates.

wR (list): List of percents of each wave in this FnSimTemplate.

w0 (float): Mass of this FnSimTemplate in GeV/c^2.

r0 (float): Width of this FnSimTemplate in GeV/c^2.

phase (float): Relative phase of all waves in this FnSimTemplate.

toString()

Returns a string of the FnSimTemplate data memebers delimited by newlines.

wave

class generalShell.fitting.wave.wave(epsilon=0, complexamplitudes=[], w0=1000.0, r0=100.0, beta=0, k=0, filename=None)

This class represents a PWA wave.

__init__(epsilon=0, complexamplitudes=[], w0=1000.0, r0=100.0, beta=0, k=0, filename=None)

Default constructor for the wave class

Kwargs:

epsilon (int): Integer representing reflectivity of this wave.

beta (int):

k (int):

filename (string): Name of the file used to instantiate a wave instance, if getwaves was used to instantiate the wave instance.

toString()

returns a string of all the wave properties delimited by newlines.

Table Of Contents