doc/en/ref_algorithm_QuantileRegression.rst

   1 ..
   2    Copyright (C) 2008-2018 EDF R&D
   3
   4    This file is part of SALOME ADAO module.
   5
   6    This library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2.1 of the License, or (at your option) any later version.
  10
  11    This library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with this library; if not, write to the Free Software
  18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19
  20    See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21
  22    Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
  23
  24 .. index:: single: QuantileRegression
  25 .. _section_ref_algorithm_QuantileRegression:
  26
  27 Calculation algorithm "*QuantileRegression*"
  28 --------------------------------------------
  29
  30 Description
  31 +++++++++++
  32
  33 This algorithm allows to estimate the conditional quantiles of the state
  34 parameters distribution, expressed with a model of the observed variables. These
  35 are then the quantiles on the observed variables which will allow to determine
  36 the model parameters that satisfy to the quantiles conditions.
  37
  38 Optional and required commands
  39 ++++++++++++++++++++++++++++++
  40
  41 The general required commands, available in the editing user interface, are the
  42 following:
  43
  44   .. include:: snippets/Background.rst
  45
  46   .. include:: snippets/Observation.rst
  47
  48   .. include:: snippets/ObservationOperator.rst
  49
  50 The general optional commands, available in the editing user interface, are
  51 indicated in :ref:`section_ref_assimilation_keywords`. Moreover, the parameters
  52 of the command "*AlgorithmParameters*" allows to choose the specific options,
  53 described hereafter, of the algorithm. See
  54 :ref:`section_ref_options_Algorithm_Parameters` for the good use of this
  55 command.
  56
  57 The options of the algorithm are the following:
  58
  59   .. include:: snippets/Quantile.rst
  60
  61   .. include:: snippets/MaximumNumberOfSteps.rst
  62
  63   .. include:: snippets/CostDecrementTolerance_6.rst
  64
  65   .. include:: snippets/BoundsWithNone.rst
  66
  67   StoreSupplementaryCalculations
  68     .. index:: single: StoreSupplementaryCalculations
  69
  70     This list indicates the names of the supplementary variables that can be
  71     available at the end of the algorithm. It involves potentially costly
  72     calculations or memory consumptions. The default is a void list, none of
  73     these variables being calculated and stored by default. The possible names
  74     are in the following list: ["BMA", "CostFunctionJ", "CostFunctionJb",
  75     "CostFunctionJo", "CurrentState", "OMA", "OMB", "Innovation",
  76     "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
  77     "SimulatedObservationAtOptimum"].
  78
  79     Example :
  80     ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
  81
  82 *Tips for this algorithm:*
  83
  84     As the *"BackgroundError"* and *"ObservationError"* commands are required
  85     for ALL the calculation algorithms in the interface, you have to provide a
  86     value, even if these commands are not required for this algorithm, and will
  87     not be used. The simplest way is to give "1" as a STRING for both.
  88
  89 Information and variables available at the end of the algorithm
  90 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  91
  92 At the output, after executing the algorithm, there are variables and
  93 information originating from the calculation. The description of
  94 :ref:`section_ref_output_variables` show the way to obtain them by the method
  95 named ``get`` of the variable "*ADD*" of the post-processing. The input
  96 variables, available to the user at the output in order to facilitate the
  97 writing of post-processing procedures, are described in the
  98 :ref:`subsection_r_o_v_Inventaire`.
  99
 100 The unconditional outputs of the algorithm are the following:
 101
 102   .. include:: snippets/Analysis.rst
 103
 104   .. include:: snippets/CostFunctionJ.rst
 105
 106   .. include:: snippets/CostFunctionJb.rst
 107
 108   .. include:: snippets/CostFunctionJo.rst
 109
 110 The conditional outputs of the algorithm are the following:
 111
 112   .. include:: snippets/BMA.rst
 113
 114   .. include:: snippets/CurrentState.rst
 115
 116   .. include:: snippets/Innovation.rst
 117
 118   .. include:: snippets/OMA.rst
 119
 120   .. include:: snippets/OMB.rst
 121
 122   .. include:: snippets/SimulatedObservationAtBackground.rst
 123
 124   .. include:: snippets/SimulatedObservationAtCurrentState.rst
 125
 126   .. include:: snippets/SimulatedObservationAtOptimum.rst
 127
 128 See also
 129 ++++++++
 130
 131 Bibliographical references:
 132   - [Buchinsky98]_
 133   - [Cade03]_
 134   - [Koenker00]_
 135   - [Koenker01]_
 136   - [WikipediaQR]_