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::bunch::weighting
19 
20 The weighting module provides algorithms for performing statistical weighting of
21 bunches.
22 
23 Implemented within this module:
24 \li \link xboa::bunch::weighting::_voronoi_weighting::VoronoiWeighting
25  VoronoiWeighting \endlink: class to apply weights based on a Voronoi
26  tesselation.
27 \li \link xboa::bunch::weighting::_bounding_ellipse::BoundingEllipse
28  BoundingEllipse \endlink: defines a BoundingEllipse for the VoronoiWeighting
29 """
30 
31 from xboa.bunch.weighting._voronoi_weighting import VoronoiWeighting
32 from xboa.bunch.weighting._bounding_ellipse import BoundingEllipse
33 
34 __all__ = ["VoronoiWeighting", "BoundingEllipse"]