Base for compensation classes. More...

Inheritance diagram for fosanalysis.compensation.compensator.Compensator:

Public Member Functions
	__init__ (self, args, *kwargs)
	Base class for any compensatory class.

np.array	run (self, np.array x, np.array strain, args, *kwargs)
	This.

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

Base for compensation classes.

Definition at line 15 of file compensator.py.

Constructor & Destructor Documentation

fosanalysis.compensation.compensator.Compensator.__init__	(		self,
		*	args,
		**	kwargs )

Base class for any compensatory class.

Parameters

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

Definition at line 19 of file compensator.py.

Here is the call graph for this function:

Here is the caller graph for this function:

np.array fosanalysis.compensation.compensator.Compensator.run	(		self,
		np.array	x,
		np.array	strain,
		*	args,
		**	kwargs )

This.

Parameters

x	Positional data.
strain	Strain data, belonging to `x`.
*args	Additional positional arguments to costumize the behavior. Further specified in sub-classes.
**kwargs	Additional keyword arguments to costumize the behavior. Further specified in sub-classes.

Returns: Returns an array of the same shape as x (or strain for that matter) with the influence. These values are subtracted from the strains in the crack widths estimation (positive values will reduce the estimated crack width).

Definition at line 27 of file compensator.py.

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