.. index:: single: CostDecrementTolerance
.. index:: single: ProjectedGradientTolerance
.. index:: single: GradientNormTolerance
-.. index:: single: StoreInternalVariables
.. index:: single: StoreSupplementaryCalculations
.. index:: single: Quantiles
.. index:: single: SetSeed
Example : ``{"GradientNormTolerance":1.e-5}``
- StoreInternalVariables
- This Boolean key allows to store default internal variables, mainly the
- current state during iterative optimization process. Be careful, this can be
- a numerically costly choice in certain calculation cases. The default is
- "False".
-
- Example : ``{"StoreInternalVariables":True}``
-
StoreSupplementaryCalculations
This list indicates the names of the supplementary variables that can be
available at the end of the algorithm. It involves potentially costly
calculations or memory consumptions. The default is a void list, none of
these variables being calculated and stored by default. The possible names
- are in the following list: ["APosterioriCovariance", "BMA", "OMA", "OMB",
- "Innovation", "SigmaObs2", "MahalanobisConsistency", "SimulationQuantiles"].
+ are in the following list: ["APosterioriCovariance", "BMA", "CostFunctionJ",
+ "CurrentState", "OMA", "OMB", "Innovation", "SigmaObs2",
+ "MahalanobisConsistency", "SimulatedObservationAtBackground",
+ "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum",
+ "SimulationQuantiles"].
Example : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
.. index:: single: Observation
.. index:: single: ObservationError
.. index:: single: ObservationOperator
-.. index:: single: StoreInternalVariables
.. index:: single: StoreSupplementaryCalculations
.. index:: single: Quantiles
.. index:: single: SetSeed
The options of the algorithm are the following:
- StoreInternalVariables
- This Boolean key allows to store default internal variables, mainly the
- current state during iterative optimization process. Be careful, this can be
- a numerically costly choice in certain calculation cases. The default is
- "False".
-
- Example : ``{"StoreInternalVariables":True}``
-
StoreSupplementaryCalculations
This list indicates the names of the supplementary variables that can be
available at the end of the algorithm. It involves potentially costly
calculations or memory consumptions. The default is a void list, none of
these variables being calculated and stored by default. The possible names
- are in the following list: ["APosterioriCovariance", "BMA", "OMA", "OMB",
- "Innovation", "SigmaBck2", "SigmaObs2", "MahalanobisConsistency",
- "SimulationQuantiles"].
+ are in the following list: ["APosterioriCovariance", "BMA", "CostFunctionJ",
+ "OMA", "OMB", "Innovation", "SigmaBck2", "SigmaObs2",
+ "MahalanobisConsistency", "SimulatedObservationAtBackground",
+ "SimulatedObservationAtOptimum", "SimulationQuantiles"].
Example : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
.. index:: single: Observation
.. index:: single: ObservationError
.. index:: single: ObservationOperator
-.. index:: single: StoreInternalVariables
.. index:: single: StoreSupplementaryCalculations
.. index:: single: Quantiles
.. index:: single: SetSeed
The options of the algorithm are the following:
- StoreInternalVariables
- This Boolean key allows to store default internal variables, mainly the
- current state during iterative optimization process. Be careful, this can be
- a numerically costly choice in certain calculation cases. The default is
- "False".
-
- Example : ``{"StoreInternalVariables":True}``
-
StoreSupplementaryCalculations
This list indicates the names of the supplementary variables that can be
available at the end of the algorithm. It involves potentially costly
calculations or memory consumptions. The default is a void list, none of
these variables being calculated and stored by default. The possible names
- are in the following list: ["APosterioriCovariance", "BMA", "OMA", "OMB",
- "Innovation", "SigmaBck2", "SigmaObs2", "MahalanobisConsistency",
- "SimulationQuantiles"].
+ are in the following list: ["APosterioriCovariance", "BMA",
+ "CostFunctionJ", "OMA", "OMB", "Innovation", "SigmaBck2", "SigmaObs2",
+ "MahalanobisConsistency", "SimulatedObservationAtBackground",
+ "SimulatedObservationAtOptimum", "SimulationQuantiles"].
Example : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
Example : ``so2 = ADD.get("SigmaObs")[-1]``
- SimulationQuantiles
- *List of vectors*. Each element is a vector corresponding to the observed
- state which realize the required quantile, in the same order than the
- quantiles required by the user.
-
- Example : ``sQuantiles = ADD.get("SimulationQuantiles")[:]``
-
SimulatedObservationAtBackground
*List of vectors*. Each element is a vector of observation simulated from
the background :math:`\mathbf{x}^b`.
Example : ``hxa = ADD.get("SimulatedObservationAtOptimum")[-1]``
+ SimulationQuantiles
+ *List of vectors*. Each element is a vector corresponding to the observed
+ state which realize the required quantile, in the same order than the
+ quantiles required by the user.
+
+ Example : ``sQuantiles = ADD.get("SimulationQuantiles")[:]``
+
See also
++++++++
.. index:: single: Bounds
.. index:: single: ConstrainedBy
.. index:: single: EstimationOf
-.. index:: single: StoreInternalVariables
.. index:: single: StoreSupplementaryCalculations
The general required commands, available in the editing user interface, are the
Example : ``{"EstimationOf":"Parameters"}``
- StoreInternalVariables
- This Boolean key allows to store default internal variables, mainly the
- current state during iterative optimization process. Be careful, this can be
- a numerically costly choice in certain calculation cases. The default is
- "False".
-
- Example : ``{"StoreInternalVariables":True}``
-
StoreSupplementaryCalculations
This list indicates the names of the supplementary variables that can be
available at the end of the algorithm. It involves potentially costly
calculations or memory consumptions. The default is a void list, none of
these variables being calculated and stored by default. The possible names
- are in the following list: ["APosterioriCovariance", "BMA", "Innovation"].
+ are in the following list: ["APosterioriCovariance", "BMA", "CostFunctionJ",
+ "CurrentState", "Innovation"].
Example : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
the difference between the optimal and the background, and in dynamic the
evolution increment.
+ Exemple : ``d = ADD.get("Innovation")[-1]``
+
See also
++++++++
.. index:: single: ObservationError
.. index:: single: ObservationOperator
.. index:: single: EstimationOf
-.. index:: single: StoreInternalVariables
.. index:: single: StoreSupplementaryCalculations
The general required commands, available in the editing user interface, are the
Example : ``{"EstimationOf":"Parameters"}``
- StoreInternalVariables
- This Boolean key allows to store default internal variables, mainly the
- current state during iterative optimization process. Be careful, this can be
- a numerically costly choice in certain calculation cases. The default is
- "False".
-
- Example : ``{"StoreInternalVariables":True}``
-
StoreSupplementaryCalculations
This list indicates the names of the supplementary variables that can be
available at the end of the algorithm. It involves potentially costly
calculations or memory consumptions. The default is a void list, none of
these variables being calculated and stored by default. The possible names
- are in the following list: ["APosterioriCovariance", "BMA", "Innovation"].
+ are in the following list: ["APosterioriCovariance", "BMA", "CostFunctionJ",
+ "CurrentState", "Innovation"].
Example : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
the difference between the optimal and the background, and in dynamic the
evolution increment.
+ Exemple : ``d = ADD.get("Innovation")[-1]``
+
See also
++++++++
.. index:: single: Observation
.. index:: single: ObservationError
.. index:: single: ObservationOperator
-.. index:: single: StoreInternalVariables
.. index:: single: StoreSupplementaryCalculations
The general required commands, available in the editing user interface, are the
The options of the algorithm are the following:
- StoreInternalVariables
- This Boolean key allows to store default internal variables, mainly the
- current state during iterative optimization process. Be careful, this can be
- a numerically costly choice in certain calculation cases. The default is
- "False".
-
- Example : ``{"StoreInternalVariables":True}``
-
StoreSupplementaryCalculations
This list indicates the names of the supplementary variables that can be
available at the end of the algorithm. It involves potentially costly
calculations or memory consumptions. The default is a void list, none of
these variables being calculated and stored by default. The possible names
- are in the following list: ["OMA"].
+ are in the following list: ["OMA", "CostFunctionJ",
+ "SimulatedObservationAtOptimum"].
Example : ``{"StoreSupplementaryCalculations":["OMA"]}``
.. index:: single: CostDecrementTolerance
.. index:: single: ProjectedGradientTolerance
.. index:: single: GradientNormTolerance
-.. index:: single: StoreInternalVariables
.. index:: single: StoreSupplementaryCalculations
The general required commands, available in the editing user interface, are the
Example : ``{"GradientNormTolerance":1.e-5}``
- StoreInternalVariables
- This Boolean key allows to store default internal variables, mainly the
- current state during iterative optimization process. Be careful, this can be
- a numerically costly choice in certain calculation cases. The default is
- "False".
-
- Example : ``{"StoreInternalVariables":True}``
-
StoreSupplementaryCalculations
This list indicates the names of the supplementary variables that can be
available at the end of the algorithm. It involves potentially costly
calculations or memory consumptions. The default is a void list, none of
these variables being calculated and stored by default. The possible names
- are in the following list: ["BMA", "OMA", "OMB", "Innovation"].
+ are in the following list: ["APosterioriCovariance", "BMA",
+ "CostFunctionJ", "CurrentState", "OMA", "OMB", "Innovation", "SigmaObs2",
+ "MahalanobisConsistency", "SimulatedObservationAtCurrentState",
+ "SimulatedObservationAtOptimum"].
Example : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
.. index:: single: QualityCriterion
.. index:: single: BoxBounds
.. index:: single: SetSeed
-.. index:: single: StoreInternalVariables
.. index:: single: StoreSupplementaryCalculations
The general required commands, available in the editing user interface, are the
Example : ``{"SetSeed":1000}``
- StoreInternalVariables
- This Boolean key allows to store default internal variables, mainly the
- current state during iterative optimization process. Be careful, this can be
- a numerically costly choice in certain calculation cases. The default is
- "False".
-
- Example : ``{"StoreInternalVariables":True}``
-
StoreSupplementaryCalculations
This list indicates the names of the supplementary variables that can be
available at the end of the algorithm. It involves potentially costly
calculations or memory consumptions. The default is a void list, none of
these variables being calculated and stored by default. The possible names
- are in the following list: ["BMA", "OMA", "OMB", "Innovation"].
+ are in the following list: ["BMA", "CostFunctionJ", "CurrentState", "OMA",
+ "OMB", "Innovation", "SimulatedObservationAtBackground",
+ "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"].
Example : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
.. index:: single: Minimizer
.. index:: single: MaximumNumberOfSteps
.. index:: single: CostDecrementTolerance
-.. index:: single: StoreInternalVariables
.. index:: single: StoreSupplementaryCalculations
The general required commands, available in the editing user interface, are the
Example : ``{"CostDecrementTolerance":1.e-7}``
- StoreInternalVariables
- This Boolean key allows to store default internal variables, mainly the
- current state during iterative optimization process. Be careful, this can be
- a numerically costly choice in certain calculation cases. The default is
- "False".
-
- Example : ``{"StoreInternalVariables":True}``
-
StoreSupplementaryCalculations
This list indicates the names of the supplementary variables that can be
available at the end of the algorithm. It involves potentially costly
calculations or memory consumptions. The default is a void list, none of
these variables being calculated and stored by default. The possible names
- are in the following list: ["BMA", "OMA", "OMB", "Innovation"].
+ are in the following list: ["BMA", "CostFunctionJ", "CurrentState", "OMA",
+ "OMB", "Innovation", "SimulatedObservationAtBackground",
+ "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"].
Example : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
.. index:: single: Beta
.. index:: single: Kappa
.. index:: single: Reconditioner
-.. index:: single: StoreInternalVariables
.. index:: single: StoreSupplementaryCalculations
The general required commands, available in the editing user interface, are the
Example : ``{"Alpha":1,"Beta":2,"Kappa":0,"Reconditioner":1}``
- StoreInternalVariables
- This Boolean key allows to store default internal variables, mainly the
- current state during iterative optimization process. Be careful, this can be
- a numerically costly choice in certain calculation cases. The default is
- "False".
-
- Example : ``{"StoreInternalVariables":True}``
-
StoreSupplementaryCalculations
This list indicates the names of the supplementary variables that can be
available at the end of the algorithm. It involves potentially costly
calculations or memory consumptions. The default is a void list, none of
these variables being calculated and stored by default. The possible names
- are in the following list: ["APosterioriCovariance", "BMA", "Innovation"].
+ are in the following list: ["APosterioriCovariance", "BMA", "CostFunctionJ",
+ "CurrentState", "Innovation"].
Example : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
In the entry, one must enclose a standard dictionary definition between simple
quotes, as for example::
- '{"StoreInternalVariables":True,"MaximumNumberOfSteps":25}'
+ '{"MaximumNumberOfSteps":25,"SetSeed":1000}'
It is the recommended way to define algorithmic parameters.
name "*AlgorithmParameters*", as in the following example::
AlgorithmParameters = {
- "StoreInternalVariables" : True,
"MaximumNumberOfSteps" : 25,
"StoreSupplementaryCalculations" : ["APosterioriCovariance","OMA"],
}
Cross compliance of the information available at the output
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-.. index:: single: StoreInternalVariables
.. index:: single: AlgorithmParameters
.. index:: single: Stored
and/or if they have been requested before the execution of the calculation.
It is recalled that the user can request additional information during the
-preparation of its ADAO case, using option "*StoreInternalVariables*" each
-algorithm through the optional control "*AlgorithmParameters*" of ADAO case.
-Reference will be made to the :ref:`section_ref_options_AlgorithmParameters` for
-the proper use of this command, and to the description of each algorithm for
-the information available by algorithm. One can also ask to keep some input
-information by changing the boolean "* * Stored" associated with it in the
-edition of the ADAO case.
+preparation of its ADAO case, using the optional control "*AlgorithmParameters*"
+of ADAO case. Reference will be made to the
+:ref:`section_ref_options_AlgorithmParameters` for the proper use of this
+command, and to the description of each algorithm for the information available
+by algorithm. One can also ask to keep some input information by changing the
+boolean "* * Stored" associated with it in the edition of the ADAO case.
.. _subsection_r_o_v_Inventaire:
.. index:: single: CostDecrementTolerance
.. index:: single: ProjectedGradientTolerance
.. index:: single: GradientNormTolerance
-.. index:: single: StoreInternalVariables
.. index:: single: StoreSupplementaryCalculations
.. index:: single: Quantiles
.. index:: single: SetSeed
Exemple : ``{"GradientNormTolerance":1.e-5}``
- StoreInternalVariables
- Cette clé booléenne permet de stocker les variables internes par défaut,
- principalement l'état courant lors d'un processus itératif. Attention, cela
- peut être un choix numériquement coûteux dans certains cas de calculs. La
- valeur par défaut est "False".
-
- Exemple : ``{"StoreInternalVariables":True}``
-
StoreSupplementaryCalculations
Cette liste indique les noms des variables supplémentaires qui peuvent être
disponibles à la fin de l'algorithme. Cela implique potentiellement des
calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
aucune de ces variables n'étant calculée et stockée par défaut. Les noms
possibles sont dans la liste suivante : ["APosterioriCovariance", "BMA",
- "OMA", "OMB", "Innovation", "SigmaObs2", "MahalanobisConsistency",
+ "CostFunctionJ", "CurrentState", "OMA", "OMB", "Innovation", "SigmaObs2",
+ "MahalanobisConsistency", "SimulatedObservationAtBackground",
+ "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum",
"SimulationQuantiles"].
Exemple : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
.. index:: single: Observation
.. index:: single: ObservationError
.. index:: single: ObservationOperator
-.. index:: single: StoreInternalVariables
.. index:: single: StoreSupplementaryCalculations
.. index:: single: Quantiles
.. index:: single: SetSeed
Les options de l'algorithme sont les suivantes:
- StoreInternalVariables
- Cette clé booléenne permet de stocker les variables internes par défaut,
- principalement l'état courant lors d'un processus itératif. Attention, cela
- peut être un choix numériquement coûteux dans certains cas de calculs. La
- valeur par défaut est "False".
-
- Exemple : ``{"StoreInternalVariables":True}``
-
StoreSupplementaryCalculations
Cette liste indique les noms des variables supplémentaires qui peuvent être
disponibles à la fin de l'algorithme. Cela implique potentiellement des
calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
aucune de ces variables n'étant calculée et stockée par défaut. Les noms
possibles sont dans la liste suivante : ["APosterioriCovariance", "BMA",
- "OMA", "OMB", "Innovation", "SigmaBck2", "SigmaObs2",
- "MahalanobisConsistency", "SimulationQuantiles"].
+ "CostFunctionJ", "OMA", "OMB", "Innovation", "SigmaBck2", "SigmaObs2",
+ "MahalanobisConsistency", "SimulatedObservationAtBackground",
+ "SimulatedObservationAtOptimum", "SimulationQuantiles"].
Exemple : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
.. index:: single: Observation
.. index:: single: ObservationError
.. index:: single: ObservationOperator
-.. index:: single: StoreInternalVariables
.. index:: single: StoreSupplementaryCalculations
.. index:: single: Quantiles
.. index:: single: SetSeed
Les options de l'algorithme sont les suivantes:
- StoreInternalVariables
- Cette clé booléenne permet de stocker les variables internes par défaut,
- principalement l'état courant lors d'un processus itératif. Attention, cela
- peut être un choix numériquement coûteux dans certains cas de calculs. La
- valeur par défaut est "False".
-
- Exemple : ``{"StoreInternalVariables":True}``
-
StoreSupplementaryCalculations
Cette liste indique les noms des variables supplémentaires qui peuvent être
disponibles à la fin de l'algorithme. Cela implique potentiellement des
calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
aucune de ces variables n'étant calculée et stockée par défaut. Les noms
possibles sont dans la liste suivante : ["APosterioriCovariance", "BMA",
- "OMA", "OMB", "Innovation", "SigmaBck2", "SigmaObs2",
- "MahalanobisConsistency", "SimulationQuantiles"].
+ "CostFunctionJ", "OMA", "OMB", "Innovation", "SigmaBck2", "SigmaObs2",
+ "MahalanobisConsistency", "SimulatedObservationAtBackground",
+ "SimulatedObservationAtOptimum", "SimulationQuantiles"].
Exemple : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
.. index:: single: Bounds
.. index:: single: ConstrainedBy
.. index:: single: EstimationOf
-.. index:: single: StoreInternalVariables
.. index:: single: StoreSupplementaryCalculations
Les commandes requises générales, disponibles dans l'interface en édition, sont
Exemple : ``{"EstimationOf":"Parameters"}``
- StoreInternalVariables
- Cette clé booléenne permet de stocker les variables internes par défaut,
- principalement l'état courant lors d'un processus itératif. Attention, cela
- peut être un choix numériquement coûteux dans certains cas de calculs. La
- valeur par défaut est "False".
-
- Exemple : ``{"StoreInternalVariables":True}``
-
StoreSupplementaryCalculations
Cette liste indique les noms des variables supplémentaires qui peuvent être
disponibles à la fin de l'algorithme. Cela implique potentiellement des
calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
aucune de ces variables n'étant calculée et stockée par défaut. Les noms
possibles sont dans la liste suivante : ["APosterioriCovariance", "BMA",
- "Innovation"].
+ "CostFunctionJ", "CurrentState", "Innovation"].
Exemple : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
.. index:: single: ObservationError
.. index:: single: ObservationOperator
.. index:: single: EstimationOf
-.. index:: single: StoreInternalVariables
.. index:: single: StoreSupplementaryCalculations
Les commandes requises générales, disponibles dans l'interface en édition, sont
Exemple : ``{"EstimationOf":"Parameters"}``
- StoreInternalVariables
- Cette clé booléenne permet de stocker les variables internes par défaut,
- principalement l'état courant lors d'un processus itératif. Attention, cela
- peut être un choix numériquement coûteux dans certains cas de calculs. La
- valeur par défaut est "False".
-
- Exemple : ``{"StoreInternalVariables":True}``
-
StoreSupplementaryCalculations
Cette liste indique les noms des variables supplémentaires qui peuvent être
disponibles à la fin de l'algorithme. Cela implique potentiellement des
calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
aucune de ces variables n'étant calculée et stockée par défaut. Les noms
possibles sont dans la liste suivante : ["APosterioriCovariance", "BMA",
- "Innovation"].
+ "CostFunctionJ", "CurrentState", "Innovation"].
Exemple : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
.. index:: single: Observation
.. index:: single: ObservationError
.. index:: single: ObservationOperator
-.. index:: single: StoreInternalVariables
.. index:: single: StoreSupplementaryCalculations
Les commandes requises générales, disponibles dans l'interface en édition, sont
Les options de l'algorithme sont les suivantes:
- StoreInternalVariables
- Cette clé booléenne permet de stocker les variables internes par défaut,
- principalement l'état courant lors d'un processus itératif. Attention, cela
- peut être un choix numériquement coûteux dans certains cas de calculs. La
- valeur par défaut est "False".
-
- Exemple : ``{"StoreInternalVariables":True}``
-
StoreSupplementaryCalculations
Cette liste indique les noms des variables supplémentaires qui peuvent être
disponibles à la fin de l'algorithme. Cela implique potentiellement des
calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
aucune de ces variables n'étant calculée et stockée par défaut. Les noms
- possibles sont dans la liste suivante : ["OMA"].
+ possibles sont dans la liste suivante : ["OMA", "CostFunctionJ",
+ "SimulatedObservationAtOptimum"].
Exemple : ``{"StoreSupplementaryCalculations":["OMA"]}``
.. index:: single: CostDecrementTolerance
.. index:: single: ProjectedGradientTolerance
.. index:: single: GradientNormTolerance
-.. index:: single: StoreInternalVariables
.. index:: single: StoreSupplementaryCalculations
Les commandes requises générales, disponibles dans l'interface en édition, sont
Exemple : ``{"GradientNormTolerance":1.e-5}``
- StoreInternalVariables
- Cette clé booléenne permet de stocker les variables internes par défaut,
- principalement l'état courant lors d'un processus itératif. Attention, cela
- peut être un choix numériquement coûteux dans certains cas de calculs. La
- valeur par défaut est "False".
-
- Exemple : ``{"StoreInternalVariables":True}``
-
StoreSupplementaryCalculations
Cette liste indique les noms des variables supplémentaires qui peuvent être
disponibles à la fin de l'algorithme. Cela implique potentiellement des
calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
aucune de ces variables n'étant calculée et stockée par défaut. Les noms
possibles sont dans la liste suivante : ["APosterioriCovariance", "BMA",
- "OMA", "OMB", "Innovation", "SigmaObs2", "MahalanobisConsistency"].
+ "CostFunctionJ", "CurrentState", "OMA", "OMB", "Innovation", "SigmaObs2",
+ "MahalanobisConsistency", "SimulatedObservationAtCurrentState",
+ "SimulatedObservationAtOptimum"].
Exemple : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
Les commandes requises générales, disponibles dans l'interface en édition, sont
les suivantes:
- Observers
+ Observers
*Commande obligatoire*. Elle permet de définir des observateurs internes,
qui sont des fonctions liées à une variable particulière, qui sont exécutées
chaque fois que cette variable est modifiée. C'est une manière pratique de
.. index:: single: QualityCriterion
.. index:: single: BoxBounds
.. index:: single: SetSeed
-.. index:: single: StoreInternalVariables
.. index:: single: StoreSupplementaryCalculations
Les commandes requises générales, disponibles dans l'interface en édition, sont
Exemple : ``{"SetSeed":1000}``
- StoreInternalVariables
- Cette clé booléenne permet de stocker les variables internes par défaut,
- principalement l'état courant lors d'un processus itératif. Attention, cela
- peut être un choix numériquement coûteux dans certains cas de calculs. La
- valeur par défaut est "False".
-
- Exemple : ``{"StoreInternalVariables":True}``
-
StoreSupplementaryCalculations
Cette liste indique les noms des variables supplémentaires qui peuvent être
disponibles à la fin de l'algorithme. Cela implique potentiellement des
calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
aucune de ces variables n'étant calculée et stockée par défaut. Les noms
- possibles sont dans la liste suivante : ["BMA", "OMA", "OMB", "Innovation"].
+ possibles sont dans la liste suivante : ["BMA", "CostFunctionJ",
+ "CurrentState", "OMA", "OMB", "Innovation",
+ "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
+ "SimulatedObservationAtOptimum"].
Exemple : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
.. index:: single: Minimizer
.. index:: single: MaximumNumberOfSteps
.. index:: single: CostDecrementTolerance
-.. index:: single: StoreInternalVariables
.. index:: single: StoreSupplementaryCalculations
Les commandes requises générales, disponibles dans l'interface en édition, sont
Exemple : ``{"CostDecrementTolerance":1.e-7}``
- StoreInternalVariables
- Cette clé booléenne permet de stocker les variables internes par défaut,
- principalement l'état courant lors d'un processus itératif. Attention, cela
- peut être un choix numériquement coûteux dans certains cas de calculs. La
- valeur par défaut est "False".
-
- Exemple : ``{"StoreInternalVariables":True}``
-
StoreSupplementaryCalculations
Cette liste indique les noms des variables supplémentaires qui peuvent être
disponibles à la fin de l'algorithme. Cela implique potentiellement des
calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
aucune de ces variables n'étant calculée et stockée par défaut. Les noms
- possibles sont dans la liste suivante : ["BMA", "OMA", "OMB", "Innovation"].
+ possibles sont dans la liste suivante : ["BMA", "CostFunctionJ",
+ "CurrentState", "OMA", "OMB", "Innovation",
+ "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
+ "SimulatedObservationAtOptimum"].
Exemple : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
augmentés. Les critères possibles sont dans la liste suivante, dans laquelle
les noms équivalents sont indiqués par un signe "=" :
["AugmentedWeightedLeastSquares"="AWLS"="DA", "WeightedLeastSquares"="WLS",
- "LeastSquares"="LS"="L2", "AbsoluteValue"="L1", "MaximumError"="ME"].
+ "LeastSquares"="LS"="L2", "AbsoluteValue"="L1", "MaximumError"="ME"].
Exemple : ``{"QualityCriterion":"DA"}``
.. index:: single: Beta
.. index:: single: Kappa
.. index:: single: Reconditioner
-.. index:: single: StoreInternalVariables
.. index:: single: StoreSupplementaryCalculations
Les commandes requises générales, disponibles dans l'interface en édition, sont
Exemple : ``{"Alpha":1,"Beta":2,"Kappa":0,"Reconditioner":1}``
- StoreInternalVariables
- Cette clé booléenne permet de stocker les variables internes par défaut,
- principalement l'état courant lors d'un processus itératif. Attention, cela
- peut être un choix numériquement coûteux dans certains cas de calculs. La
- valeur par défaut est "False".
-
- Exemple : ``{"StoreInternalVariables":True}``
-
StoreSupplementaryCalculations
Cette liste indique les noms des variables supplémentaires qui peuvent être
disponibles à la fin de l'algorithme. Cela implique potentiellement des
calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
aucune de ces variables n'étant calculée et stockée par défaut. Les noms
possibles sont dans la liste suivante : ["APosterioriCovariance", "BMA",
- "Innovation"].
+ "CostFunctionJ", "CurrentState", "Innovation"].
Exemple : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
Dans le champs de saisie, il faut utiliser des guillemets simples pour une
définition standard de dictionnaire, comme par exemple::
- '{"StoreInternalVariables":True,"MaximumNumberOfSteps":25}'
+ '{"MaximumNumberOfSteps":25,"SetSeed":1000}'
C'est la manière recommandée pour définir des paramètres algorithmiques.
"*AlgorithmParameters*", à la manière de l'exemple qui suit::
AlgorithmParameters = {
- "StoreInternalVariables" : True,
"MaximumNumberOfSteps" : 25,
"StoreSupplementaryCalculations" : ["APosterioriCovariance","OMA"],
}
Conditionnalité des informations disponibles en sortie
++++++++++++++++++++++++++++++++++++++++++++++++++++++
-.. index:: single: StoreInternalVariables
.. index:: single: AlgorithmParameters
.. index:: single: Stored
et/ou que si elles ont été réclamées avant l'exécution du calcul.
On rappelle que l'utilisateur peut réclamer des informations supplémentaires
-lors de l'établissement de son cas ADAO, en utilisant l'option
-"*StoreInternalVariables*" de chaque algorithme à travers la commande
-optionnelle "*AlgorithmParameters*" du cas ADAO. On se reportera à la
+lors de l'établissement de son cas ADAO, en utilisant la commande optionnelle
+"*AlgorithmParameters*" du cas ADAO. On se reportera à la
:ref:`section_ref_options_AlgorithmParameters` pour le bon usage de cette
commande, et à la description de chaque algorithme pour les informations
disponibles par algorithme. On peut aussi demander à conserver certaines
default = [],
typecast = tuple,
message = "Liste de calculs supplémentaires à stocker et/ou effectuer",
- listval = ["APosterioriCovariance", "BMA", "OMA", "OMB", "Innovation", "SigmaObs2", "MahalanobisConsistency", "SimulationQuantiles", "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"]
+ listval = ["APosterioriCovariance", "BMA", "OMA", "OMB", "CurrentState", "CostFunctionJ", "Innovation", "SigmaObs2", "MahalanobisConsistency", "SimulationQuantiles", "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"]
)
self.defineRequiredParameter(
name = "Quantiles",
Jb = 0.5 * (_X - Xb).T * BI * (_X - Xb)
Jo = 0.5 * (Y - _HX).T * RI * (Y - _HX)
J = float( Jb ) + float( Jo )
- if self._parameters["StoreInternalVariables"]:
+ if self._parameters["StoreInternalVariables"] or "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
self.StoredVariables["CurrentState"].store( _X )
if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
self.StoredVariables["SimulatedObservationAtCurrentState"].store( _HX )
#
# Correction pour pallier a un bug de TNC sur le retour du Minimum
# ----------------------------------------------------------------
- if self._parameters["StoreInternalVariables"]:
+ if self._parameters["StoreInternalVariables"] or "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
Minimum = self.StoredVariables["CurrentState"][IndexMin]
#
# Obtention de l'analyse
default = [],
typecast = tuple,
message = "Liste de calculs supplémentaires à stocker et/ou effectuer",
- listval = ["APosterioriCovariance", "BMA", "OMA", "OMB", "Innovation", "SigmaBck2", "SigmaObs2", "MahalanobisConsistency", "SimulationQuantiles", "SimulatedObservationAtBackground", "SimulatedObservationAtOptimum"]
+ listval = ["APosterioriCovariance", "BMA", "OMA", "OMB", "CostFunctionJ", "Innovation", "SigmaBck2", "SigmaObs2", "MahalanobisConsistency", "SimulationQuantiles", "SimulatedObservationAtBackground", "SimulatedObservationAtOptimum"]
)
self.defineRequiredParameter(
name = "Quantiles",
# Calcul de la fonction coût
# --------------------------
if self._parameters["StoreInternalVariables"] or \
+ "CostFunctionJ" in self._parameters["StoreSupplementaryCalculations"] or \
"OMA" in self._parameters["StoreSupplementaryCalculations"] or \
"SigmaObs2" in self._parameters["StoreSupplementaryCalculations"] or \
"MahalanobisConsistency" in self._parameters["StoreSupplementaryCalculations"] or \
HXa = Hm * Xa
oma = Y - HXa
if self._parameters["StoreInternalVariables"] or \
- "MahalanobisConsistency" in self._parameters["StoreSupplementaryCalculations"]:
+ "CostFunctionJ" in self._parameters["StoreSupplementaryCalculations"] or \
+ "MahalanobisConsistency" in self._parameters["StoreSupplementaryCalculations"]:
Jb = 0.5 * (Xa - Xb).T * BI * (Xa - Xb)
Jo = 0.5 * oma.T * RI * oma
J = float( Jb ) + float( Jo )
default = [],
typecast = tuple,
message = "Liste de calculs supplémentaires à stocker et/ou effectuer",
- listval = ["APosterioriCovariance", "BMA", "OMA", "OMB", "Innovation", "SigmaBck2", "SigmaObs2", "MahalanobisConsistency", "SimulationQuantiles", "SimulatedObservationAtBackground", "SimulatedObservationAtOptimum"]
+ listval = ["APosterioriCovariance", "BMA", "OMA", "OMB", "CostFunctionJ", "Innovation", "SigmaBck2", "SigmaObs2", "MahalanobisConsistency", "SimulationQuantiles", "SimulatedObservationAtBackground", "SimulatedObservationAtOptimum"]
)
self.defineRequiredParameter(
name = "Quantiles",
# Calcul de la fonction coût
# --------------------------
if self._parameters["StoreInternalVariables"] or \
+ "CostFunctionJ" in self._parameters["StoreSupplementaryCalculations"] or \
"OMA" in self._parameters["StoreSupplementaryCalculations"] or \
"SigmaObs2" in self._parameters["StoreSupplementaryCalculations"] or \
"MahalanobisConsistency" in self._parameters["StoreSupplementaryCalculations"] or \
HXa = numpy.matrix(numpy.ravel( H( Xa ) )).T
oma = Y - HXa
if self._parameters["StoreInternalVariables"] or \
- "MahalanobisConsistency" in self._parameters["StoreSupplementaryCalculations"]:
+ "CostFunctionJ" in self._parameters["StoreSupplementaryCalculations"] or \
+ "MahalanobisConsistency" in self._parameters["StoreSupplementaryCalculations"]:
Jb = 0.5 * (Xa - Xb).T * BI * (Xa - Xb)
Jo = 0.5 * oma.T * RI * oma
J = float( Jb ) + float( Jo )
default = [],
typecast = tuple,
message = "Liste de calculs supplémentaires à stocker et/ou effectuer",
- listval = ["APosterioriCovariance", "BMA", "Innovation"]
+ listval = ["APosterioriCovariance", "BMA", "CurrentState", "CostFunctionJ", "Innovation"]
)
def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
Jb = 0.5 * (Xn - Xb).T * BI * (Xn - Xb)
Jo = 0.5 * d.T * RI * d
J = float( Jb ) + float( Jo )
- self.StoredVariables["CurrentState"].store( Xn )
+ if self._parameters["StoreInternalVariables"] or "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
+ self.StoredVariables["CurrentState"].store( Xn )
self.StoredVariables["CostFunctionJb"].store( Jb )
self.StoredVariables["CostFunctionJo"].store( Jo )
self.StoredVariables["CostFunctionJ" ].store( J )
default = [],
typecast = tuple,
message = "Liste de calculs supplémentaires à stocker et/ou effectuer",
- listval = ["APosterioriCovariance", "BMA", "Innovation"]
+ listval = ["APosterioriCovariance", "BMA", "CurrentState", "CostFunctionJ", "Innovation"]
)
def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
else:
Cm = None
#
- # Nombre de pas du Kalman identique au nombre de pas d'observations
- # -----------------------------------------------------------------
+ # Nombre de pas identique au nombre de pas d'observations
+ # -------------------------------------------------------
if hasattr(Y,"stepnumber"):
duration = Y.stepnumber()
else:
Jb = 0.5 * (Xn - Xb).T * BI * (Xn - Xb)
Jo = 0.5 * d.T * RI * d
J = float( Jb ) + float( Jo )
- self.StoredVariables["CurrentState"].store( Xn )
+ if self._parameters["StoreInternalVariables"] or "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
+ self.StoredVariables["CurrentState"].store( Xn )
self.StoredVariables["CostFunctionJb"].store( Jb )
self.StoredVariables["CostFunctionJo"].store( Jo )
self.StoredVariables["CostFunctionJ" ].store( J )
default = [],
typecast = tuple,
message = "Liste de calculs supplémentaires à stocker et/ou effectuer",
- listval = ["OMA", "SimulatedObservationAtOptimum"]
+ listval = ["OMA", "CostFunctionJ", "SimulatedObservationAtOptimum"]
)
def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
# Calcul de la fonction coût
# --------------------------
if self._parameters["StoreInternalVariables"] or \
+ "CostFunctionJ" in self._parameters["StoreSupplementaryCalculations"] or \
"OMA" in self._parameters["StoreSupplementaryCalculations"] or \
"SimulatedObservationAtOptimum" in self._parameters["StoreSupplementaryCalculations"]:
HXa = Hm * Xa
oma = Y - HXa
- if self._parameters["StoreInternalVariables"]:
+ if self._parameters["StoreInternalVariables"] or \
+ "CostFunctionJ" in self._parameters["StoreSupplementaryCalculations"]:
Jb = 0.
Jo = 0.5 * oma.T * RI * oma
J = float( Jb ) + float( Jo )
default = [],
typecast = tuple,
message = "Liste de calculs supplémentaires à stocker et/ou effectuer",
- listval = ["BMA", "OMA", "OMB", "Innovation", "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"]
+ listval = ["BMA", "OMA", "OMB", "CurrentState", "CostFunctionJ", "Innovation", "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"]
)
def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
Jb = 0.
Jo = 0.5 * (Y - _HX).T * RI * (Y - _HX)
J = float( Jb ) + float( Jo )
- if self._parameters["StoreInternalVariables"]:
+ if self._parameters["StoreInternalVariables"] or "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
self.StoredVariables["CurrentState"].store( _X )
if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
self.StoredVariables["SimulatedObservationAtCurrentState"].store( _HX )
Jb = 0.
Jo = 0.5 * (Y - _HX).T * RI * (Y - _HX)
J = float( Jb ) + float( Jo )
- if self._parameters["StoreInternalVariables"]:
+ if self._parameters["StoreInternalVariables"] or "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
self.StoredVariables["CurrentState"].store( _X )
self.StoredVariables["CostFunctionJb"].store( Jb )
self.StoredVariables["CostFunctionJo"].store( Jo )
#
# Correction pour pallier a un bug de TNC sur le retour du Minimum
# ----------------------------------------------------------------
- if self._parameters["StoreInternalVariables"]:
+ if self._parameters["StoreInternalVariables"] or "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
Minimum = self.StoredVariables["CurrentState"][IndexMin]
#
# Obtention de l'analyse
default = [],
typecast = tuple,
message = "Liste de calculs supplémentaires à stocker et/ou effectuer",
- listval = ["BMA", "OMA", "OMB", "Innovation", "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"]
+ listval = ["BMA", "OMA", "OMB", "CurrentState", "CostFunctionJ", "Innovation", "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"]
)
def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
#
J = float( Jb ) + float( Jo )
#
- if self._parameters["StoreInternalVariables"]:
- self.StoredVariables["CurrentState"].store( _X )
- self.StoredVariables["CostFunctionJb"].store( Jb )
- self.StoredVariables["CostFunctionJo"].store( Jo )
- self.StoredVariables["CostFunctionJ" ].store( J )
- if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
- self.StoredVariables["SimulatedObservationAtCurrentState"].store( _HX )
return J
#
# Point de démarrage de l'optimisation : Xini = Xb
qBest = copy.copy( quality )
logging.debug("%s Initialisation, Insecte = %s, Qualité = %s"%(self._name, str(Best), str(qBest)))
#
- if self._parameters["StoreInternalVariables"]:
+ if self._parameters["StoreInternalVariables"] or "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
self.StoredVariables["CurrentState"].store( Best )
self.StoredVariables["CostFunctionJb"].store( 0. )
self.StoredVariables["CostFunctionJo"].store( 0. )
qBest = copy.copy( quality )
logging.debug("%s Etape %i, Insecte = %s, Qualité = %s"%(self._name, n, str(Best), str(qBest)))
#
- if self._parameters["StoreInternalVariables"]:
+ if self._parameters["StoreInternalVariables"] or "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
self.StoredVariables["CurrentState"].store( Best )
+ if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
+ _HmX = Hm( numpy.asmatrix(numpy.ravel( Best )).T )
+ _HmX = numpy.asmatrix(numpy.ravel( _HmX )).T
+ self.StoredVariables["SimulatedObservationAtCurrentState"].store( _HmX )
self.StoredVariables["CostFunctionJb"].store( 0. )
self.StoredVariables["CostFunctionJo"].store( 0. )
self.StoredVariables["CostFunctionJ" ].store( qBest )
if "Innovation" in self._parameters["StoreSupplementaryCalculations"]:
self.StoredVariables["Innovation"].store( numpy.ravel(d) )
if "BMA" in self._parameters["StoreSupplementaryCalculations"]:
- self.StoredVariables["BMA"].store( numpy.ravel(Xb - Xa) )
+ self.StoredVariables["BMA"].store( numpy.ravel(Xb) - numpy.ravel(Xa) )
if "OMA" in self._parameters["StoreSupplementaryCalculations"]:
- self.StoredVariables["OMA"].store( numpy.ravel(Y - HXa) )
+ self.StoredVariables["OMA"].store( numpy.ravel(Y) - numpy.ravel(HXa) )
if "OMB" in self._parameters["StoreSupplementaryCalculations"]:
self.StoredVariables["OMB"].store( numpy.ravel(d) )
if "SimulatedObservationAtBackground" in self._parameters["StoreSupplementaryCalculations"]:
default = [],
typecast = tuple,
message = "Liste de calculs supplémentaires à stocker et/ou effectuer",
- listval = ["BMA", "OMA", "OMB", "Innovation", "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"]
+ listval = ["BMA", "OMA", "OMB", "CurrentState", "CostFunctionJ", "Innovation", "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"]
)
def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
Jb = 0.
Jo = 0.
J = Jb + Jo
- if self._parameters["StoreInternalVariables"]:
+ if self._parameters["StoreInternalVariables"] or "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
self.StoredVariables["CurrentState"].store( _X )
if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
self.StoredVariables["SimulatedObservationAtCurrentState"].store( _HX )
default = [],
typecast = tuple,
message = "Liste de calculs supplémentaires à stocker et/ou effectuer",
- listval = ["APosterioriCovariance", "BMA", "Innovation"]
+ listval = ["APosterioriCovariance", "BMA", "CurrentState", "CostFunctionJ", "Innovation"]
)
def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
else:
Cm = None
#
- # Nombre de pas du Kalman identique au nombre de pas d'observations
- # -----------------------------------------------------------------
+ # Nombre de pas identique au nombre de pas d'observations
+ # -------------------------------------------------------
if hasattr(Y,"stepnumber"):
duration = Y.stepnumber()
else:
Jb = 0.5 * (Xn - Xb).T * BI * (Xn - Xb)
Jo = 0.5 * d.T * RI * d
J = float( Jb ) + float( Jo )
- self.StoredVariables["CurrentState"].store( Xn )
+ if self._parameters["StoreInternalVariables"] or "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
+ self.StoredVariables["CurrentState"].store( Xn )
self.StoredVariables["CostFunctionJb"].store( Jb )
self.StoredVariables["CostFunctionJo"].store( Jo )
self.StoredVariables["CostFunctionJ" ].store( J )
