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
19 
20 Implemented within this module:
21 \li \link xboa::hit::_hit::Hit Hit \endlink: represents a particle at a point in
22  phase space. Hit contains functions for i/o, as well as accessors for
23  rectangular or cylindrical coordinate systems and functions to perform
24  translations, abelian transformations etc.
25 \li \link xboa::hit::factory factory \endlink: module containing hit "factory"
26  classes that can be used for generating new hit objects, e.g. by reading in
27  data from a file. These factory objects are wrapped by
28  \link xboa::bunch::_bunch::Bunch::new_from_read_builtin Bunch.new_from_read_builtin \endlink and this is the preferred way of loading data.
29 """
30 
31 from _hit import Hit
32 from _hit import BadEventError
33 all = ["Hit", "BadEventError"]
34 
35