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::algorithms
19 
20 The algorithms module provides algorithms for performing common accelerator
21 physics tasks
22 
23 Implemented within this module:
24 \li \link xboa::algorithms::closed_orbit closed_orbit \endlink: module
25  containing closed orbit finding routines.
26 \li \link xboa::algorithms::tune tune \endlink: module containing tune finding
27  routines.
28 \li \link xboa::algorithms::smoothing smoothing \endlink: module containing
29  smoothing routines (for removing noise from noisy signals).
30 \li \link xboa::algorithms::peak_finder peak_finder \endlink: module containing
31  peak finding routines.
32 """
33 
34 import closed_orbit
35 import tune
36 import peak_finder
37 import smoothing
38 
39 __all__ = ["closed_orbit", "tune", "smoothing", "peak_finder"]
40