yaw.correlation.add_corrfuncs#

yaw.correlation.add_corrfuncs(corrfuncs: Sequence[CorrFunc], weights: Sequence[number] | None = None) → CorrFunc[source]#

Add correlation functions that are measured at different scales.

The correlation functions are added by summing together their pair counts. They can be weighted prior to summation by effectively scaling their pair counts with a set of scalar weights, one for each input correlation function.

Note

The actual scales are not checked, but the number of patches and the redshift binning of the inputs must be identical.

This operation is effectively equivalent to:

>>> corrfunc1 * weight1 + corrfunc2 * weight2  # + ...

Parameters:

corrfuncs (sequence of CorrFunc) – A list of correlation functions to add.
weights (sequence of int or float, optional) – An optional list of weights, one for each correlation function.

Returns:

The combined correlation function after summing the pairs.

Return type:

CorrFunc