clevar.match package

clevar.match.get_matched_masks(cat1, cat2, matching_type)[source]
Parameters

  • cat1 (clevar.ClCatalog) – ClCatalog with matching information

  • cat2 (clevar.ClCatalog) – ClCatalog matched to

  • matching_type (str) – Type of matching to be considered. Must be in: ‘cross’, ‘cat1’, ‘cat2’

Returns

  • mask1 (ndarray) – Array of booleans to get catalog1 matched clusters

  • mask2 (ndarray) – Array of catalog2 indexes corresponding to catalog1 matched clusters

clevar.match.get_matched_pairs(cat1, cat2, matching_type, mask1=None, mask2=None)[source]
Parameters

  • cat1 (clevar.ClCatalog) – ClCatalog with matching information

  • cat2 (clevar.ClCatalog) – ClCatalog matched to

  • matching_type (str) – Type of matching to be considered. Must be in: ‘cross’, ‘cat1’, ‘cat2’

  • mask1 (array, None) – Mask for clusters 1 properties, must have size=cat1.size

  • mask2 (array, None) – Mask for clusters 2 properties, must have size=cat2.size

clevar.match.output_catalog_with_matching(file_in, file_out, catalog, overwrite=False)[source]

Add matching information to original catalog.

Parameters

  • file_in (str) – Name of input catalog file

  • file_out (str) – Name of output catalog file

  • catalog (clevar.ClCatalog) – ClCatalog with matching information

  • overwrite (bool) – Overwrite output file

clevar.match.output_matched_catalog(file_in1, file_in2, file_out, cat1, cat2, matching_type='cross', overwrite=False)[source]

Output matched catalog with information of both inputs.

Parameters

  • file_in1 (str) – Name of input catalog file

  • file_in2 (str) – Name of input catalog file

  • file_out (str) – Name of output catalog file

  • cat1 (clevar.ClCatalog) – ClCatalog with matching information corresponding to file_in1

  • cat1 – ClCatalog with matching information corresponding to file_in2

  • matching_type (str) – Type of matching to be considered. Must be in: ‘cross’, ‘cat1’, ‘cat2’

  • overwrite (bool) – Overwrite output file

Submodules