collapse

typhon.collocations.collapse(data, reference=None, collapser=None)[source]

Collapse all multiple collocation points to a single data point

During searching for collocations, one might find multiple collocation points from one dataset for one single point of the other dataset. For example, the MHS instrument has a larger footprint than the AVHRR instrument, hence one will find several AVHRR colloocation points for each MHS data point. This method performs a function on the multiple collocation points to merge them to one single point (e.g. the mean function).

Parameters:

  • data

  • reference – Normally the name of the dataset with the largest footprints. All other dataset will be collapsed to its data points.

  • collapser – Dictionary with names of collapser functions to apply and references to them. Defaults collpaser functions are mean, std and number (count of valid data points).

Returns:

A xr.Dataset object with the collapsed data

Examples

# TODO: Add examples