SkyImageStatistics

class SkyImageStatistics(sky_count, sky_snr, filter_array=0, reg=[(0, 0), (0, 0)])[source]

Bases: object

Compute statistical analysis of a sky image

builder

Parameters:
  • sky_count (2d array) – sky image
  • sky_snr (2d array) – sky snr image
  • filter_array – fov size array set to nan for positions not to be analysed

(1 elsewhere) (default=0, not used) :type filter_array: 2d array :param reg: image coordinates delimiting a the rectangular region of sky to considered [(y_a,z_a),(y_b,z_b)](inclusive) :type reg: [(int, int), (int, int)]

Methods Summary

run([nb_src, snr_limit, rad, show]) run the statistical routine

Methods Documentation

run(nb_src=0, snr_limit=0, rad=3, show=False)[source]

run the statistical routine

Parameters:
  • nb_src (int) – number of peak to be found. (default=0, no search)
  • snr_limit (float) – only fov positions of snr >= snr_limit is considered
  • rad (float) – avoiding radius for each peak (default=3)
  • show (bool) – flag to show the different sky images along the process (default=False)
Returns:

image_stat [mean, median, std], list_src [position, src_count, max_snr]

Return type:

[float, float, float], list