fosanalysis.preprocessing.resizing.Crop Class Reference

Object, for cropping data sets and saving the preset. More...

Inheritance diagram for fosanalysis.preprocessing.resizing.Crop:

Public Member Functions
	__init__ (self, float start_pos=None, float end_pos=None, float length=None, float offset=None, *args, **kwargs)
	Construct an instance of the class.
tuple	run (self, np.array x, np.array y, np.array z, float start_pos=None, float end_pos=None, float length=None, float offset=None, *args, **kwargs)
	This is a wrapper around cropping.cropping() which.
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 Attributes
	end_pos = end_pos
	The end position \(s\) specifies the length of the sensor, when leaving the measurement area.
	length = length
	Length of the data excerpt.
	offset = offset
	Before cropping, \(x\) data is shifted by the offset \(o\), such that \(x \gets x + o\), defaults to 0.
	start_pos = start_pos
	The starting position \(s\) specifies the length of the sensor, before entering the measurement area.

Detailed Description

Object, for cropping data sets and saving the preset.

Definition at line 151 of file resizing.py.

Constructor & Destructor Documentation

__init__()

fosanalysis.preprocessing.resizing.Crop.__init__	(		self,
		float	start_pos = None,
		float	end_pos = None,
		float	length = None,
		float	offset = None,
		*	args,
		**	kwargs )

Construct an instance of the class.

Parameters

start_pos

The starting position \(s\) specifies the length of the sensor, before entering the measurement area.

Defaults to None (no data is removed at the beginning).

Parameters

end_pos

The end position \(s\) specifies the length of the sensor, when leaving the measurement area.

If both length and end_pos are provided, end_pos takes precedence. Defaults to None (no data is removed at the end).

Parameters

length

Length of the data excerpt.

If set, it is used to determine the end_pos. If both length and end_pos are provided, end_pos takes precedence.

Parameters

offset

Before cropping, \(x\) data is shifted by the offset \(o\), such that \(x \gets x + o\), defaults to 0.

Parameters

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

Definition at line 155 of file resizing.py.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

run()

tuple fosanalysis.preprocessing.resizing.Crop.run	(		self,
		np.array	x,
		np.array	y,
		np.array	z,
		float	start_pos = None,
		float	end_pos = None,
		float	length = None,
		float	offset = None,
		*	args,
		**	kwargs )

This is a wrapper around cropping.cropping() which.

Parameters

x	Array of measuring point positions.
y	Array of time stamps.
z	Array of strain data in accordance to x and y.
start_pos	The starting position \(s\) specifies the length of the sensor, before entering the measurement area. Defaults to None (no data is removed at the beginning).
end_pos	The end position \(s\) specifies the length of the sensor, when leaving the measurement area. If both length and end_pos are provided, end_pos takes precedence. Defaults to None (no data is removed at the end).
length	Length of the data excerpt. If set, it is used to determine the end_pos. If both length and end_pos are provided, end_pos takes precedence.
offset	Before cropping, \(x\) data is shifted by the offset \(o\), such that \(x \gets x + o\), defaults to 0.
*args	Additional positional arguments, passed to cropping.cropping().
**kwargs	Additional keyword arguments, passed to cropping.cropping().

Reimplemented from fosanalysis.preprocessing.base.Base.

Definition at line 183 of file resizing.py.

Member Data Documentation

end_pos

fosanalysis.preprocessing.resizing.Crop.end_pos = end_pos

The end position \(s\) specifies the length of the sensor, when leaving the measurement area.

If both length and end_pos are provided, end_pos takes precedence. Defaults to None (no data is removed at the end).

Definition at line 177 of file resizing.py.

length

fosanalysis.preprocessing.resizing.Crop.length = length

Length of the data excerpt.

If set, it is used to determine the end_pos. If both length and end_pos are provided, end_pos takes precedence.

Definition at line 182 of file resizing.py.

offset

fosanalysis.preprocessing.resizing.Crop.offset = offset

Before cropping, \(x\) data is shifted by the offset \(o\), such that \(x \gets x + o\), defaults to 0.

Definition at line 179 of file resizing.py.

start_pos

fosanalysis.preprocessing.resizing.Crop.start_pos = start_pos

The starting position \(s\) specifies the length of the sensor, before entering the measurement area.

Defaults to None (no data is removed at the beginning).

Definition at line 173 of file resizing.py.

---

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

• src/fosanalysis/preprocessing/resizing.py