patch
Utilities for working with the Patch class.
Functions
| Name | Description |
|---|---|
| align_patch_coords | Align two patches of the same kind so their data broadcast together. |
| check_coords | Return True if the coordinates of two patches are compatible, else False. |
| check_data_units | Return True unless the patches hold different data units. |
| check_dims | Return True if dimensions of two patches are equal. |
| check_kind | Return True if two patches are the same kind. |
| check_patch_attrs | Check for expected attributes. |
| check_patch_coords | Check that a patch has the required coordinates, else raise. |
| check_patch_data | Check that data are in reach, else raise. |
| concatenate_planned | Concatenate the members of one planned output, as the plan decided. |
| drop_associated_coords | Drop, with a warning, the non-dimensional coordinates along a dimension. |
| get_dim_axis_value | Get dimension name, index, and values from args/kwargs for a patch. |
| get_dim_sampling_rate | Get sampling rate, as a float from sampling period along a dimension. |
| get_patch_kind | Return the attribute values which decide what kind of patch this is. |
| get_patch_names | Generates the default name of patch data. |
| get_start_stop_step | Convenience method for getting start, stop, step for a given coord. |
| merge_compatible_coords_attrs | Merge the coordinates and attributes of patches or raise if incompatible. |
| numpy_fallback | Apply a function numpy can perform but the patch’s backend cannot. |
| patch_function | Decorator to mark a function as a patch method. |
| patches_to_df | Return a dataframe. |
| record_call |
Return out carrying what a call to patch_func records.
|
| stack_patches | Stack (add) all patches compatible with first patch together. |
| swap_kwargs_dim_to_axis | Convert dimension names to axis indices in kwargs. |