pyyeti.cla.DR_Results.form_extreme

DR_Results.form_extreme(ext_name='Envelope', case_order=None, doappend=2)

Form extreme response over sets of results

Parameters:

• ext_name (string; optional) – Name to use for extreme results (stored in, for example, self['extreme']['SC_atm'].event)

• case_order (list or None; optional) – List of cases (or events) in desired order. Can be subset of cases available. If None, the order is determined by the order in which results were inserted (DR_Results is a collections.OrderedDict). Note that case_order is used for highest level only. case_order defines the ‘cases’ member variable (for example, self['extreme']['SC_atm'].cases).

• doappend (integer; optional) – Flag that defines how to build the extreme .maxcase and .mincase values. Both the lower level .maxcase and .mincase values and the dictionary key (which is typically the event name) can be used/combined. See the notes section below for an example of the different options. The options are:

  doappend	Description
  0	Ignore all lower level .maxcase & .mincase and just use higher level key.
  1	Keep all lower level .maxcase & .mincase and prepend higher level keys as levels are traversed.
  2	Ignore lowest level .maxcase & .mincase, but prepend higher level keys after that.
  3	Keep only lowest level .maxcase & .mincase (do not append any keys).

Notes

This routine will create ‘extreme’ dictionaries at all appropriate levels. Any old ‘extreme’ dictionaries (at all levels) are deleted before anything else is done.

The extreme values from the events (eg, self['Liftoff']['SC_atm'].ext) are collected into the max/min attributes in the new ‘extreme’ category (eg, into self['extreme']['SC_atm'].mx and <...>.mn). The .cases attribute lists the events in the order they are assembled.

To demonstrate the different doappend options, here is an example DR_Results structure showing the extreme .maxcase values for each setting. This DR_Results structure has two-levels: ‘Gust’ at the highest level and ‘Yaw’ at the lower level. The ‘extreme’ entries are added by this routine. The first .maxcase setting shown in this example could be shorthand for, for example, self['Gust']['Yaw']['SC_atm'].maxcase[0].

'Gust'   :
    'Yaw'    : .maxcase = 'Frq 3'
    'extreme': .maxcase = 'Yaw'        if doappend = 0
               .maxcase = 'Yaw,Frq 3'  if doappend = 1
               .maxcase = 'Yaw'        if doappend = 2
               .maxcase = 'Frq 3'      if doappend = 3
'extreme': .maxcase = 'Gust'             if doappend = 0
           .maxcase = 'Gust,Yaw,Frq 3'   if doappend = 1
           .maxcase = 'Gust,Yaw'         if doappend = 2
           .maxcase = 'Frq 3'            if doappend = 3