pyimcom.splitpsf.imsubtract_wrapper

Functions

run_imsubtract_all(cfg_file[, workers, fft_workers, ...])

Main routine to run imsubtract on all images in the cache.

Module Contents

run_imsubtract_all(cfg_file, workers=4, fft_workers=None, max_imgs=None, display=None, local_output=False, mmap=None, bin2x2=False)[source]

Main routine to run imsubtract on all images in the cache.

Parameters:

  • cfg_file (str) – Path to the config file.

  • workers (int, optional) – Number of workers to use for parallel processing. Default is 4.

  • fft_workers (int, optional) – Number of workers to use for FFT parallelism (if requested).

  • max_imgs (int, optional) – If provided, does computations for a maximum number of SCAs. Most users will want the default of None; this is provided mainly for testing.

  • display (str or None, optional) – Display location for intermediate steps. Default is None.

  • local_output (bool, optional) – Whether to direct the file to local output instead of the cache directory.

  • mmap (str or str-like, optional) – Directory to put temporary mmap files.

  • bin2x2 (bool, optional) – If True, bin the kernel 2x2 for speed even if config_file doesn’t tell you to.