RectangularDoubleMesh¶
- class halotools.mock_observables.pair_counters.RectangularDoubleMesh(x1, y1, z1, x2, y2, z2, approx_x1cell_size, approx_y1cell_size, approx_z1cell_size, approx_x2cell_size, approx_y2cell_size, approx_z2cell_size, search_xlength, search_ylength, search_zlength, xperiod, yperiod, zperiod, PBCs=True, max_cells_per_dimension_cell1=50, max_cells_per_dimension_cell2=50)[source]¶
Bases:
object
Fundamental data structure of the
mock_observables
sub-package.RectangularDoubleMesh
is built up from two instances ofRectangularMesh
.- Parameters:
- x1, y1, z1arrays
Length-Npts1 arrays containing the spatial position of the Npts1 points.
- x2, y2, z2arrays
Length-Npts2 arrays containing the spatial position of the Npts2 points.
- approx_x1cell_size, approx_y1cell_size, approx_z1cell_sizefloat
approximate cell sizes into which the simulation box will be divided. These are only approximate because in each dimension, the actual cell size must be evenly divide the box size.
- approx_x2cell_size, approx_y2cell_size, approx_z2cell_sizefloat
An entirely separate tree is built for the Npts2 points, the structure of which is dependent on the struture of the Npts1 tree as described below.
- search_xlength, search_ylength, search_zlength, floats, optional
Maximum length over which a pair of points will searched for. For example, if using
RectangularDoubleMesh
to compute a 3-D correlation function with radial separation bins rbins = [0.1, 1, 10, 25], then in this case all the search lengths will equal 25. If usingRectangularDoubleMesh
in a projected correlation function with rp_bins = [0.1, 1, 10, 25] and pi_max = 40, then search_xlength = search_ylength = 25 and search_zlength = 40.- xperiod, yperiod, zperiodfloats
Length scale defining the periodic boundary conditions in each dimension. In virtually all realistic cases, these are all equal.
- PBCsbool, optional
Boolean specifying whether or not the box has periodic boundary conditions. Default is True.
- max_cells_per_dimension_cell1int, optional
Maximum number of cells per dimension. Default is 50.
- max_cells_per_dimension_cell2int, optional
Maximum number of cells per dimension. Default is 50.