load

ripplemapper.io.load(file: str | PosixPath | WindowsPath, **kwargs)

Load a file into a ripplemapper object based on file extension.

Parameters:

file (str | PosixPath | WindowsPath) – File path to load.

Returns:

Loaded ripplemapper object based on file extension.

Return type:

RippleContour, RippleImage, or RippleImageSeries

Raises:

ValueError – If the file type is unsupported.