pangeo_fish.acoustic.emission_probability

pangeo_fish.acoustic.emission_probability(tag, grid, buffer_size, nondetections='ignore', cell_ids='keep', chunk_time=24, dims=None)

Construct emission probability maps from acoustic detections

Parameters:

• tag (xarray.DataTree) – The tag data.

• grid (xarray.Dataset) – The target grid. Must have the cell_ids and time coordinates and the mask variable.

• buffer_size (pint.Quantity) – The size of the buffer around each station. Must be given in a length unit.

• nondetections ({"mask", "ignore"}, default: "mask") – How to deal with non-detections in time slices without detections:

  • “mask”: set the buffer around stations without detections to 0.

  • “ignore”: all valid pixels are equally probable.

• cell_ids ({"recompute", "keep"}, default: "keep") – How to deal with model cell ids for the computation of reception masks.

• cell_ids ({"recompute", "keep"}, default: "recompute") – How to deal with model cell ids for the computation of reception masks:

  • “keep”: use the cell ids given by the model. This is the more correct method.

  • “recompute”: recompute the cell ids based on the rotated lat / lon coords.

• dims (list of str, default: None) – Dimensions to use: either [“x”, “y”] or [“cells”]

Returns:

emission (xarray.Dataset) – The resulting emission probability maps.