__init__.py

Go to the documentation of this file.

 
r"""
Contains modules for data preprocessing, like:
- filtering: dealing with noise, e.g. smoothing
- masking: identification of strain reading anomalies (SRAs),
- repair: dealing with `NaN`s,
- resizing: changing the shape of the data arrays.
 
\author Bertram Richter
\date 2023
"""
 
from abc import abstractmethod
import copy
 
import numpy as np
 
from fosanalysis import utils
 
from . import base
from . import filtering
from . import masking
from . import repair
from . import resizing
 
class Preprocessing(base.Base, utils.base.Workflow):
    r"""
    Container for several preprocessing task, that are carried out in sequential order.
    """
    def __init__(self,
            tasklist: list,
            *args, **kwargs):
        r"""
        Constructs a Preprocessing object.
        \param tasklist \copybrief tasklist For more, see \ref tasklist.
        \param *args Additional positional arguments, will be passed to the superconstructor.
        \param **kwargs Additional keyword arguments, will be passed to the superconstructor.
        """
        super().__init__(*args, **kwargs)
        
        self.tasklist = tasklist
    def run(self,
            x: np.array,
            y: np.array,
            z: np.array,
            make_copy: bool = True,
            *args, **kwargs) -> np.array:
        r"""
        The data is passed sequentially through all preprocessing task objects in \ref tasklist, in that specific order.
        The output of a previous preprocessing task is used as the input to the next one.
        \param x Array of measuring point positions.
        \param y Array of time stamps.
        \param z Array of strain data in accordance to `x` and `y`.
        \param make_copy Switch, whether a deepcopy of the passed data should be done.
            Defaults to `True`.
        \param *args Additional positional arguments, to customize the behaviour.
            Will be passed to the `run()` method of all taks objects in \ref tasklist.
        \param **kwargs Additional keyword arguments to customize the behaviour.
            Will be passed to the `run()` method of all task objects in \ref tasklist.
        """
        x, y, z = super().run(x, y, z, make_copy=make_copy, *args, **kwargs)
        for task in self.tasklist:
            x, y, z = task.run(x, y, z, make_copy=False, *args, **kwargs)
        return x, y, z