Object to identify potential crack positions. More...

Inheritance diagram for fosanalysis.crackmonitoring.finding.CrackFinder:

Public Member Functions
	__init__ (self, args, *kwargs)
	Constructs a CrackFinder object.

cracks.CrackList	run (self, x, strain)
	Identifies the positions of cracks using `scipy.signal.find_peaks()` and returns a cracks.CrackList object.

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
	args = args
	Positional arguments, will be passed to `scipy.signal.find_peaks()`.

	kwargs = kwargs if kwargs else {"height": 100,"prominence": 100}
	Keyword arguments, will be passed to `scipy.signal.find_peaks()`.

Detailed Description

Object to identify potential crack positions.

Core functionality is based on scipy.signal.find_peaks().

Definition at line 14 of file finding.py.

Constructor & Destructor Documentation

◆ init()

fosanalysis.crackmonitoring.finding.CrackFinder.__init__	(		self,
		*	args,
		**	kwargs )

Constructs a CrackFinder object.

Parameters

args	Positional arguments, will be passed to `scipy.signal.find_peaks()`. For more, see args.
kwargs	Keyword arguments, will be passed to `scipy.signal.find_peaks()`. For more, see kwargs.

Definition at line 19 of file finding.py.

Member Function Documentation

◆ run()

cracks.CrackList fosanalysis.crackmonitoring.finding.CrackFinder.run	(	self,
		x,
		strain )

Identifies the positions of cracks using scipy.signal.find_peaks() and returns a cracks.CrackList object.

Those cracks.Crack objects are still incomplete. Their effective lengths may need to be recalculated using separation.CrackLengths.run() and the widths strainprofile.StrainProfile.calculate_crack_widths().

Parameters

x	Positional data.
strain	Strain data.

Returns: Returns a cracks.CrackList.

Definition at line 40 of file finding.py.

Member Data Documentation

◆ args

fosanalysis.crackmonitoring.finding.CrackFinder.args = args

Positional arguments, will be passed to scipy.signal.find_peaks().

By default empty.

Definition at line 30 of file finding.py.

◆ kwargs

fosanalysis.crackmonitoring.finding.CrackFinder.kwargs = kwargs if kwargs else {"height": 100,"prominence": 100}

Keyword arguments, will be passed to scipy.signal.find_peaks().

Defaults to the following settings:

key	value
height	100
prominence	100

The main parameter is prominence, see also Wikipedia: Prominence. If too many cracks are identified, increase prominence, if obvious cracks are missing, reduce prominence.

Definition at line 39 of file finding.py.

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

src/fosanalysis/crackmonitoring/finding.py

Public Member Functions

Public Attributes