fosanalysis.preprocessing.Preprocessing Class Reference

Container for several preprocessing task, that are carried out in sequential order. More...

Inheritance diagram for fosanalysis.preprocessing.Preprocessing:

Public Member Functions
	__init__ (self, list tasklist, *args, **kwargs)
	Constructs a Preprocessing object.
np.array	run (self, np.array x, np.array y, np.array z, bool make_copy=True, *args, **kwargs)
	The data is passed sequentially through all preprocessing task objects in tasklist, in that specific order.
Public Member Functions inherited from fosanalysis.preprocessing.base.Base
	__init__ (self, *args, **kwargs)
	Construct an instance of the class.
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.
Public Member Functions inherited from fosanalysis.utils.base.Workflow
	__init__ (self, *args, **kwargs)

Public Attributes
	tasklist = tasklist
	List of preprocessing.base.Base sub-class objects.

Detailed Description

Container for several preprocessing task, that are carried out in sequential order.

Definition at line 26 of file __init__.py.

Constructor & Destructor Documentation

__init__()

fosanalysis.preprocessing.Preprocessing.__init__	(		self,
		list	tasklist,
		*	args,
		**	kwargs )

Constructs a Preprocessing object.

Parameters

tasklist	List of preprocessing.base.Base sub-class objects. For more, see tasklist.
*args	Additional positional arguments, will be passed to the superconstructor.
**kwargs	Additional keyword arguments, will be passed to the superconstructor.

Definition at line 30 of file __init__.py.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

run()

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

The data is passed sequentially through all preprocessing task objects in tasklist, in that specific order.

The output of a previous preprocessing task is used as the input to the next one.

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. Will be passed to the run() method of all taks objects in tasklist.
**kwargs	Additional keyword arguments to customize the behaviour. Will be passed to the run() method of all task objects in tasklist.

Reimplemented from fosanalysis.preprocessing.base.Base.

Definition at line 44 of file __init__.py.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

tasklist

fosanalysis.preprocessing.Preprocessing.tasklist = tasklist

List of preprocessing.base.Base sub-class objects.

The tasks are executed sequentially, the output of a previous preprocessing is used as the input to the next one.

Definition at line 43 of file __init__.py.

---

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

• src/fosanalysis/preprocessing/__init__.py