NNNNCorrelation: Scalar-Scalar-Scalar-Scalar Correlations

class orpheus.NNNNCorrelation_NoTomo(min_sep, max_sep, verbose=False, thetabatchsize_max=10000, method='Tree', **kwargs)

Bases: BinnedNPCF

Class containing methods to measure and obtain statistics that are built from nontomographic fourth-order scalar correlation functions.

min_sep

The smallest distance of each vertex for which the NPCF is computed.

Type

float

max_sep

The largest distance of each vertex for which the NPCF is computed.

Type

float

thetabatchsize_max

The largest number of radial bin combinations that are processed in parallel. Defaults to 10 000.

Type

int, optional

Notes

Inherits all other parameters and attributes from BinnedNPCF. Additional child-specific parameters can be passed via kwargs. Either nbinsr or binsize has to be provided to fix the binning scheme.

__init__(min_sep, max_sep, verbose=False, thetabatchsize_max=10000, method='Tree', **kwargs)

process(cat, statistics='all', tofile=False, apply_edge_correction=False, lowmem=True, mapradii=None, batchsize=None, custom_thetacombis=None, cutlen=2147483647)

Arguments:

Logic works as follows: * Keyword ‘statistics’ in [4pcf_real, 4pcf_multipoles, N4, Nap4, Nap4, Nap4c, allNap, all4pcf, all] * - If 4pcf_multipoles in statistics –> save 4pcf_multipoles * - If 4pcf_real in statistics –> save 4pcf_real * - If only N4 in statistics –> Do not save any 4pcf. This is really the lowmem case. * - allNap, all4pcf, all are abbreviations as expected * If lowmem=True, uses the inefficient, but lowmem function for computation and output statistics from there as wanted. * If lowmem=False, use the fast functions to do the 4pcf multipole computation and do the potential conversions lateron. * Default lowmem to None and * - Set to true if any aperture statistics is in stats or we will run into mem error * - Set to false otherwise * - Raise error if lowmem=False and we will have more than 2^31-1 elements at any stage of the computation

custom_thetacombis: array of inds which theta combis will be selected

multipoles2npcf_singlethetcombi(elthet1, elthet2, elthet3)

Converts a 4PCF from the multipole basis to the real-space basis for a fixed combination of radial bins.

__annotations__ = {}

__module__ = 'orpheus.npcf_fourth'