shnitsel.clean.common¶

Functions¶

`is_stacked`(obj)
`ensure_unstacked`(obj)
`ensure_stacked`(obj)
`da_or_data_var`(ds_or_da, var_name)
`get_unstacked_coord`(obj, coord_name)
`cum_mask_from_filtranda`(filtranda)
`cum_mask_from_dataset`(ds)
`assign_mask`(ds)	Does not change stacked status
`true_upto`(mask, dim)
`cutoffs_from_mask`(mask)
`cutoffs_from_filtranda`(filtranda)	Does not change stacked status
`cutoffs_from_dataset`(ds)	Returns a da containing cutoff times (the same as the good_upto data_var)
`assign_cutoffs`(ds)
`omit`(ds)
`truncate`(ds)
`transect`(ds, cutoff)
`dispatch_cut`(frames[, cut])
`cum_max_quantiles`(obj[, quantiles])

cum_mask_from_filtranda(filtranda)¶

Parameters:: filtranda (shnitsel.core.typedefs.Stacked | shnitsel.core.typedefs.Unstacked)
Return type:: shnitsel.core.typedefs.Unstacked

cum_mask_from_dataset(ds)¶

Parameters:: ds (shnitsel.core.typedefs.Stacked | shnitsel.core.typedefs.Unstacked)
Return type:: shnitsel.core.typedefs.Unstacked

cutoffs_from_mask(mask)¶

Parameters:: mask (shnitsel.core.typedefs.Stacked | shnitsel.core.typedefs.Unstacked)
Return type:: shnitsel.core.typedefs.Unstacked

cutoffs_from_filtranda(filtranda)¶

Does not change stacked status

cutoffs_from_dataset(ds)¶

Returns a da containing cutoff times (the same as the good_upto data_var) and with a coord called good_throughout

The returned object has dimensions {‘trajid’, ‘criterion’}. In that sense it is unstacked.

omit(ds)¶

truncate(ds)¶

transect(ds, cutoff)¶

Parameters:

ds (shnitsel.data.trajectory_format.Trajectory | shnitsel.core.typedefs.Frames)
cutoff (float)

dispatch_cut(frames, cut='truncate')¶

Parameters:: cut (Literal['truncate', 'omit', False] | numbers.Number)