How rohinkumar/correlcalc works
correlcalc is a scientific Python package for estimating isotropic and anisotropic galaxy two-point correlation functions. A user supplies survey data, bins, and either a random catalog or survey mask. The API loads and prepares catalogs, applies cosmology and geometry distance models, counts BallTree-neighbor pairs, and applies a selectable estimator to return correlation and Poisson-error arrays. Optional branches generate random catalogs and visualize survey positions with healpix. Some internal wiring is inferred from documented capabilities because several modules were not sampled.
Components 16
Public APIs
- TPCF API
correlcalc/tpcf.py - Anisotropic API
correlcalc/antpcf.py
Catalog Inputs
- Catalog File I/O
correlcalc/fileios.py - Catalog Preparation
correlcalc/datprep.py - Random Generator
correlcalc/genrand.py
Correlation Compute
- Cosmology Distances
correlcalc/comovdist.py - Geometry Metrics
metrics/metrics.c - BallTree Pair Counts
correlcalc/tpcf.py - Anisotropic Pair Counts
correlcalc/antpcf.py - Correlation Estimator
correlcalc/tpcf.py
Results Visualization
- Correlation Arrays
correlcalc/tpcf.py - Healpix Visualizer
correlcalc/datvis.py
Other components
- Survey Analyst
- Galaxy Catalog
- Random Catalog
- Survey Mask
Connections 21
- Survey Analyst → TPCF API: invokes
- Survey Analyst → Anisotropic API: invokes
- Galaxy Catalog → TPCF API: provides data
- Random Catalog → TPCF API: provides randoms
- Survey Mask → Random Generator: constrains survey
- TPCF API → Catalog File I/O: loads catalogs
- TPCF API → Catalog Preparation: prepares data
- TPCF API → Cosmology Distances: computes distances
- TPCF API → Random Generator: generates randoms
- Anisotropic API → Catalog File I/O: loads catalogs
- Anisotropic API → Catalog Preparation: prepares data
- Anisotropic API → Cosmology Distances: computes distances
- TPCF API → BallTree Pair Counts: counts pairs
- Anisotropic API → Anisotropic Pair Counts: counts pairs
- BallTree Pair Counts → Geometry Metrics: measures separations
- Anisotropic Pair Counts → Geometry Metrics: measures separations
- TPCF API → Correlation Estimator: estimates correlation
- Anisotropic API → Correlation Estimator: estimates correlation
- Correlation Estimator → Correlation Arrays: returns arrays
- Survey Analyst → Healpix Visualizer: requests maps
- Galaxy Catalog → Healpix Visualizer: provides positions