microcalorimetry.math.rmemeas_extras
====================================

.. py:module:: microcalorimetry.math.rmemeas_extras

.. autoapi-nested-parse::

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

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   microcalorimetry.math.rmemeas_extras.categorize_by


Module Contents
---------------

.. py:function:: 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

   
   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.

   :param meas: Measurement to group uncertainty mechanisms.
   :type meas: RMEMeas
   :param category: String identifying the category of uncertainty mechanism.
   :type category: str
   :param combine_uncategorized: If True, mechanisms that do not contain 'category' will all be
                                 combined into a single mechanism called uncategorized_name.
   :type combine_uncategorized: bool,
   :param uncategorized_name: String to call all uncategorized mechanisms IF they are being
                              combined. The default is 'uncategorized'.
   :type uncategorized_name: str,
   :param deg: If true, calculates minimum angle differences for uncertainties
               as degrees.
   :type deg: bool,
   :param rad: If true, calculates minimum angle differences for uncertainties
               as radians.
   :type rad: bool,
   :param verbose: Print information about grouping. The default is False.
   :type verbose: bool, optional
   :param apply_origin_filter: If True, regroup origins by applying a filter that renames
                               origins according to pattern matching.
   :type apply_origin_filter: bool, optional

   :returns: **out** -- Measurement.
   :rtype: RMEMeas















   ..
       !! processed by numpydoc !!