From b8e434d81ba23e7aa349b60862135a22fa9e7487 Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Wed, 28 Dec 2022 11:03:03 +0100 Subject: [PATCH] Minor documentation and code review corrections (37) --- doc/en/ref_algorithm_KalmanFilter.rst | 4 ++++ doc/en/scripts/simple_Blue.py | 8 ++++---- doc/en/scripts/simple_ExtendedBlue.py | 8 ++++---- doc/en/scripts/simple_KalmanFilter1.rst | 3 +++ doc/en/scripts/simple_KalmanFilter2.rst | 3 +++ doc/fr/ref_algorithm_KalmanFilter.rst | 2 ++ doc/fr/scripts/simple_KalmanFilter1.rst | 3 +++ doc/fr/scripts/simple_KalmanFilter2.rst | 3 +++ src/daComposant/daCore/PlatformInfo.py | 2 ++ 9 files changed, 28 insertions(+), 8 deletions(-) diff --git a/doc/en/ref_algorithm_KalmanFilter.rst b/doc/en/ref_algorithm_KalmanFilter.rst index 57ce9e7..1bf41fe 100644 --- a/doc/en/ref_algorithm_KalmanFilter.rst +++ b/doc/en/ref_algorithm_KalmanFilter.rst @@ -198,6 +198,7 @@ StoreSupplementaryCalculations .. _section_ref_algorithm_KalmanFilter_examples: .. include:: snippets/Header2Algo09.rst +.. --------- .. .. include:: scripts/simple_KalmanFilter1.rst .. literalinclude:: scripts/simple_KalmanFilter1.py @@ -205,6 +206,7 @@ StoreSupplementaryCalculations .. include:: snippets/Header2Algo10.rst .. literalinclude:: scripts/simple_KalmanFilter1.res + :language: none .. include:: snippets/Header2Algo11.rst @@ -218,6 +220,7 @@ StoreSupplementaryCalculations :align: center :width: 90% +.. --------- .. .. include:: scripts/simple_KalmanFilter2.rst .. literalinclude:: scripts/simple_KalmanFilter2.py @@ -225,6 +228,7 @@ StoreSupplementaryCalculations .. include:: snippets/Header2Algo10.rst .. literalinclude:: scripts/simple_KalmanFilter2.res + :language: none .. include:: snippets/Header2Algo11.rst diff --git a/doc/en/scripts/simple_Blue.py b/doc/en/scripts/simple_Blue.py index c5ed14a..1c9edeb 100644 --- a/doc/en/scripts/simple_Blue.py +++ b/doc/en/scripts/simple_Blue.py @@ -5,11 +5,11 @@ from adao import adaoBuilder case = adaoBuilder.New() case.setBackground( Vector = array([0., 1., 2.]), Stored=True ) case.setBackgroundError( ScalarSparseMatrix = 1. ) -case.setObservation( Vector=array([10., 11., 12.]), Stored=True ) +case.setObservation( Vector = array([10., 11., 12.]), Stored=True ) case.setObservationError( ScalarSparseMatrix = 1. ) -case.setObservationOperator( Matrix=array([[1., 0., 0.], - [0., 1., 0.], - [0., 0., 1.]]), ) +case.setObservationOperator( Matrix = array([[1., 0., 0.], + [0., 1., 0.], + [0., 0., 1.]]), ) case.setAlgorithmParameters( Algorithm='Blue', Parameters={ diff --git a/doc/en/scripts/simple_ExtendedBlue.py b/doc/en/scripts/simple_ExtendedBlue.py index 4a7ff5f..0ca4338 100644 --- a/doc/en/scripts/simple_ExtendedBlue.py +++ b/doc/en/scripts/simple_ExtendedBlue.py @@ -5,11 +5,11 @@ from adao import adaoBuilder case = adaoBuilder.New() case.setBackground( Vector = array([0., 1., 2.]), Stored=True ) case.setBackgroundError( ScalarSparseMatrix = 1. ) -case.setObservation( Vector=array([10., 11., 12.]), Stored=True ) +case.setObservation( Vector = array([10., 11., 12.]), Stored=True ) case.setObservationError( ScalarSparseMatrix = 1. ) -case.setObservationOperator( Matrix=array([[1., 0., 0.], - [0., 1., 0.], - [0., 0., 1.]]), ) +case.setObservationOperator( Matrix = array([[1., 0., 0.], + [0., 1., 0.], + [0., 0., 1.]]), ) case.setAlgorithmParameters( Algorithm='ExtendedBlue', Parameters={ diff --git a/doc/en/scripts/simple_KalmanFilter1.rst b/doc/en/scripts/simple_KalmanFilter1.rst index f6423e7..7a8c870 100644 --- a/doc/en/scripts/simple_KalmanFilter1.rst +++ b/doc/en/scripts/simple_KalmanFilter1.rst @@ -1,5 +1,8 @@ .. index:: single: KalmanFilter (example) +First example +............. + The Kalman Filter can be used for a **reanalysis of observations of a given dynamical model**. It is because the whole set of the observation full history is already known at the beginning of the time windows that it is called diff --git a/doc/en/scripts/simple_KalmanFilter2.rst b/doc/en/scripts/simple_KalmanFilter2.rst index f516425..7c43714 100644 --- a/doc/en/scripts/simple_KalmanFilter2.rst +++ b/doc/en/scripts/simple_KalmanFilter2.rst @@ -1,3 +1,6 @@ +Second example +.............. + The Kalman filter can also be used for a **running analysis of the observations of a given dynamic model**. In this case, the analysis is conducted iteratively, at the arrival of each observation. diff --git a/doc/fr/ref_algorithm_KalmanFilter.rst b/doc/fr/ref_algorithm_KalmanFilter.rst index 345069d..71a0989 100644 --- a/doc/fr/ref_algorithm_KalmanFilter.rst +++ b/doc/fr/ref_algorithm_KalmanFilter.rst @@ -199,6 +199,7 @@ StoreSupplementaryCalculations .. _section_ref_algorithm_KalmanFilter_examples: .. include:: snippets/Header2Algo09.rst +.. --------- .. .. include:: scripts/simple_KalmanFilter1.rst .. literalinclude:: scripts/simple_KalmanFilter1.py @@ -220,6 +221,7 @@ StoreSupplementaryCalculations :align: center :width: 90% +.. --------- .. .. include:: scripts/simple_KalmanFilter2.rst .. literalinclude:: scripts/simple_KalmanFilter2.py diff --git a/doc/fr/scripts/simple_KalmanFilter1.rst b/doc/fr/scripts/simple_KalmanFilter1.rst index 95a52c5..59b4546 100644 --- a/doc/fr/scripts/simple_KalmanFilter1.rst +++ b/doc/fr/scripts/simple_KalmanFilter1.rst @@ -1,5 +1,8 @@ .. index:: single: KalmanFilter (exemple) +Premier exemple +............... + Le filtre de Kalman peut être utilisé pour une **réanalyse des observations d'un modèle dynamique donné**. C'est parce que l'ensemble de l'historique complet de l'observation est déjà connu au début des fenêtres temporelles qu'on diff --git a/doc/fr/scripts/simple_KalmanFilter2.rst b/doc/fr/scripts/simple_KalmanFilter2.rst index 3c62ec9..a0b85ca 100644 --- a/doc/fr/scripts/simple_KalmanFilter2.rst +++ b/doc/fr/scripts/simple_KalmanFilter2.rst @@ -1,3 +1,6 @@ +Deuxième exemple +................ + Le filtre de Kalman peut aussi être utilisé pour une **analyse courante des observations d'un modèle dynamique donné**. Dans ce cas, l'analyse est conduite de manière itérative, lors de l'arrivée de chaque observation. diff --git a/src/daComposant/daCore/PlatformInfo.py b/src/daComposant/daCore/PlatformInfo.py index 8a4105e..f37c23e 100644 --- a/src/daComposant/daCore/PlatformInfo.py +++ b/src/daComposant/daCore/PlatformInfo.py @@ -292,6 +292,8 @@ def isIterable( __sequence, __check = False, __header = "" ): __isOk = True elif "_iterator" in type(__sequence).__name__: __isOk = True + elif "itertools" in str(type(__sequence)): + __isOk = True else: __isOk = False if __check and not __isOk: -- 2.39.2