Rename "adapting" to "calibrating" in MovingFilter functions.

SofaPirate · Jan 5, 2025 · e5fadff · e5fadff
1 parent a4daceb
commit e5fadff
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 19 deletions.
diff --git a/docs/MinMaxScaler.rst b/docs/MinMaxScaler.rst
@@ -59,7 +59,7 @@ automatically adapt to incoming sensor values.
 
 .. doxygenclass:: MinMaxScaler
    :project: Plaquette
-   :members: MinMaxScaler, get, put, timeWindow, infiniteTimeWindow, timeWindowIsInfinite, reset, adapting, noAdapting, isAdapting
+   :members: MinMaxScaler, get, put, timeWindow, infiniteTimeWindow, timeWindowIsInfinite, reset, resumeCalibrating, pauseCalibrating, isCalibrating
 
 |SeeAlso|
 ---------

diff --git a/docs/Normalizer.rst b/docs/Normalizer.rst
@@ -45,7 +45,7 @@ Uses a normalizer to analyze input sensor values and detect extreme values.
 
 .. doxygenclass:: Normalizer
    :project: Plaquette
-   :members: Normalizer, get, put, timeWindow, infiniteTimeWindow, timeWindowIsInfinite, reset, adapting, noAdapting, isAdapting, targetMean, targetStdDev, isHighOutlier, isLowOutlier, isOutlier, highOutlierThreshold, lowOutlierThreshold, clamp, noClamp, isClamped
+   :members: Normalizer, get, put, timeWindow, infiniteTimeWindow, timeWindowIsInfinite, reset, resumeCalibrating, pauseCalibrating, isCalibrating, targetMean, targetStdDev, isHighOutlier, isLowOutlier, isOutlier, highOutlierThreshold, lowOutlierThreshold, clamp, noClamp, isClamped
 
 |SeeAlso|
 ---------

diff --git a/src/MinMaxScaler.cpp b/src/MinMaxScaler.cpp
@@ -67,7 +67,7 @@ void MinMaxScaler::reset() {
 
 float MinMaxScaler::put(float value)
 {
-  if (isAdapting()) {
+  if (isCalibrating()) {
 
     // Update min. value.
     if (value < _minValue) {

diff --git a/src/MovingFilter.cpp b/src/MovingFilter.cpp
@@ -23,7 +23,7 @@ namespace pq {
 
 MovingFilter::MovingFilter()
   : AnalogSource(),
-    _isAdapting(true),
+    _isCalibrating(true),
     _nValuesStep(0)
 {
 }
@@ -43,16 +43,16 @@ void MovingFilter::reset() {
   _nValuesStep = 0;
 }
 
-void MovingFilter::adapting() {
-  _isAdapting = true;
+void MovingFilter::resumeCalibrating() {
+  _isCalibrating = true;
 }
 
-void MovingFilter::noAdapting() {
-  _isAdapting = false;
+void MovingFilter::pauseCalibrating() {
+  _isCalibrating = false;
 }
 
-bool MovingFilter::isAdapting() const {
-  return _isAdapting;
+bool MovingFilter::isCalibrating() const {
+  return _isCalibrating;
 }
 
 }
diff --git a/src/MovingFilter.h b/src/MovingFilter.h
@@ -56,24 +56,24 @@ class MovingFilter : public AnalogSource {
   virtual void reset();
 
   /**
-   * Switches to adapting mode (default). Calls to put(value) will return filtered 
+   * Switches to calibration mode (default). Calls to put(value) will return filtered 
    * value AND update the normalization statistics.
    */
-  virtual void adapting();
+  virtual void resumeCalibrating();
 
   /**
-   * Switches to non-adapting mode: calls to put(value) will return filtered value 
+   * Switches to non-calibration mode: calls to put(value) will return filtered value 
    * without updating the normalization statistics.
    */
-  virtual void noAdapting();
+  virtual void pauseCalibrating();
 
-  /// Returns true iff the moving filter is in adapting mode.
-  virtual bool isAdapting() const;
+  /// Returns true iff the moving filter is in calibration mode.
+  virtual bool isCalibrating() const;
 
 protected:
   // Start/stop calibration flag.
-  bool    _isAdapting  : 1;
-  uint8_t _nValuesStep : 7;
+  bool    _isCalibrating : 1;
+  uint8_t _nValuesStep   : 7;
 };
 
 }

diff --git a/src/Normalizer.cpp b/src/Normalizer.cpp
@@ -96,7 +96,7 @@ float Normalizer::put(float value) {
     _nValuesStep++;
 
   // First time put() is called this step.
-  if (isAdapting()) {
+  if (isCalibrating()) {
 
     if (_nValuesStep == 1) {
       // Update moving average.