CLHEP VERSION Reference Documentation
CLHEP Home Page
CLHEP Documentation
CLHEP Bug Reports
GenericFunctions
GenericFunctions
GenericFunctions/SphericalHarmonicExpansion.hh
Go to the documentation of this file.
1
// -*- C++ -*-
2
// $Id:
3
//---------------------SphericalHarmonicExpansion------------------------------------------//
4
// //
5
// Class SphericalHarmonicExpansion. This is a fitting function consisting of a super //
6
// position of N legendre polynomials. Cascading fractions and phases are //
7
// the input parameters. Function is normalized to one (on [-1,1]) //
8
// Joe Boudreau, Petar Maksimovic, January 2000 //
9
// //
10
//--------------------------------------------------------------------------//
11
#ifndef SphericalHarmonicExpansion_h
12
#define SphericalHarmonicExpansion_h
13
#include "
CLHEP/GenericFunctions/AbsFunction.hh
"
14
#include "
CLHEP/GenericFunctions/Parameter.hh
"
15
#include "
CLHEP/GenericFunctions/SphericalHarmonicCoefficientSet.hh
"
16
namespace
Genfun
{
17
22
class
SphericalHarmonicExpansion :
public
AbsFunction {
23
24
FUNCTION_OBJECT_DEF
(
SphericalHarmonicExpansion
)
25
26
public
:
27
28
enum
Type
{
REAL
,
IMAG
,
MAG
,
MAGSQ
};
29
30
// Constructor. Builds all the
31
SphericalHarmonicExpansion
(
Type
type,
const
SphericalHarmonicCoefficientSet
& coefficients);
32
33
// Copy constructor
34
SphericalHarmonicExpansion
(
const
SphericalHarmonicExpansion
&right);
35
36
// Destructor
37
virtual
~SphericalHarmonicExpansion
();
38
39
// Dimensionality=2. They are; cosTheta (not theta) and phi
40
virtual
unsigned
int
dimensionality
()
const
{
return
2;}
41
42
// Retreive function value
43
virtual
double
operator ()
(
double
argument)
const
;
// Gives an error.
44
virtual
double
operator ()
(
const
Argument
&
a
)
const
;
// Must use this one
45
46
// Get the expansion coefficients:
47
SphericalHarmonicCoefficientSet
&
coefficientSet
();
48
const
SphericalHarmonicCoefficientSet
&
coefficientSet
()
const
;
49
50
private
:
51
52
// It is illegal to assign an adjustable constant
53
const
SphericalHarmonicExpansion
& operator=(
const
SphericalHarmonicExpansion
&right);
54
55
56
class
Clockwork;
57
Clockwork *c;
58
59
};
60
}
// namespace Genfun
61
62
63
64
#include "CLHEP/GenericFunctions/SphericalHarmonicExpansion.icc"
65
#endif
AbsFunction.hh
FUNCTION_OBJECT_DEF
#define FUNCTION_OBJECT_DEF(classname)
Definition:
CLHEP/GenericFunctions/AbsFunction.hh:144
Parameter.hh
SphericalHarmonicCoefficientSet.hh
Genfun::Argument
Definition:
CLHEP/GenericFunctions/Argument.hh:17
Genfun::SphericalHarmonicCoefficientSet
Definition:
CLHEP/GenericFunctions/SphericalHarmonicCoefficientSet.hh:6
Genfun::SphericalHarmonicExpansion
Definition:
CLHEP/GenericFunctions/SphericalHarmonicExpansion.hh:22
Genfun::SphericalHarmonicExpansion::SphericalHarmonicExpansion
SphericalHarmonicExpansion(Type type, const SphericalHarmonicCoefficientSet &coefficients)
Genfun::SphericalHarmonicExpansion::Type
Type
Definition:
CLHEP/GenericFunctions/SphericalHarmonicExpansion.hh:28
Genfun::SphericalHarmonicExpansion::MAG
@ MAG
Definition:
CLHEP/GenericFunctions/SphericalHarmonicExpansion.hh:28
Genfun::SphericalHarmonicExpansion::REAL
@ REAL
Definition:
CLHEP/GenericFunctions/SphericalHarmonicExpansion.hh:28
Genfun::SphericalHarmonicExpansion::IMAG
@ IMAG
Definition:
CLHEP/GenericFunctions/SphericalHarmonicExpansion.hh:28
Genfun::SphericalHarmonicExpansion::MAGSQ
@ MAGSQ
Definition:
CLHEP/GenericFunctions/SphericalHarmonicExpansion.hh:28
Genfun::SphericalHarmonicExpansion::coefficientSet
SphericalHarmonicCoefficientSet & coefficientSet()
Genfun::SphericalHarmonicExpansion::dimensionality
virtual unsigned int dimensionality() const
Definition:
GenericFunctions/SphericalHarmonicExpansion.hh:40
Genfun::SphericalHarmonicExpansion::SphericalHarmonicExpansion
SphericalHarmonicExpansion(const SphericalHarmonicExpansion &right)
Genfun::SphericalHarmonicExpansion::coefficientSet
const SphericalHarmonicCoefficientSet & coefficientSet() const
Genfun::SphericalHarmonicExpansion::~SphericalHarmonicExpansion
virtual ~SphericalHarmonicExpansion()
Genfun::SphericalHarmonicExpansion::operator()
virtual double operator()(double argument) const
Genfun
Definition:
CLHEP/GenericFunctions/Abs.hh:14
a
@ a
Definition:
testCategories.cc:125
Generated by
1.9.4