feat: exposed noise level estimation where it can be useful

paucablop · May 21, 2024 · 7f13f9b · 7f13f9b
1 parent f859bab
commit 7f13f9b
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/chemotools/smooth/__init__.py b/chemotools/smooth/__init__.py
@@ -7,15 +7,18 @@
 - :class:`SavitzkyGolayFilter`
 - :class:`WhittakerSmooth`
 
-as well as auxiliary models to allow for convenient usage of the them:
+as well as auxiliary models and functions to allow for convenient usage of the them:
 
 - :class:`WhittakerSmoothMethods` and :class:`WhittakerSmoothLambda` for the
     :class:`WhittakerSmooth` class.
+- :func:`estimate_noise_stddev` to estimate the local/global noise level of a spectrum
+    which can then be used for weighting the data.
 
 """
 
 ### Imports ###
 
+from chemotools.utils._finite_differences import estimate_noise_stddev  # noqa: F401
 from chemotools.utils._models import (   # noqa: F401
     WhittakerSmoothLambda,
     WhittakerSmoothMethods,

diff --git a/chemotools/utils/__init__.py b/chemotools/utils/__init__.py
@@ -0,0 +1,14 @@
+"""
+The utility module of ``chemotools`` that offers access to various utility functions
+that can come in handy when working with chemical data.
+
+The module contains the following functions:
+
+- :func:`estimate_noise_stddev` to estimate the local/global noise level of a spectrum
+    which can then be used for weighting the data.
+
+"""
+
+### Imports ###
+
+from chemotools.utils._finite_differences import estimate_noise_stddev  # noqa: F401