pycaravel: This module is designed to simplify continuous integration (CI) of data from multiple projects.

Note

This page is a reference documentation. It only explains the class signature, and not how to use it. Please refer to the gallery for the big picture.

class caravel.loaders.loader_base.LoaderBase[source]¶

Base class for all loaders.

can_load(path)[source]¶

A method checking the file extension.

Parameters:: path : str

the path to the data to be loaded.
Returns:: out : bool

True if the file extension is valid, False otherwise.

can_save(outpath)[source]¶

A method checking the output file extension.

Parameters:: outpath : str

the path where the the image will be saved.
Returns:: out : bool

True if the output file extension is valid, False otherwise.

load(path)[source]¶

A method that load the data and associated metadata.

save(data, outpath)[source]¶

A method that save the data and associated metadata.

Parameters:

image : Data

the data to be saved.

outpath : str

the path where the the data will be saved.