rmjarvis / TreeCorr

Code for efficiently computing 2-point and 3-point correlation functions. For documentation, go to
http://rmjarvis.github.io/TreeCorr/
Other
97 stars 37 forks source link

Let varg, vark be specifiable by the user, rather than computed #154

Closed rmjarvis closed 7 months ago

rmjarvis commented 1 year ago

The current estimates of varg and vark assume that the fields are noise dominated with a constant variance (e.g. "shape noise" for shear fields), so one can get a good estimate of the appropriate variance empirically from calculating <|g|^2> or <(k-k_mean)^2>.

@AlexGKim has a use case where that might not be the case, but he knows the actual variance in the measurements. So this issue is a feature request to allow the user to set the variance explicitly in a Catalog, rather than let TreeCorr calculate it internally.

Two possible APIs to consider:

  1. Set it on construction: cat = Catalog(..., vark=vark)
  2. Set it after construction cat.vark = vark

Or maybe just allow both would also make sense.