LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
minimize.h
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 
3 /*
4  * LSST Data Management System
5  * Copyright 2008, 2009, 2010 LSST Corporation.
6  *
7  * This product includes software developed by the
8  * LSST Project (http://www.lsst.org/).
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the LSST License Statement and
21  * the GNU General Public License along with this program. If not,
22  * see <http://www.lsstcorp.org/LegalNotices/>.
23  */
24 
25 #ifndef LSST_AFW_MATH_MINIMIZE_H
26 #define LSST_AFW_MATH_MINIMIZE_H
27 
38 #include "boost/shared_ptr.hpp"
39 #include "Minuit2/FCNBase.h"
40 
41 #include "lsst/daf/base/Citizen.h"
42 #include "lsst/afw/math/Function.h"
43 
44 namespace lsst {
45 namespace afw {
46 namespace math {
47 
51  struct FitResults {
52  public:
53  bool isValid;
54  double chiSq;
55  std::vector<double> parameterList;
56  std::vector<std::pair<double,double> > parameterErrorList;
57  };
58 
59  template<typename ReturnT>
62  std::vector<double> const &initialParameterList,
63  std::vector<double> const &stepSizeList,
64  std::vector<double> const &measurementList,
65  std::vector<double> const &varianceList,
66  std::vector<double> const &xPositionList,
67  double errorDef
68  );
69 
70  template<typename ReturnT>
73  std::vector<double> const &initialParameterList,
74  std::vector<double> const &stepSizeList,
75  std::vector<double> const &measurementList,
76  std::vector<double> const &varianceList,
77  std::vector<double> const &xPositionList,
78  std::vector<double> const &yPositionList,
79  double errorDef
80  );
81 
82 }}} // lsst::afw::math
83 
84 #endif // !defined(LSST_AFW_MATH_MINIMIZE_H)
bool isValid
true if the fit converged; false otherwise
Definition: minimize.h:53
FitResults minimize(lsst::afw::math::Function1< ReturnT > const &function, std::vector< double > const &initialParameterList, std::vector< double > const &stepSizeList, std::vector< double > const &measurementList, std::vector< double > const &varianceList, std::vector< double > const &xPositionList, double errorDef)
A Function taking two arguments.
Definition: Function.h:300
Results from minimizing a function.
Definition: minimize.h:51
A Function taking one argument.
Definition: Function.h:229
std::vector< double > parameterList
fit parameters
Definition: minimize.h:55
Define the basic Function classes.
std::vector< std::pair< double, double > > parameterErrorList
negative,positive (1 sigma?) error for each parameter
Definition: minimize.h:56
double chiSq
chi squared; may be nan or infinite, but only if isValid false
Definition: minimize.h:54