tapsap.utils package
Submodules
tapsap.utils.filter_xl module
- tapsap.utils.filter_xl.filter_xl(variable) bool
A function for filtering a value that is coming in from an excel file. For example, if the input is a float, but read as a string, then the result in a class should be float.
- Args:
variable (str): A variable to test the type of value.
- Returns:
result (any): The result of the string filter from xlsx.
tapsap.utils.find_integration_time module
- tapsap.utils.find_integration_time.find_integration_time(flux: ndarray, times: ndarray, min_value: float = 0) list
Find the integration time based on the support (non-negative values assuming a distribution of the molecules).
- Args:
flux (float ndarray): The outlet flux.
times (float ndarray): An array of time.
min_value (float): The minimal value allowed for the flux.
- Returns:
integration_time_range (list): A list contianing the start and end time to integrate the flux. If None, then set to the min and max time.
- Citation:
Kunz et al, “A Priori Calibration of Transient Kinetics Data via Machine Learning” (In prep)
- Implementor:
Ross Kunz
- Link:
tapsap.utils.gamma_pdf module
- tapsap.utils.gamma_pdf.gamma_pdf(times: ndarray, shape: float, scale: float) ndarray
Generates the gamma distribution Probability Density Function (PDF) based on the given times, shape and scale (note that the rate is equal to 1/scale).
- Args:
times (float ndarray): An array of time.
shape (float): The shape parameter of the gamma distribution.
scale (float): The scale parameter of the gamma distribution.
- Returns:
pdf (float ndarray): The PDF of the generated gamma distribution.
- Citation:
Casella & Berger, Statistical Inference.
- Implementor:
Ross Kunz
- Link:
tapsap.utils.isfloat module
- tapsap.utils.isfloat.isfloat(variable) bool
A function for determining if a value float.
- Args:
variable: A variable to test if it is a float.
- Returns:
isfloat (bool): A true false statement if the value is a float.
tapsap.utils.isint module
- tapsap.utils.isint.isint(variable) bool
A function for determining if a value int.
- Args:
variable: A variable to test if it is a int.
- Returns:
isint (bool): A true false statement if the value is a int.
tapsap.utils.isjson module
- tapsap.utils.isjson.isjson(variable) bool
A function for determining if a value is a json object.
- Args:
variable: A variable to test if it is a json object.
- Returns:
isjson (bool): A true false statement if the value is a json object.
tapsap.utils.islist module
- tapsap.utils.islist.islist(variable) bool
A function for determining if a value includes brackets ‘[‘.
- Args:
variable: A variable to test if it is a list.
- Returns:
islist (bool): A true false statement if the value is a list.
tapsap.utils.mad module
- tapsap.utils.mad.mad(x: ndarray) bool
The median absolute deviation MAD of a ndarray.
- Args:
x (ndarray): A numpy array.
- Returns:
mad (float): the median absolute deviation of x.
tapsap.utils.rmse module
- tapsap.utils.rmse.rmse(x: ndarray, y: ndarray) float
A function for the root mean square error between two arrays.
- Args:
x (ndarray): An array of values.
y (ndarray): An array of values.
- Returns:
rmse_error (float): The root mean square error between x and y.
tapsap.utils.trapz module
- tapsap.utils.trapz.trapz(flux: ndarray, times: ndarray) float
Trapazoidal integration or integration by sum. Times can either be a vector of time with the same length as the flux or it can be the difference in time for each measurement point.
- Args:
flux (float ndarray): The outlet flux.
times (float ndarray): An array of time.
- Returns:
integral (float): The integral of the flux
- Citation:
None
- Implementor:
Ross Kunz
- Link: