2 Copyright (C) 2008-2015 EDF R&D
4 This file is part of SALOME ADAO module.
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.
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.
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
20 See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
24 .. index:: single: AlgorithmParameters
25 .. index:: single: Parameters
26 .. index:: single: Defaults
27 .. _section_ref_options_Algorithm_Parameters:
29 Description des options d'un algorithme dans "*AlgorithmParameters*"
30 --------------------------------------------------------------------
32 Chaque algorithme peut être contrôlé en utilisant des options ou des paramètres
33 particuliers. Ils sont donnés à travers la commande optionnelle "*Parameters*"
34 incluse dans la commande obligatoire "*AlgorithmParameters*".
36 Il y a 3 méthodes pratiques pour l'utilisateur pour fournir ces options. La
37 méthode est déterminée de la manière suivante dans l'interface graphique
40 #. premièrement à l'aide du mot-clé "*Parameters*" dans la commande "*AlgorithmParameters*", qui permet de choisir entre "*Defaults*" (utilisation de mots-clés explicites pré-remplis par les valeurs par défaut des paramètres) et "*Dict*" (utilisation d'un dictionnaire pour renseigner les mots-clés nécessaires),
41 #. puis deuxièmement, uniquement dans le cas "*Dict*" de "*Parameters*", par le mot-clé "*FROM*" inclus qui permet de choisir entre une entrée par chaîne de caractères ou une entrée par fichier de script Python.
43 Si une option ou un paramètre est spécifié par l'utilisateur pour un algorithme
44 qui ne la supporte pas, cette option est simplement laissée inutilisée et ne
45 bloque pas le traitement. La signification des acronymes ou des noms
46 particuliers peut être trouvée dans l':ref:`genindex` ou dans le
47 :ref:`section_glossary`.
49 Première méthode : utiliser les mots-clés explicites pré-remplis
50 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
52 Pour donner les valeurs des paramètres par les mots-clés explicites pré-remplis,
53 directement dans l'interface graphique, l'utilisateur sélectionne le type
54 "*Defaults*" dans le mot-clé "*Parameters*", puis les mots-clés dans la liste
55 prévue "*Parameters[Algo]*" qui apparaît, associée à l'algorithme choisi, comme
56 montré dans la figure qui suit :
58 .. adao_algopar_defaults:
59 .. image:: images/adao_algopar_defaults.png
63 **Utiliser les mots-clés explicites pré-remplis pour les paramètres algorithmiques**
65 Chaque paramètre est optionnel, et il présente sa valeur par défaut lorsqu'il
66 est sélectionné par l'utilisateur. On peut alors modifier sa valeur, ou la
67 renseigner dans le cas de listes par exemple.
69 C'est la manière recommandée pour modifier uniquement une partie des paramètres
70 algorithmiques de manière sûre. Cette méthode ne permet de définir que les
71 paramètres autorisés pour un algorithme donné, et les valeurs définies ne sont
72 pas conservées si l'utilisateur change d'algorithme.
74 Seconde méthode : utiliser une chaîne de caractères dans l'interface graphique
75 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
77 Pour donner les valeurs des paramètres par une chaîne de caractères, directement
78 dans l'interface graphique, l'utilisateur sélectionne le type "*Dict*" dans le
79 mot-clé "*Parameters*", puis le type "*String*" dans le mot-clé "*FROM*" de la
80 commande "*Dict*" qui apparaît, comme montré dans la figure qui suit :
82 .. adao_algopar_string:
83 .. image:: images/adao_algopar_string.png
87 **Utiliser une chaîne de caractères pour les paramètres algorithmiques**
89 Dans le champs de saisie, il faut utiliser des guillemets simples pour une
90 définition standard de dictionnaire, comme par exemple::
92 '{"MaximumNumberOfSteps":25,"SetSeed":1000}'
94 C'est la manière recommandée pour définir des paramètres algorithmiques. Cette
95 méthode permet en particulier de conserver des options ou des paramètres pour
96 d'autres algorithmes que celui que l'on utilise au moment présent. Cela facilite
97 le changement d'algorithme ou la conservation de valeurs par défaut différentes
98 des défauts standards.
100 Troisième méthode : utiliser un fichier de script Python externe
101 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
103 Pour donner les valeurs des paramètres par un fichier de script Python externe,
104 l'utilisateur sélectionne dans l'interface graphique le type "*Dict*" dans le
105 mot-clé "*Parameters*", puis le type "*Script*" dans le mot-clé "*FROM*" de la
106 commande "*Dict*" qui apparaît, comme montré dans la figure qui suit :
108 .. :adao_algopar_script
109 .. image:: images/adao_algopar_script.png
113 **Utiliser un fichier externe pour les paramètres algorithmiques**
115 Ce fichier script Python externe doit définir alors une variable au nom imposé
116 "*AlgorithmParameters*", à la manière de l'exemple qui suit::
118 AlgorithmParameters = {
119 "MaximumNumberOfSteps" : 25,
120 "StoreSupplementaryCalculations" : ["APosterioriCovariance","OMA"],
123 Le fichier peut aussi contenir d'autres commandes Python. Cette méthode permet
124 aussi, comme la précédente, de conserver des options ou des paramètres pour
125 d'autres algorithmes que celui que l'on utilise.
