imap_processing.hit.l1a.hit_l1a.calculate_uncertainties#

imap_processing.hit.l1a.hit_l1a.calculate_uncertainties(dataset: Dataset) Dataset#

Calculate uncertainties for each counts data variable in the dataset.

Calculate the upper and lower uncertainties. The uncertainty for the raw Lev1A HIT data will be calculated as asymmetric Poisson uncertainty as prescribed in Gehrels 1986 (DOI: 10.1086/164079). See section 5.5 in the algorithm document for details.

The upper uncertainty will be calculated as

DELTA_PLUS = sqrt(counts + 1) + 1

The lower uncertainty will be calculated as

DELTA_MINUS = sqrt(counts)

Parameters:

dataset (xarray.Dataset) – The dataset containing counts data.

Returns:

dataset – The dataset with added uncertainties for each counts data variable.

Return type:

xarray.Dataset