polartoolkit.block_reduce

Contents

polartoolkit.block_reduce#

block_reduce(df, reduction, input_coord_names=('x', 'y'), input_data_names=None, **kwargs)[source]#

perform a block reduction of a dataframe.

Parameters:
  • df (DataFrame) โ€“ data to block reduce

  • reduction (Callable[..., float | int]) โ€“ function to use in reduction, e.g. np.mean

  • input_coord_names (tuple[str, str]) โ€“ strings of coordinate column names, by default (โ€œxโ€, โ€œyโ€) or (โ€œeastingโ€, โ€œnorthingโ€)

  • input_data_names (Any | None) โ€“ strings of data column names, by default None

  • kwargs (Any)

Returns:

a block-reduced dataframe

Return type:

DataFrame