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::closed_orbit
19 
20 The closed_orbit module provides algorithms for finding closed_orbits
21 
22 Implemented within this module:
23 \li \link xboa::algorithms::closed_orbit::_ellipse_closed_orbit_finder::EllipseClosedOrbitFinder EllipseClosedOrbitFinder \endlink:
24  class for finding closed orbits based on fitting a beam ellipse to a set of
25  input tracking data.
26 \li \link xboa::algorithms::closed_orbit::_ellipse_closed_orbit_finder::EllipseClosedOrbitFinderIteration EllipseClosedOrbitFinderIteration \endlink:
27  helper class for EllipseClosedOrbitFinder; this class represents the output of
28  a single iteration of the closed orbit finder
29 """
30 
31 from _ellipse_closed_orbit_finder import EllipseClosedOrbitFinder
32 from _ellipse_closed_orbit_finder import EllipseClosedOrbitFinderIteration
33 
34 __all__ = ["EllipseClosedOrbitFinder", "EllipseClosedOrbitFinderIteration"]
35