shift_time_axis_by_irf_location

shift_time_axis_by_irf_location(plot_data: DataArray, irf_location: float | None, *, _internal_call: bool = False) → DataArray[source]

Shift plot_data ‘time’ axis by the position of the main irf.

Parameters:

plot_data (xr.DataArray) – Data to plot.
irf_location (float | None) – Location of the irf, if the value is None the original plot_data will be returned.
_internal_call (bool) – This indicates internal use stripping away user help and silently skipping execution. Defaults to False.

Returns:

plot_data with the time axis shifted by the position of the main irf.

Return type:

xr.DataArray

Raises:

ValueError – If plot_data does not have a time axis.