pyIntensityFeatures.utils.distributions

Functions providing data distribtuions.

Functions

calc_quadratic(x, c, b, a)	Calculate the quadratic value at a specified location.
gauss(x, amp, mu, sigma, const)	Provide results for a simple Gaussian function.
mult_gauss(x, amps, mus, sigmas, const)	Provide results for a double-peaked Gaussian function.
single_gauss_quad(x, c, b, a, amp, mu, sigma)	Provide results for a single Gaussian with a quadratic background.
mult_gauss_quad(x, *param)	Provide results for a multiple Gaussian with a quadratic background.

Module Contents

pyIntensityFeatures.utils.distributions.calc_quadratic(x, c, b, a)

Calculate the quadratic value at a specified location.

Parameters:

xfloat or array-like

Location(s) at which the quadratic background will be calculated

cfloat

Constant term in the quadratic equation

bfloat

Multipler for the x-term in the quadratic equation

afloat

Multiplier for the x-squared term in the quadratic equation

Returns:

yfloat or array-like

Amplitude value(s) at the input location(s)

pyIntensityFeatures.utils.distributions.gauss(x, amp, mu, sigma, const)

Provide results for a simple Gaussian function.

Parameters:

x(float or array-like)

Dependent variable

ampfloat

Amplitude

mufloat

Mean, or x-offset

sigmafloat

Sigma, or exponential scalar

constfloat

Additive constant

Returns:

y(float or array-like)

Normal value at x

pyIntensityFeatures.utils.distributions.mult_gauss(x, amps, mus, sigmas, const)

Provide results for a double-peaked Gaussian function.

Parameters:

xfloat or array-like

Dependent variable

ampsarray-like

Amplitudes

musarray-like

Means, or x-offsets

sigmasarray-like

Sigmas, or exponential scalars

constfloat

Additive constant

Returns:

y(float or array-like)

Normal value at x

Raises:

ValueError

If the number of input parameters is wrong

pyIntensityFeatures.utils.distributions.single_gauss_quad(x, c, b, a, amp, mu, sigma)

Provide results for a single Gaussian with a quadratic background.

Parameters:

x(float or array-like)

Dependent variable

cfloat

Constant term in the quadratic equation

bfloat

Multipler for the x-term in the quadratic equation

afloat

Multiplier for the x-squared term in the quadratic equation

ampfloat

Amplitude

mufloat

Mean, or x-offset

sigmafloat

Sigma, or exponential scalar

Returns:

y(float or array-like)

Normal value at x

pyIntensityFeatures.utils.distributions.mult_gauss_quad(x, *param)

Provide results for a multiple Gaussian with a quadratic background.

Parameters:

xfloat or array-like

Dependent variable

paramset

Set containing: constant, quadratic multiplier for x, quadratic multiplier for x^2, and Gaussian amplitudes, x offsets, and exponential scalers for each Gaussian. The number of each Gaussian group must be the same; e.g., there must be two of each amplitude, x offset, and exponential scalers, but only one constant and quadratic multipliers.

Returns:

yfloat or array-like

Normal value at x

Raises:

ValueError

If the correct number of inputs are not supplied to param