core_utils

navis.core.core_utils.FailedRun

Class representing a failed run.

Source code in navis/core/core_utils.py

class FailedRun:
    """Class representing a failed run."""
    def __init__(self, func, args, kwargs, exception='NA'):
        self.args = args
        self.func = func
        self.kwargs = kwargs
        self.exception = exception

    def __repr__(self):
        return self.__str__()

    def __str__(self):
        return (f'Failed run(function={self.func}, args={self.args}, '
                f'kwargs={self.kwargs}, exception={self.exception})')

navis.core.core_utils.add_units

Add neuron units (if present) to output of function.

Source code in navis/core/core_utils.py

def add_units(compact=True, power=1):
    """Add neuron units (if present) to output of function."""
    def outer(func):
        @functools.wraps(func)
        def wrapper(*args, **kwargs):
            self = args[0]
            res = func(*args, **kwargs)

            if config.add_units and self.has_units and not self.units.dimensionless:
                res = res * np.power(self.units, power)
                if compact:
                    res = res.to_compact()

            return res

        return wrapper

    return outer

navis.core.core_utils.temp_property

Check if neuron is stale. Clear cached temporary attributes if it is.

Source code in navis/core/core_utils.py

def temp_property(func):
    """Check if neuron is stale. Clear cached temporary attributes if it is."""
    @functools.wraps(func)
    def wrapper(*args, **kwargs):
        self = args[0]
        # Do nothing if neurons is locked
        if not self.is_locked:
            if self.is_stale:
                self._clear_temp_attr()
        return func(*args, **kwargs)
    return wrapper