1%define OT_CalibrationAlgorithm_doc
2"Base class for calibration algorithms.
3
4Parameters
5----------
6outputObservations : 2-d sequence of float
7    The output data to be fitted.
8prior : :class:`~openturns.Distribution`
9    The prior distribution of the parameter
10
11See also
12--------
13CalibrationResult"
14%enddef
15%feature("docstring") OT::CalibrationAlgorithmImplementation
16OT_CalibrationAlgorithm_doc
17
18// ---------------------------------------------------------------------
19
20%define OT_CalibrationAlgorithm_getModel_doc
21"Accessor to the model to be fitted.
22
23Returns
24-------
25data : :class:`~openturns.Function`
26    The model to be fitted."
27
28%enddef
29%feature("docstring") OT::CalibrationAlgorithmImplementation::getModel
30OT_CalibrationAlgorithm_getModel_doc
31
32// ---------------------------------------------------------------------
33
34%define OT_CalibrationAlgorithm_getInputObservations_doc
35"Accessor to the input data to be fitted.
36
37Returns
38-------
39data : :class:`~openturns.Sample`
40    The input data to be fitted."
41
42%enddef
43%feature("docstring") OT::CalibrationAlgorithmImplementation::getInputObservations
44OT_CalibrationAlgorithm_getInputObservations_doc
45
46// ---------------------------------------------------------------------
47
48%define OT_CalibrationAlgorithm_getOutputObservations_doc
49"Accessor to the output data to be fitted.
50
51Returns
52-------
53data : :class:`~openturns.Sample`
54    The output data to be fitted."
55
56%enddef
57%feature("docstring") OT::CalibrationAlgorithmImplementation::getOutputObservations
58OT_CalibrationAlgorithm_getOutputObservations_doc
59
60// ---------------------------------------------------------------------
61
62%define OT_CalibrationAlgorithm_getParameterPrior_doc
63"Accessor to the parameter prior distribution.
64
65Returns
66-------
67prior : :class:`~openturns.Distribution`
68    The parameter prior distribution."
69%enddef
70%feature("docstring") OT::CalibrationAlgorithmImplementation::getParameterPrior
71OT_CalibrationAlgorithm_getParameterPrior_doc
72
73// ---------------------------------------------------------------------
74
75%define OT_CalibrationAlgorithm_run_doc
76"Launch the algorithm.
77
78Notes
79-----
80It launches the algorithm and creates a :class:`~openturns.CalibrationResult`,
81structure containing all the results."
82%enddef
83%feature("docstring") OT::CalibrationAlgorithmImplementation::run
84OT_CalibrationAlgorithm_run_doc
85
86// ---------------------------------------------------------------------
87
88%define OT_CalibrationAlgorithm_getResult_doc
89"Get the result structure.
90
91Returns
92-------
93resCalibration: :class:`~openturns.CalibrationResult`
94    The structure containing all the results of the calibration problem.
95
96Notes
97-----
98The structure contains all the results of the calibration problem."
99%enddef
100%feature("docstring") OT::CalibrationAlgorithmImplementation::getResult
101OT_CalibrationAlgorithm_getResult_doc
102
103// ---------------------------------------------------------------------
104
105%define OT_CalibrationAlgorithm_setResult_doc
106"Accessor to optimization result.
107
108Parameters
109----------
110result : :class:`~openturns.CalibrationResult`
111    Result class."
112%enddef
113%feature("docstring") OT::CalibrationAlgorithmImplementation::setResult
114OT_CalibrationAlgorithm_setResult_doc
115
116