Welcome to pycorrelator’s documentation!

pycorrelator is a Python package designed to perform cross correlation and self correlation analyses in spherical coordinates. This is particularly useful in fields such as astrophysics, geophysics, and any domain where objects are naturally distributed on a spherical surface. Currently, this package only support astrophysics coordinates (Ra, Dec) in degrees. More units and naming convention will be supported in the future.

Quickstart

1. First, install the package.

2. Second, make sure your data is in the supported formats.

3. Finally,

   • If you want to perform a cross-matching between two catalogs, use the xmatch function. See the cross-matching example for how to use it.

   • If you want to cluster the objects in a catalog with the Friends-of-Friends (FoF) algorithm, use the fof function. See the clustering example for how to use it.

   • If you want to remove duplicates from a catalog, also using the fof function. See the duplicates removal example for how to do it.

Contents

• Installation
• Tutorials
  • What kind of input format does pycorrelator support?
  • Example: Cross-matching two catalogs
  • Example: Clustering using FoF algorithm
  • Example: Duplicates removal
• API Reference
  • xmatch functionality
  • fof functionality
• Development Guide
  • pycorrelator package

Note

This project is under active development. If you find any issue, please report it at the GitHub repository’s issue tracker.

Indices and tables

• Index

• Module Index

• Search Page