microcalorimetry.math.rmemeas_extras

This module contains functions intended to operate directly on RMEMeas objects, instead of operating on the underlying datasets though propagation.

Functions

categorize_by(→ rmellipse.RMEMeas)

Group linear uncertainty mechanisms into categories.

Module Contents

microcalorimetry.math.rmemeas_extras.categorize_by(meas: rmellipse.RMEMeas, category: str, combine_uncategorized: bool = True, uncategorized_name: str = 'uncategorized', deg: bool = False, rad: bool = False, verbose: bool = False, apply_origin_filter: dict = DEFAULT_ORIGIN_FILTER) → rmellipse.RMEMeas[source]

Group linear uncertainty mechanisms into categories.

Mechanisms sharing a common category will be combined quadratically into a single mechanism. For example, if the ‘Type’ category is selected, all the mechanisms with the ‘Type’ = ‘A’ designation in the covcats attribute will be quadratically combined.

This function does NOT preserve the DOF’s or the category information of the uncertainty mechanisms after categorization, and is recommended to be used for debugging and presentation purposes only. It is NOT recommended for categorized RMEMeas objects to be saved.

Parameters:

  • meas (RMEMeas) – Measurement to group uncertainty mechanisms.

  • category (str) – String identifying the category of uncertainty mechanism.

  • combine_uncategorized (bool,) – If True, mechanisms that do not contain ‘category’ will all be combined into a single mechanism called uncategorized_name.

  • uncategorized_name (str,) – String to call all uncategorized mechanisms IF they are being combined. The default is ‘uncategorized’.

  • deg (bool,) – If true, calculates minimum angle differences for uncertainties as degrees.

  • rad (bool,) – If true, calculates minimum angle differences for uncertainties as radians.

  • verbose (bool, optional) – Print information about grouping. The default is False.

  • apply_origin_filter (bool, optional) – If True, regroup origins by applying a filter that renames origins according to pattern matching.

Returns:

out – Measurement.

Return type:

RMEMeas