Utilities
Some functions are included in rampy and have a minor role. They are listed below for reference.
- rampy.functions.constant(x, a)
returns a constant value
- Parameters:
x (1D array) –
- Returns:
y – array filled with a values
- Return type:
1D array
- rampy.functions.difffull(x1: float, x2: float, t: float, C0: float, C1: float, D: float) float
Equation for the diffusion into a full slab, see Crank 1975
Here we assume the profil to have 2 surfaces of contact on each side
- Parameters:
C0 (float) – the concentration in the core
C1 (float) – the concentration at the border
D (float) – the diffusion coefficient in log10 unit, m^2.s^-1
x2 (x1 and) – the profil lengths from beginning and end respectively, in meters
t (float) – time in seconds
- rampy.functions.diffshort(x: ndarray, t: float, C0: float, C1: float, D: float) ndarray
1D equation for the diffusion into a semi-infinite slab, see Crank 1975
- Parameters:
x (1D array) – the profil length in meters
t (float) – time in seconds
C0 (float) – the concentration in the core
C1 (float) – the concentration at the border
D (float) – the diffusion coefficient in log10 unit, m^2.s^-1
- Returns:
Cx – concentration at x
- Return type:
1D array
- rampy.functions.funexp(x, a, b, c)
exponential baseline function
a*exp(b*(x-c))
- rampy.functions.gauss_lsq(params, x)
predicts a sum of gaussian peaks with parameters params
- Parameters:
params (1D array) – an array of the parameters of the peaks. The number of peaks is assumed to be equal to len(params)/3. In this array, list intensities first, then all peak positions, then all peak half width at half maximum.
x (1D array) – x axis
- Returns:
y – y values at position x
- Return type:
1D array
- rampy.functions.gauss_lsq_lfix(params, x)
predicts a sum of gaussian peaks with parameters params
Assumes that all peaks share the same HWHM.
- Parameters:
params (1D array) – an array of the parameters of the peaks. The number of peaks is assumed to be equal to len(params)/3. In this array, list intensities first, then all peak positions, then the last element is the peaks’ half width at half maximum.
x (1D array) – x axis
- Returns:
y – y values at position x
- Return type:
1D array
- rampy.functions.linear(x, a, b)
returns a + b*x
- rampy.functions.linear0(x, a)
returns a*x
- rampy.functions.multigaussian(x, params)
old attempt to have a multigaussian function, do not use. Will be removed soon.
- rampy.functions.poly2(x, a, b, c)
returns a + b*x + c*x*x