benchmark.io.refbased.fits¶
-
class
pywi.benchmark.io.refbased.fits.BenchmarkImage(input_image, reference_image, metadata)¶ -
input_image¶ Alias for field number 0
-
metadata¶ Alias for field number 2
-
reference_image¶ Alias for field number 1
-
-
pywi.benchmark.io.refbased.fits.benchmark_image_generator(path_list, max_num_images=None, **kwargs)[source]¶ Return an iterable sequence all calibrated images in path_list.
Parameters: - path_list – The path of files containing the images to extract. It can contain FITS/Simtel files and directories.
- max_num_images – The maximum number of images to iterate.
Yields: Image1D or Image2D – The named tuple Image1D or Image1D of the next FITS or Simtel files in path_list.
-
pywi.benchmark.io.refbased.fits.load_benchmark_images(file_path)[source]¶ Return images contained in the given FITS file.
Parameters: file_path (str) – The path of the FITS file to load Returns: A dictionary containing the loaded images and their metadata Return type: dict Raises: WrongFitsFileStructure– If file_path doesn’t contain a valid structure