marked_npairs_xy_z_engine

halotools.mock_observables.pair_counters.marked_cpairs.marked_npairs_xy_z_engine()

Cython engine for counting pairs of points as a function of three-dimensional separation.

Parameters:

double_mesh : object

Instance of RectangularDoubleMesh

x1in, y1in, z1in : arrays

Numpy arrays storing Cartesian coordinates of points in sample 1

x2in, y2in, z2in : arrays

Numpy arrays storing Cartesian coordinates of points in sample 2

weight_func_id : int, optional

weighting function integer ID.

weights1in : array

weights2in : array

rp_bins : array_like

numpy array of boundaries defining the bins of separation in the xy-plane \(r_{\rm p}\) in which pairs are counted.

pi_bins : numpy.array

array defining parallel separation in which to sum the pair counts

cell1_tuple : tuple

Two-element tuple defining the first and last cells in double_mesh.mesh1 that will be looped over. Intended for use with python multiprocessing.

Returns:

counts : array

Integer array of length len(rp_bins) giving the number of pairs separated by a distance less than the corresponding entry of rp_bins.