load_dir_to_obj#

ripplemapper.io.load_dir_to_obj(directory: str | PosixPath, pattern: str | bool = False, skip: int = 1, start: int = 0, end: int = None, **kwargs) list[source]#

Load all tif files found in directory and return the data in a list of RippleImage objects.

Parameters:
  • directory (str | PosixPath) – Directory path to load tif files from.

  • pattern (str | bool, optional) – Optional pattern to match file names, by default False.

  • skip (int, optional) – Number of files to skip, by default 1.

  • start (int, optional) – Starting index, by default 0.

  • end (int, optional) – Ending index, by default None.

  • **kwargs – Additional keyword arguments for the RippleImage initialization.

Returns:

List of RippleImage objects initialized from the tif files.

Return type:

list[RippleImage]