yaw.catalogs.scipy.utils.get_patch_list#

yaw.catalogs.scipy.utils.get_patch_list(catalog1: ScipyCatalog, catalog2: ScipyCatalog | None, config: Configuration, linkage: PatchLinkage | None, auto: bool) tuple[list[PatchCatalog], list[PatchCatalog]][source]#

Generate a two lists of patch pairs to correlate.

Generate the listing from two catalogs either from a given linkage or from a newly constructed one.

Parameters:
  • catalog1 (yaw.catalogs.scipy.ScipyCatalog) – The first input data catalogue.

  • catalog2 (yaw.catalogs.scipy.ScipyCatalog, None) – The second input data catalogue, can be None.

  • config (yaw.config.Configuration) – The configuration used for the correlation measurement.

  • linkage (PatchLinkage, None) – Linkage object that defines with patches must be correlated for a given scales and which patch combinations can be skipped.

  • auto (bool) – Whether to generate patch pairs for an autocorrelation.

Returns:

Two lists, one containing the patches from the first catalogue that are paired with the ones in the second list from the second catalogues.