res_grad_raise

TRXASprefitpack.res.res_grad_raise(x0: ndarray, num_comp: int, base: bool, irf: str, fix_param_idx: ndarray | None = None, t: Sequence[ndarray] | None = None, intensity: Sequence[ndarray] | None = None, eps: Sequence[ndarray] | None = None) → Tuple[ndarray, ndarray][source]

scipy.optimize.minimize compatible scalar residual and its gradient function for fitting multiple set of time delay scan with the sum of convolution of raise_model \((\exp(-t/\tau_{i+1})-\exp(-t/\tau_1))\) and instrumental response function

Parameters:

  • x0 –

    initial parameter, if irf == ‘g’,’c’:

    • 1st: fwhm_(G/L)

    • 2nd to \(2+N_{scan}\): time zero of each scan

    • \(2+N_{scan}\) to \(2+N_{scan}+N_{\tau}\): time constant of each decay component

    if irf == ‘pv’:

    • 1st and 2nd: fwhm_G, fwhm_L

    • 3rd to \(3+N_{scan}\): time zero of each scan

    • \(3+N_{scan}\) to \(3+N_{scan}+N_{\tau}\): time constant of each decay component

  • num_comp – number of exponential decay component (except base)

  • base – whether or not include baseline (i.e. very long lifetime component)

  • irf –

    shape of instrumental response function

    • ’g’: normalized gaussian distribution,

    • ’c’: normalized cauchy distribution,

    • ’pv’: pseudo voigt profile \((1-\eta)g(f) + \eta c(f)\)

    For pseudo voigt profile, the mixing parameter \(\eta(f_G, f_L)\) and uniform fwhm paramter \(f(f_G, f_L)\) are calculated by calc_eta and calc_fwhm routine

  • t – time points for each data set

  • fix_param_idx – index for fixed parameter (masked array for x0)

  • intensity – sequence of intensity of datasets

  • eps – sequence of estimated error of datasets

Returns:

Tuple of scalar residual function \((\frac{1}{2}\sum_i {res}^2_i)\) and its gradient