14.4. Algorithme de vérification « InputValuesTest »

Avertissement

Dans la présente version, cet algorithme ou certaines de ses variantes sont expérimentaux, et restent donc susceptibles de changements dans les prochaines versions.

Description

Cet algorithme permet de vérifier le contenu des variables d’entrée courantes et la manière dont les données sont interprétées ou lues lors de leur acquisition, à travers l’affichage des informations de taille et des statistique sur les entrées. Il permet aussi de restituer la totalité du contenu des variables lues sous forme imprimée pour vérification (attention, si une variable est de grande taille, cette restitution peut être informatiquement problématique).

Commandes requises et optionnelles

Les commandes générales requises, disponibles en édition dans l’interface graphique ou textuelle, sont les suivantes :

Background
Vecteur. La variable désigne le vecteur d’ébauche ou d’initialisation, usuellement noté \mathbf{x}^b. Sa valeur est définie comme un objet de type « Vector » ou « VectorSerie ». Sa disponibilité en sortie est conditionnée par le booléen « Stored » associé en entrée.
CheckingPoint
Vecteur. La variable désigne le vecteur utilisé comme l’état autour duquel réaliser le test requis, noté \mathbf{x}, similaire à l’ébauche \mathbf{x}^b. Sa valeur est définie comme un objet de type « Vector » ou « VectorSerie ». Sa disponibilité en sortie est conditionnée par le booléen « Stored » associé en entrée.
Observation
Liste de vecteurs. La variable désigne le vecteur d’observation utilisé en assimilation de données ou en optimisation, et usuellement noté \mathbf{y}^o. Sa valeur est définie comme un objet de type « Vector » si c’est une unique observation (temporelle ou pas) ou « VectorSerie » si c’est une succession d’observations. Sa disponibilité en sortie est conditionnée par le booléen « Stored » associé en entrée.

Astuce pour cet algorithme :

Comme la commande « ObservationOperator », dans l’interface graphique, est requise pour TOUS les algorithmes de vérification, il faut fournir une valeur, malgré le fait que cette commandes ne soit pas nécessaires pour cet test (et sa valeur n’est donc pas utilisée). La manière la plus simple est de donner « 1 » comme un STRING, pour un « ObservationOperator » devant être de type Matrix creuse.

Les commandes optionnelles générales, disponibles en édition dans l’interface graphique ou textuelle, sont indiquées dans la Liste des commandes et mots-clés pour un cas de vérification. De plus, les paramètres de la commande « AlgorithmParameters » permettent d’indiquer les options particulières, décrites ci-après, de l’algorithme. On se reportera à la Description des options d’un algorithme par « AlgorithmParameters » pour le bon usage de cette commande.

Les options sont les suivantes :

NumberOfPrintedDigits

Valeur entière. Cette clé indique le nombre de décimales de précision pour les affichages de valeurs réelles. La valeur par défaut est 5, avec un minimum de 0.

Exemple : {"NumberOfPrintedDigits":5}

PrintAllValuesFor

Liste de noms prédéfinis. Cette clé indique la liste des noms de vecteurs dont les valeurs détaillées sont à imprimer, la valeur par défaut étant la liste vide. Si le vecteur nommé n’est pas une entrée fournie, le nom est simplement ignoré. Les noms possibles sont dans la liste suivante : [ « Background », « CheckingPoint », « Observation », ].

Exemple : {"PrintAllValuesFor":["Background"]}

ShowInformationOnlyFor

Liste de noms prédéfinis. Cette clé indique la liste des noms de vecteurs dont les informations synthétiques (taille, min/max…) sont à imprimer, la valeur par défaut étant l’ensemble des vecteurs. Si le vecteur nommé n’est pas une entrée fournie, le nom est simplement ignoré. Cela permet de restreindre les impressions synthétiques. Les noms possibles sont dans la liste suivante : [ « Background », « CheckingPoint », « Observation », ].

Exemple : {"ShowInformationOnlyFor":["Background"]}

SetDebug

Valeur booléenne. La variable conduit à l’activation, ou pas, du mode de débogage durant l’évaluation de la fonction ou de l’opérateur. La valeur par défaut est « True », les choix sont « True » ou « False ».

Exemple : {"SetDebug":False}