Functions
cgm (comm, data, domain, rperp, rpar, los, …) |
Perform the cylindrical grouping method |
data_to_sort_key (data) |
Convert floating type data to unique integers for sorting |
Classes
CylindricalGroups (source, rankby, rperp, rpar) |
Compute groups of objects using a cylindrical grouping method. |
nbodykit.algorithms.cgm.
CylindricalGroups
(source, rankby, rperp, rpar, flat_sky_los=None, periodic=False, BoxSize=None)[source]¶Compute groups of objects using a cylindrical grouping method. We identify all satellites within a given cylindrical volume around a central object.
Results are computed when the object is inititalized, and the result is
stored in the groups
attribute; see the documenation of
run()
.
Input parameters are stored in the attrs
attribute dictionary.
Parameters: |
|
---|
References
Okumura, Teppei, et al. “Reconstruction of halo power spectrum from redshift-space galaxy distribution: cylinder-grouping method and halo exclusion effect”, arXiv:1611.04165, 2016.
Methods
run () |
Compute the cylindrical groups, saving the results to the |
run
()[source]¶Compute the cylindrical groups, saving the results to the
groups
attribute
groups
¶ArrayCatalog
– a catalog holding the result of the grouping. The length of the
catalog is equal to the length of the input size, i.e., the length
is equal to the size
attribute. The relevant fields are:
nbodykit.algorithms.cgm.
cgm
(comm, data, domain, rperp, rpar, los, boxsize)[source]¶Perform the cylindrical grouping method
This outputs a structured array with the same length as the input data with the following fields for each object in the original data:
Parameters: |
|
---|