Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC add comment on binsize definition #164

Merged
merged 2 commits into from
Dec 4, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/binning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,10 @@ values.

The approximation TreeCorr makes is to allow some *additional* imprecision that is a
fraction of this level. Namely ``bin_slop``. Specifically, ``bin_slop`` specifies the
maximum possible error any pair can have, given as a fraction of the bin size.
maximum possible error any pair can have, given as a fraction of the bin size. By bin size,
we mean the size in logarithmic units for log binning (i.e., ``log(H) - log(L)``
and linear units for linear binning (i.e., ``H-L``) where ``H`` and ``L`` are the upper
anf lower bounds of the bin.
beckermr marked this conversation as resolved.
Show resolved Hide resolved

You can think of it as turning all of your rectangular bins into overlapping trapezoids,
where ``bin_slop`` defines the ratio of the angled portion to the flat mean width.
Expand Down
Loading