SciFiReaders.readers.generic.image.ImageReader

SciFiReaders.readers.generic.image.ImageReader#

class SciFiReaders.readers.generic.image.ImageReader(file_path, *args, **kwargs)[source]#

Bases: Reader

Translates data from an image file to a sidpy dataset

Parameters:

file_path (str) – Path to the file that needs to be read

self._input_file_path#

Path to the file that will be read

Type:

str

Notes

  • This method will check to make sure that the provided file_path is indeed a string and a valid file path.

  • Consider calling can_read() within __init__() for validating the provided file

Raises:

FileNotFoundError

Methods

can_read

Tests whether or not the provided file has the appropriate extensions

read

Translates the image in the provided file into a sidpy Dataset :param image_args: Arguments to be passed to read_image.

can_read()[source]#

Tests whether or not the provided file has the appropriate extensions

read(**image_args)[source]#

Translates the image in the provided file into a sidpy Dataset :param image_args: Arguments to be passed to read_image. Arguments depend on the type of image. :type image_args: dict

Return type:

sidpy Dataset