doc/fr/ref_options_AlgorithmParameters.rst

   1 ..
   2    Copyright (C) 2008-2021 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: AlgorithmParameters
  25 .. index:: single: Parameters
  26 .. index:: single: Defaults
  27 .. index:: single: setAlgorithmParameters
  28 .. _section_ref_options_Algorithm_Parameters:
  29
  30 Description des options d'un algorithme par "*AlgorithmParameters*"
  31 -------------------------------------------------------------------
  32
  33 Chaque algorithme peut être contrôlé en utilisant des options ou des paramètres
  34 particuliers. Ils sont donnés à travers la commande optionnelle "*Parameters*"
  35 incluse dans la commande obligatoire "*AlgorithmParameters*".
  36
  37 Il y a 3 méthodes pratiques pour l'utilisateur de l'interface graphique EFICAS
  38 d'ADAO (GUI) pour fournir ces options. La méthode est déterminée de la manière
  39 suivante dans l'interface graphique EFICAS d'ADAO :
  40
  41 #. premièrement à l'aide du mot-clé "*Parameters*" dans la commande
  42    "*AlgorithmParameters*", qui permet de choisir entre "*Defaults*"
  43    (utilisation de mots-clés explicites pré-remplis par les valeurs par défaut
  44    des paramètres) et "*Dict*" (utilisation d'un dictionnaire pour renseigner
  45    les mots-clés nécessaires),
  46 #. puis deuxièmement ou troisièmement, uniquement dans le cas "*Dict*" de
  47    "*Parameters*", par le mot-clé "*FROM*" inclus qui permet de choisir entre
  48    une entrée par chaîne de caractères ou une entrée par fichier de script
  49    Python.
  50
  51 Ces deux dernières options sont celles que l'on peut aussi utiliser dans
  52 l'interface textuelle d'ADAO (TUI), par les mot-clés "*Parameters*" et
  53 "*Script*" dans la commande correspondante "*AlgorithmParameters*" (voir la
  54 partie :ref:`section_tui` pour une description détaillée).
  55
  56 Si une option ou un paramètre est spécifié par l'utilisateur pour un algorithme
  57 qui ne la supporte pas, cette option est simplement ignorée (laissée
  58 inutilisée) et ne bloque pas le traitement. La signification des acronymes ou
  59 des noms particuliers peut être trouvée dans l'index ou dans le
  60 :ref:`section_glossary`.
  61
  62 Première méthode : utiliser les mots-clés explicites pré-remplis
  63 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  64
  65 Pour donner les valeurs des paramètres par les mots-clés explicites pré-remplis,
  66 directement dans l'interface graphique, l'utilisateur sélectionne le type
  67 "*Defaults*" dans le mot-clé "*Parameters*", puis les mots-clés dans la liste
  68 prévue "*Parameters[Algo]*" qui apparaît, associée à l'algorithme choisi, comme
  69 montré dans la figure qui suit :
  70
  71   .. adao_algopar_defaults:
  72   .. image:: images/adao_algopar_defaults.png
  73     :align: center
  74     :width: 100%
  75   .. centered::
  76     **Utiliser les mots-clés explicites pré-remplis pour les paramètres algorithmiques**
  77
  78 Chaque paramètre est optionnel, et il présente sa valeur par défaut lorsqu'il
  79 est sélectionné par l'utilisateur. On peut alors modifier sa valeur, ou la
  80 renseigner dans le cas de listes par exemple.
  81
  82 C'est la manière recommandée pour modifier uniquement une partie des paramètres
  83 algorithmiques de manière sûre. Cette méthode ne permet de définir que les
  84 paramètres autorisés pour un algorithme donné, et les valeurs définies ne sont
  85 pas conservées si l'utilisateur change d'algorithme.
  86
  87 Cette méthode n'est naturellement pas utilisable en interface TUI.
  88
  89 Seconde méthode : utiliser une chaîne de caractères dans l'interface graphique
  90 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  91
  92 Pour donner les valeurs des paramètres par une chaîne de caractères, directement
  93 dans l'interface graphique, l'utilisateur sélectionne le type "*Dict*" dans le
  94 mot-clé "*Parameters*", puis le type "*String*" dans le mot-clé "*FROM*" de la
  95 commande "*Dict*" qui apparaît, comme montré dans la figure qui suit :
  96
  97   .. adao_algopar_string:
  98   .. image:: images/adao_algopar_string.png
  99     :align: center
 100     :width: 100%
 101   .. centered::
 102     **Utiliser une chaîne de caractères pour les paramètres algorithmiques**
 103
 104 Dans le champs de saisie, il faut utiliser des guillemets simples pour une
 105 définition standard de dictionnaire, comme par exemple::
 106
 107     '{"MaximumNumberOfSteps":25,"SetSeed":1000}'
 108
 109 C'est la manière recommandée pour définir des paramètres algorithmiques. Cette
 110 méthode permet en particulier de conserver des options ou des paramètres pour
 111 d'autres algorithmes que celui que l'on utilise au moment présent. Cela
 112 facilite le changement d'algorithme ou la conservation de valeurs par défaut
 113 différentes des défauts standards.
 114
 115 Dans l'interface textuelle TUI, le dictionnaire peut être simplement donné
 116 comme argument du mot-clé "*Parameters*".
 117
 118 Troisième méthode : utiliser un fichier de script Python externe
 119 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 120
 121 Pour donner les valeurs des paramètres par un fichier de script Python externe,
 122 l'utilisateur sélectionne dans l'interface graphique le type "*Dict*" dans le
 123 mot-clé "*Parameters*", puis le type "*Script*" dans le mot-clé "*FROM*" de la
 124 commande "*Dict*" qui apparaît, comme montré dans la figure qui suit :
 125
 126   .. :adao_algopar_script
 127   .. image:: images/adao_algopar_script.png
 128     :align: center
 129     :width: 100%
 130   .. centered::
 131     **Utiliser un fichier externe pour les paramètres algorithmiques**
 132
 133 Ce fichier script Python externe doit définir alors une variable au nom imposé
 134 "*AlgorithmParameters*", à la manière de l'exemple qui suit::
 135
 136     AlgorithmParameters = {
 137         "MaximumNumberOfSteps" : 25,
 138         "StoreSupplementaryCalculations" : ["APosterioriCovariance","OMA"],
 139         }
 140
 141 Le fichier peut aussi contenir d'autres commandes Python. Cette méthode permet
 142 aussi, comme la précédente, de conserver des options ou des paramètres pour
 143 d'autres algorithmes que celui que l'on utilise.
 144
 145 Dans l'interface textuelle TUI, le fichier peut être donné comme argument du
 146 mot-clé "*Script*".