module documentation

Routines for handing an array that knows it's physical size.

Class GeoArray A Geometric Array. An array of data, along with coordinate axes that describe the position of the data.
Function plot_ga Plot the GeoArray as an image. Only works for 2d arrays at present. Will call a mutator on the data before plotting. Returns a numpy array of the axes created for the plot
def plot_ga(geo_array: GeoArray, data_mutator: Callable[[np.ndarray], np.ndarray] = lambda x: x, title: str = '', data_units: str = '', axes_units: str | tuple[str, ...] = '', show: bool = True):

Plot the GeoArray as an image. Only works for 2d arrays at present. Will call a mutator on the data before plotting. Returns a numpy array of the axes created for the plot