xboa
__init__.py
Go to the documentation of this file.
1 # This file is a part of xboa
2 #
3 # xboa is free software: you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation, either version 3 of the License, or
6 # (at your option) any later version.
7 #
8 # xboa is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
12 #
13 # You should have received a copy of the GNU General Public License
14 # along with xboa in the doc folder. If not, see
15 # <http://www.gnu.org/licenses/>.
16 
17 """
18 \namespace xboa::hit::factory
19 
20 The hit factory module defines a number of factory classes used for generating
21 hit objects
22 
23 Implemented within this module:
24 \li \link xboa::hit::factory::_maus_root_hit_factory::MausRootHitFactory
25  MausRootHitFactory \endlink: factory that reads data from a MAUS ROOT file.
26 \li \link xboa::hit::factory::_maus_json_hit_factory::MausJsonHitFactory
27  MausJsonHitFactory \endlink: factory that reads data from a MAUS JSON file.
28 \li \link xboa::hit::factory::_builtin_hit_factory::BuiltinHitFactory
29  BuiltinHitFactory \endlink: factory that reads data from various "built-in"
30  types, e.g. ICOOL, G4BL, etc.
31 \li \link xboa::hit::factory::_user_hit_factory::UserHitFactory
32  UserHitFactory \endlink: Class for reading in line-by-line data based on a
33  user-specified format.
34 \li \link xboa::hit::factory::_opal_hit_factory::OpalHitFactory
35  OpalHitFactory \endlink: Class for reading in data from OPAL tracking code.
36 \li \link xboa::hit::factory::_line_factory_base::LineFactoryBase
37  LineFactoryBase \endlink: Base class for factories that read in line-by-line.
38 \li \link xboa::hit::factory::_hit_factory_base::HitFactoryBase
39  HitFactoryBase \endlink: Base class for all other hit factory classes.
40 """
41 
42 from xboa.hit.factory._hit_factory_base import HitFactoryBase
43 from xboa.hit.factory._line_factory_base import LineFactoryBase
44 from xboa.hit.factory._maus_root_hit_factory import MausRootHitFactory
45 from xboa.hit.factory._maus_json_hit_factory import MausJsonHitFactory
46 from xboa.hit.factory._builtin_hit_factory import BuiltinHitFactory
47 from xboa.hit.factory._user_hit_factory import UserHitFactory
48 from xboa.hit.factory._opal_hit_factory import OpalHitFactory
49 
50 all = ["HitFactoryBase", "LineFactoryBase", "UserHitFactory",
51  "BuiltinHitFactory", "OpalHitFactory", "MausJsonHitFactory"]