ecpi.analysis.compare_catalog module

Section author: ECLAIRs GP team

Tools to compare two catalog of sources

Summary

Classes:

CompareSrcCatWithECLAIRsCat

Compare a sources catalog from IMAG to a simple ECLAIRs catalog used by simulation

Class diagram:

Reference

class CompareSrcCatWithECLAIRsCat(src_cat, ref_cat)[source]

Bases: object

Compare a sources catalog from IMAG to a simple ECLAIRs catalog used by simulation

all_sources_scatter_plot(annotation=False, show=True, save=None)[source]

plot all sources from both catalogs on the sky in pixels

Parameters

  • annotation (bool (default=False)) – add the name of the source close to its location

  • show (bool (default=True)) – show the plot

  • save (string (default=None)) – PATH/name of the file to save the fig. If None, no saving.

get_pix_position_diff_stats()[source]

compute mean, median, stddev of the difference of the positions of the 2 cats

Note

only computed for identified sources

Returns

mean(y), mean(z), median(y), median(z), std(y), std(z)

Return type

float, float, float, float, float, float

identified_sources_scatter_plot(annotation=True, show=True, save=None)[source]

plot, from both catalogs, only the sources that has been identified.

Parameters

  • annotation (bool (default=True)) – add the name of the source close to its location

  • show (bool (default=True)) – show the plot

  • save (string (default=None)) – PATH/name of the file to save the fig. If None, no saving.

more_likely_sources_id_pix()[source]

find the name of the found source based on the ref catalog

the new name is save in the ‘name’ column of the catalog of the found source

for each found source:

  • find the closest x-ray source in the ref catalog

  • if the distance is < 2 pix: the name of the found source is set to the name of the closest source in the ref catalog