xboa
Public Member Functions | Static Public Attributes | List of all members
HitFactoryBase Class Reference

Base factory class for making hits. More...

Inherits object.

Public Member Functions

def __init__
 Initialise the base class. More...
 
def make_hit
 Generate a new hit. More...
 
def hit_generator
 
def new_spill
 Load the next spill from the file handle. More...
 
def bad_pid
 

Static Public Attributes

list bad_pids = []
 

Detailed Description

Base factory class for making hits.

Definition at line 23 of file _hit_factory_base.py.

Constructor & Destructor Documentation

def __init__ (   self)

Initialise the base class.

Definition at line 28 of file _hit_factory_base.py.

Member Function Documentation

def make_hit (   self)

Generate a new hit.

Definition at line 35 of file _hit_factory_base.py.

Referenced by HitFactoryBase.hit_generator().

def hit_generator (   self)
def new_spill (   self)

Load the next spill from the file handle.

For files that have data bundled into spills (i.e. MAUS format), this enables user to load the next spill. Otherwise it is a no-op.

Definition at line 59 of file _hit_factory_base.py.

Referenced by HitFactoryBase.hit_generator(), MausRootHitFactory.make_hit(), and MausJsonHitFactory.make_hit().

def bad_pid (   cls,
  pid 
)

Definition at line 63 of file _hit_factory_base.py.

Referenced by MausRootHitFactory._read_primaries().

Member Data Documentation

list bad_pids = []
static

Definition at line 68 of file _hit_factory_base.py.

Referenced by BuiltinHitFactory.make_hit().


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