API Reference

Main Routines (projected space)

These are the main routines for counting pairs and estimating correlation functions. They encapsulate all required steps to provide a true end-user experience : you only need to provide data+parameters to receive final results, and perhaps that amazing plot of your next paper

Main Routines (redshift space)

These are the main routines for counting pairs and estimating correlation functions. They encapsulate all required steps to provide a true end-user experience : you only need to provide data+parameters to receive final results, and even that amazing plot of your next paper

Main Routines (angular space)

These are the main routines for counting pairs and estimating correlation functions. They encapsulate all required steps to provide a true end-user experience : you only need to provide data+parameters to receive final results, and even that amazing plot of your next paper

Auxiliary Routines

These are helper routines that make it easy to work with correlations, visualize count data, optimize grid size, sort data, etc. For examples of how to use them check their individual help, or even better, the source code of gundam.pcf()

Plotting Routines

Comprehensive Auxiliary Routines

These are helper routines that perform many common tasks (in the Python side) during a correlation run, such as collecting counts, i/o functions, initialization, logging, etc. For a nice example of how to use them, see source code of gundam.pcf()

Fortran Wrapper Routines

These are the wrappers that call Fortran pair counting routines. They are intended to: (1) choose the fastest counting routine depending whether weights, bootstrap errors, etc. are requested or not; and (2): concentrate all mayor Fortran calling in one place

Unless you are building your own custom script, heavily modifying, or extending the core algorithms, you normally should not need to use these functions