List of crack objects. More...

Inheritance diagram for fosanalysis.crackmonitoring.cracks.CrackList:

Public Member Functions
	__init__ (self, *crack_list)
	Constructs a CrackList.

	clear_attribute (self, str attribute, bool make_copy=True)
	Sets the attribute to `None` for each Crack object contained.

list	get_attribute_list (self, str attribute)
	Extract a list of values from the given attribute of all cracks.

	get_cracks_attribute_by_range (self, str attribute="location", float minimum=-np.inf, float maximum=np.inf, bool make_copy=True)
	Get a list of Crack objects according to the given attribute.

	get_cracks_attribute_is_none (self, str attribute, bool make_copy=True)
	Get a list of Crack whose `attribute` is None.

	get_cracks_by_location (self, *tuple locations, float tol=None, str method="nearest", bool make_copy=True, bool placeholder=False)

list	locations (self)
	Returns a list with the locations of all cracks.

list	max_strains (self)
	Returns a list with the peak strains of all cracks.

	sort (self, str attribute="location")
	Sort the list of Crack according to the given attribute.

list	widths (self)
	Returns a list with the widths of all cracks.

list	x_l (self)
	Returns a list with the left-hand side border of transfer length of all cracks.

list	x_r (self)
	Returns a list with the right-hand side border of transfer length of all cracks.

Detailed Description

List of crack objects.

Definition at line 101 of file cracks.py.

Constructor & Destructor Documentation

◆ init()

fosanalysis.crackmonitoring.cracks.CrackList.__init__	(		self,
		*	crack_list )

Constructs a CrackList.

Parameters

crack_list

Data, from which the CrackList is constructed. Possible arguments :

any number of Crack objects,
Crack objects wrapped in a list, tuple or set,
CrackList object (same as above)

Definition at line 105 of file cracks.py.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ clear_attribute()

fosanalysis.crackmonitoring.cracks.CrackList.clear_attribute	(		self,
		str	attribute,
		bool	make_copy = True )

Sets the attribute to None for each Crack object contained.

Definition at line 249 of file cracks.py.

◆ get_attribute_list()

list fosanalysis.crackmonitoring.cracks.CrackList.get_attribute_list	(		self,
		str	attribute )

Extract a list of values from the given attribute of all cracks.

Parameters

attribute Name of the attribute to extract. If the attribute of the crack object is not set, None is reported instead.

Definition at line 139 of file cracks.py.

Here is the caller graph for this function:

◆ get_cracks_attribute_by_range()

fosanalysis.crackmonitoring.cracks.CrackList.get_cracks_attribute_by_range	(		self,
		str	attribute = "location",
		float	minimum = -np.inf,
		float	maximum = np.inf,
		bool	make_copy = True )

Get a list of Crack objects according to the given attribute.

Parameters

attribute	Name of the relevant attribute.
minimum	Threshold for the minimum accepted value of the attribute.
maximum	Threshold for the maximum accepted value of the attribute.
make_copy	if true, a deepcopy of the CrackList is returned.

Returns: Returns a CrackList. If no crack satisfies the condition, an empty CrackList is returned.

Definition at line 203 of file cracks.py.

◆ get_cracks_attribute_is_none()

fosanalysis.crackmonitoring.cracks.CrackList.get_cracks_attribute_is_none	(		self,
		str	attribute,
		bool	make_copy = True )

Get a list of Crack whose attribute is None.

Parameters

attribute	Name of the relevant attribute.
make_copy	If true, a deepcopy of the CrackList is returned.

Returns: Returns a CrackList. If no crack satisfies the condition, an empty CrackList is returned.

Definition at line 229 of file cracks.py.

Here is the call graph for this function:

◆ get_cracks_by_location()

fosanalysis.crackmonitoring.cracks.CrackList.get_cracks_by_location	(		self,
		*tuple	locations,
		float	tol = None,
		str	method = "nearest",
		bool	make_copy = True,
		bool	placeholder = False )

    Get a list of \ref Crack according to the given list of positions `locations` and the `method`.
    \param locations Locations along the sensor to get cracks at.
    \param tol Tolerance in location difference, to take a Crack into account.
        Only used with `method = "nearest"`.
        Defaults to `None`, which is turned off.
    \param method Method how the cracks are selected.
        Available methods:
        - `"nearest"` (default): adds the crack to the CrackList,

for which the distance between the location of the crack and the entry in locations is the smallest among all cracks.

"lt": returns the first crack, for which holds: \(x_{\mathrm{t,l}} < x \leq x_{\mathrm{t,r}}\).

Parameters

make_copy	If set to `True`, independent copies are returned. Defaults to `False`.
placeholder	Switch to report `None`, when no suitable Crack is found. Defaults to `False`, which is no replacement.

Returns: Returns a CrackList.

Definition at line 146 of file cracks.py.

Here is the call graph for this function:

◆ locations()

list fosanalysis.crackmonitoring.cracks.CrackList.locations ( self )

Returns a list with the locations of all cracks.

Definition at line 128 of file cracks.py.

Here is the call graph for this function:

◆ max_strains()

list fosanalysis.crackmonitoring.cracks.CrackList.max_strains ( self )

Returns a list with the peak strains of all cracks.

Definition at line 132 of file cracks.py.

Here is the call graph for this function:

◆ sort()

fosanalysis.crackmonitoring.cracks.CrackList.sort	(		self,
		str	attribute = "location" )

Sort the list of Crack according to the given attribute.

Parameters

attribute Name of the relevant attribute.

Definition at line 265 of file cracks.py.

Here is the call graph for this function:

◆ widths()

list fosanalysis.crackmonitoring.cracks.CrackList.widths ( self )

Returns a list with the widths of all cracks.

Definition at line 136 of file cracks.py.

Here is the call graph for this function:

◆ x_l()

list fosanalysis.crackmonitoring.cracks.CrackList.x_l ( self )

Returns a list with the left-hand side border of transfer length of all cracks.

Definition at line 120 of file cracks.py.

Here is the call graph for this function:

◆ x_r()

list fosanalysis.crackmonitoring.cracks.CrackList.x_r ( self )

Returns a list with the right-hand side border of transfer length of all cracks.

Definition at line 124 of file cracks.py.

Here is the call graph for this function:

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

src/fosanalysis/crackmonitoring/cracks.py

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ clear_attribute()

◆ get_attribute_list()

◆ get_cracks_attribute_by_range()

◆ get_cracks_attribute_is_none()

◆ get_cracks_by_location()

◆ locations()

◆ max_strains()

◆ sort()

◆ widths()

◆ x_l()

◆ x_r()

◆ init()