pyyeti.cla.extrema¶
- pyyeti.cla.extrema(curext, mm, maxcase, mincase=None, casenum=None)[source]¶
Update extrema values in ‘curext’
- Parameters:
curext (SimpleNamespace) –
Has extrema information (members may be None on first call):
.ext = 1 or 2 columns: [max, min] .ext_x = None or 1 or 2 columns: [x_of_max, x_of_min] .maxcase = list of strings identifying maximum case .mincase = list of strings identifying minimum case
Also has these members if casenum is an integer:
.mx = [case1_max, case2_max, ...] .mn = [case1_min, case2_min, ...] .mx_x = [case1_x_of_max, case2_x_of_max, ...] .mn_x = [case1_x_of_min, case2_x_of_min, ...]
The mx_x and mn_x will have
np.nanvalues if ext_x is None.mm (SimpleNamespace) –
Has min/max information for a case (or over cases):
.ext = 1 or 2 columns: [max, min] .ext_x = None or 1 or 2 columns: [x_of_max, x_of_min]
maxcase (string or list of strings) – String or list of strings identifying the load case(s) for the maximum values. This is analogous to curext.maxcase but pertaining to mm (handy if mm is from another extrema data set).
mincase (string or list of strings or None; optional) – Analogous to maxcase for the minimum values or None. If None, it is a copy of the maxcase values.
casenum (integer or None; optional) – If integer, it is case number (starting at 0); curext will have the .mx, .mn, .mx_x, .mn_x members and the casenum column of each of these will be set to the data from mm. Zeros will be used for “x” if mm is 1 or 2 columns. If None, .mx, .mn, .mx_x, .mn_x are not updated (and need not be present).
- Returns:
None
Notes
This routine updates the curext variable. This routine is typically called indirectly via
DR_Results.time_data_recovery(),DR_Results.frf_data_recovery(), andDR_Results.psd_data_recovery().