Module pyaurorax.tools.bounding_box

Methods for working with data in a specific bounding box.

Sub-modules

pyaurorax.tools.bounding_box.extract_metric

Extract various metrics from a given bounding box.

Classes

class BoundingBoxManager (aurorax_obj)

Expand source code

class BoundingBoxManager:
    """
    The BoundingBoxManager object is initialized within every PyAuroraX object. It acts as a way to access 
    the submodules and carry over configuration information in the super class.
    """

    def __init__(self, aurorax_obj):
        # initialize super class object
        self.__aurorax_obj = aurorax_obj

        # initialize sub-modules
        self.__extract_metric = ExtractMetricManager(self.__aurorax_obj)

    # ------------------------------------------
    # properties for submodule managers
    # ------------------------------------------
    @property
    def extract_metric(self):
        """
        Access to the `extract_metric` submodule from within a PyAuroraX object.
        """
        return self.__extract_metric

The BoundingBoxManager object is initialized within every PyAuroraX object. It acts as a way to access the submodules and carry over configuration information in the super class.

Instance variables

prop extract_metric

Expand source code

@property
def extract_metric(self):
    """
    Access to the `extract_metric` submodule from within a PyAuroraX object.
    """
    return self.__extract_metric

Access to the pyaurorax.tools.bounding_box.extract_metric submodule from within a PyAuroraX object.