extract_irf_dispersion_center

extract_irf_dispersion_center(res: Dataset, main_irf_nr: int = 0, *, as_dataarray: bool = True) → DataArray | float[source]

Extract the IRF dispersion center data from a result dataset where irf_nr==irf_nr_index.

Parameters:

  • res (xr.Dataset) – Result dataset from a pyglotaran optimization.

  • main_irf_nr (int) – Index of the main irf component when using an irf parametrized with multiple peaks. Defaults to 0.

  • as_dataarray (bool) – Ensure that the returned data are xr.DataArray instead of a float, even if the dispersion is none existent or constant. Defaults to True

Returns:

IRF dispersion data as float or xr.DataArray

Return type:

xr.DataArray | float