TreeCorr Documentation

• Overview
  • Installation
  • Two-point Correlations
  • Three-point Correlations
  • Running corr2 and corr3
  • Using the Python module
  • Reporting bugs
  • Requesting features
• Input Data
  • The Catalog class
  • Other utilities related to catalogs
  • File Readers
• Two-point Correlation Functions
  • NNCorrelation: Count-count correlations
  • NKCorrelation: Count-scalar correlations
  • KKCorrelation: Scalar-scalar correlations
  • NZCorrelation: Count-complex correlations
  • KZCorrelation: Scalar-complex correlations
  • ZZCorrelation: Complex-complex correlations
  • NVCorrelation: Count-vector correlations
  • KVCorrelation: Scalar-vector correlations
  • VVCorrelation: Vector-vector correlations
  • NGCorrelation: Count-shear correlations
  • KGCorrelation: Scalar-shear correlations
  • GGCorrelation: Shear-shear correlations
  • NTCorrelation: Count-trefoil correlations
  • KTCorrelation: Scalar-trefoil correlations
  • TTCorrelation: Trefoil-trefoil correlations
  • NQCorrelation: Count-quatrefoil correlations
  • KQCorrelation: Scalar-quatrefoil correlations
  • QQCorrelation: Quatrefoil-quatrefoil correlations
  • Corr2
  • estimate_multi_cov()
  • build_multi_cov_design_matrix()
  • set_max_omp_threads()
  • set_omp_threads()
  • get_omp_threads()
• Three-point Correlation Functions
  • NNNCorrelation: Count-count-count correlations
  • GGGCorrelation: Shear-shear-shear correlations
  • KKKCorrelation: Scalar-scalar-scalar correlations
  • Corr3
• Metrics
  • “Euclidean”
  • “Arc”
  • “Rperp” or “FisherRperp”
  • “OldRperp”
  • “Rlens”
  • “Periodic”
  • Restrictions on the Line of Sight Separation
• Binning
  • “Log”
  • “Linear”
  • “TwoD”
  • Output quantities
  • Other options for binning
• Shear Conventions
  • Flat Geometries
  • Spherical Geometries
  • Options to adjust the convention
  • Vectors
• Patches
  • Defining Patches on Input
  • Running K-Means
  • Using Patch Centers
  • Reducing Memory Use
  • Using MPI
• Covariance Estimates
  • Variance Methods
  • Covariance Matrix
  • Covariance of Derived Quantities
  • Random Catalogs
• Fields
  • Field
  • NField
  • KField
  • ZField
  • VField
  • GField
  • TField
  • QField
• Using configuration files
  • The corr2 and corr3 executables
  • The corr2 function from python
  • The corr3 function from python
  • Other utilities related to corr2 and corr3
  • Utilities related to the configuration dict
  • File Writers
• Getting Started Guide
  • Jupyter Tutorial
  • Shear-shear auto-correlation
  • Other Two-point Correlation Classes
  • Loading a Catalog
  • Building a Catalog from numpy arrays
  • Defining the binning
  • Three-point Correlation Classes
  • Using random catalogs
  • Manually accumulating the correlation function
• Changes from version 4.3 to 5.0
  • Dependency Change
  • API Changes
  • Performance improvements
  • New features
  • Bug fixes
  • Changes from version 5.0.0 to 5.0.1
  • Changes from version 5.0.1 to 5.0.2
• Previous History

• Index

• Module Index

• Search Page