fosanalysis.preprocessing.base.Base Class Reference

Abstract base class for preprocessing classes. More...

Inheritance diagram for fosanalysis.preprocessing.base.Base:

Public Member Functions
	__init__ (self, *args, **kwargs)
	Construct an instance of the class.
tuple	run (self, np.array x=None, np.array y=None, np.array z=None, bool make_copy=True, *args, **kwargs)
	Each preprocessing.Base object has a run() method to carry out the preprocessing task and return the preprocessed data.
Public Member Functions inherited from fosanalysis.utils.base.Task
	__init__ (self, *args, **kwargs)
Public Member Functions inherited from fosanalysis.utils.base.Base
	__init__ (self, *args, **kwargs)
	Construct the object and warn about unused/unknown arguments.

Detailed Description

Abstract base class for preprocessing classes.

Definition at line 16 of file base.py.

Constructor & Destructor Documentation

__init__()

fosanalysis.preprocessing.base.Base.__init__	(		self,
		*	args,
		**	kwargs )

Construct an instance of the class.

As this is an abstract class, it may not be instantiated directly itself.

Parameters

*args	Additional positional arguments, will be passed to the superconstructor.
**kwargs	Additional keyword arguments, will be passed to the superconstructor.

Definition at line 21 of file base.py.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

run()

tuple fosanalysis.preprocessing.base.Base.run	(		self,
		np.array	x = None,
		np.array	y = None,
		np.array	z = None,
		bool	make_copy = True,
		*	args,
		**	kwargs )

Each preprocessing.Base object has a run() method to carry out the preprocessing task and return the preprocessed data.

Parameters

x	Array of measuring point positions.
y	Array of time stamps.
z	Array of strain data in accordance to x and y.
make_copy	Switch, whether a deepcopy of the passed data should be done. Defaults to True.
*args	Additional positional arguments to customize the behaviour.
**kwargs	Additional keyword arguments to customize the behaviour.

Returns

Returns a tuple like (x, y, z). They correspond to the input variables of the same name. Each of those might be changed.

Reimplemented in fosanalysis.preprocessing.base.Task, fosanalysis.preprocessing.filtering.Limit, fosanalysis.preprocessing.filtering.SlidingFilter, fosanalysis.preprocessing.Preprocessing, fosanalysis.preprocessing.repair.NaNFilter, fosanalysis.preprocessing.repair.ScipyInterpolation1D, fosanalysis.preprocessing.resizing.Aggregate, fosanalysis.preprocessing.resizing.Crop, and fosanalysis.preprocessing.resizing.Downsampler.

Definition at line 31 of file base.py.

---

The documentation for this class was generated from the following file:

• src/fosanalysis/preprocessing/base.py