Module quantum_inferno.utilities.calculations
Methods for mathematical operations. (Can't be named "math" because it's a built-in module)
Functions
def append_fill(array_1d: numpy.ndarray, fill_value: float, fill_loc: str) ‑> numpy.ndarray-
Append fill value to the array based on the fill location
Refer to FILL_LOCATIONS for available options
:param array_1d: 1D array with data :param fill_value: fill value :param fill_loc: fill location :return: array with fill value appended
def derivative_with_difference_sample_rate_hz(sample_rate_hz: float, timeseries: numpy.ndarray, fill_type: str = 'zero', fill_loc: str = 'end') ‑> numpy.ndarray-
Derivative using numpy.diff with fill options to return the same length as the input
Refer to FILL_TYPES for available options
Refer to FILL_LOCATIONS for available options
:param sample_rate_hz: sample rate in Hz :param timeseries: sensor waveform :param fill_type: fill type. Default "zero" :param fill_loc: fill location. Default "end" :return: derivative waveform with the same length as the input
def derivative_with_difference_timestamps_s(timestamps_s: numpy.ndarray, timeseries: numpy.ndarray, fill_type: str = 'zero', fill_loc: str = 'end') ‑> numpy.ndarray-
Derivative using numpy.diff with fill options to return the same length as the input.
Refer to FILL_TYPES for available options
Refer to FILL_LOCATIONS for available options
:param timestamps_s: timestamps in seconds :param timeseries: sensor waveform :param fill_type: fill type. Default "zero" :param fill_loc: fill location. Default "end" :return: derivative waveform with the same length as the input
def derivative_with_gradient_sample_rate_hz(sample_rate_hz: float, timeseries: numpy.ndarray) ‑> numpy.ndarray-
Derivative using numpy.gradient
:param sample_rate_hz: sample rate in Hz :param timeseries: sensor waveform :return: derivative waveform
def derivative_with_gradient_timestamps_s(timestamps_s: numpy.ndarray, timeseries: numpy.ndarray) ‑> numpy.ndarray-
Derivative using numpy.gradient
:param timestamps_s: timestamps in seconds :param timeseries: sensor waveform :return: derivative waveform
def get_fill_from_filling_method(array_1d: numpy.ndarray, fill_type: str) ‑> float-
Returns the fill value based on the fill type
Refer to FILL_TYPES for available options
:param array_1d: 1D array with data to be filled :param fill_type: The fill type :return: The fill value
def get_num_points(sample_rate_hz: float, duration_s: float, rounding_type: str, output_unit: str) ‑> int-
Get number of points in a waveform based on the sample rate and duration and round based on the rounding method. For rounding type "round", if the decimal is halfway between two integers, it will round to the nearest even integer
:param sample_rate_hz: sample rate in Hz :param duration_s: duration in seconds :param rounding_type: rounding type :param output_unit: output unit (points, log2, or pow2) :return: number of points
def integrate_with_cumtrapz_sample_rate_hz(sample_rate_hz: float, timeseries: numpy.ndarray, initial_value: float = 0) ‑> numpy.ndarray-
Cumulative trapezoid integration using scipy.integrate.cumulative_trapezoid
:param sample_rate_hz: sample rate in Hz :param timeseries: sensor waveform :param initial_value: initial value of the integral :return: integrated waveform
def integrate_with_cumtrapz_timestamps_s(timestamps_s: numpy.ndarray, timeseries: numpy.ndarray, initial_value: float = 0) ‑> numpy.ndarray-
Cumulative trapezoid integration using scipy.integrate.cumulative_trapezoid
:param timestamps_s: timestamps in seconds :param timeseries: sensor waveform :param initial_value: initial value of the integral :return: integrated waveform
def round_value(value: float, rounding_type: str = 'round') ‑> int-
Round value based on the rounding method for positive or negative floats. For rounding type "round", if the decimal is halfway between two integers, it will round to the nearest even integer
Refer to ROUNDING_TYPES for available options
:param value: value to be rounded :param rounding_type: method of rounding. Default "round" :return: rounded value