minerva.data.readers.png_reader

Classes

PNGReader

A base class for iterating over files in a directory in a custom sorted

Module Contents

class minerva.data.readers.png_reader.PNGReader(path, sort_method=None, delimiter=None, key_index=0, reverse=False)

Bases: minerva.data.readers.base_file_iterator.BaseFileIterator

A base class for iterating over files in a directory in a custom sorted order.

Load image files from a directory.

Parameters

pathUnion[Path, str]

The path to the directory containing the image files. Files will be searched recursively.

sort_methodOptional[List[str]], optional

A list specifying how to sort each part of the filename. Each element can be either “text” (lexicographical) or “numeric” (numerically). By default, None, which will use “numeric” if numeric parts are detected.

delimiterOptional[str], optional

The delimiter to split filenames into components, by default None.

key_indexUnion[int, List[int]], optional

The index (or list of indices) of the part(s) of the filename to use for sorting. If a list is provided, files will be sorted based on multiple parts in sequence. Thus, first by the part at index 0, then by the part at index 1, and so on. By default 0.

reversebool, optional

Whether to sort in reverse order, by default False.

Raises

NotADirectoryError

If the path is not a directory.

__getitem__(index)

Retrieve the PNG file at the specified index.

Parameters:

index (int)

Return type:

numpy.ndarray

__str__()

Return type:

str

root_dir

Parameters:

• path (minerva.utils.typing.PathLike)

• sort_method (Optional[List[str]])

• delimiter (Optional[str])

• key_index (Union[int, List[int]])

• reverse (bool)