Direct estimator of aperture mass cumulants

There is currently a class for computing higher-order aperture mass and aperture counts statistics using the direct estimator approach.

• MapnEqual: Nth order equal-scale aperture mass statistics
  • Direct_MapnEqual
    • Direct_MapnEqual.order_max
    • Direct_MapnEqual.Rmin
    • Direct_MapnEqual.Rmax
    • Direct_MapnEqual.field
    • Direct_MapnEqual.filter_form
    • Direct_MapnEqual.ap_weights
    • Direct_MapnEqual.__init__()
    • Direct_MapnEqual.process()
    • Direct_MapnEqual._getindex()
    • Direct_MapnEqual._buildargs()
    • Direct_MapnEqual._nzcombis_tot()
    • Direct_MapnEqual._nzcombis_order()
    • Direct_MapnEqual._cumnzcombis_order()
    • Direct_MapnEqual.genzcombi()
    • Direct_MapnEqual.getmap()
    • Direct_MapnEqual.__annotations__
    • Direct_MapnEqual.__module__
• NapnEqual: Nth order equal-scale aperture counts statistics
  • Direct_NapnEqual
    • Direct_NapnEqual.order_max
    • Direct_NapnEqual.Rmin
    • Direct_NapnEqual.Rmax
    • Direct_NapnEqual.field
    • Direct_NapnEqual.filter_form
    • Direct_NapnEqual.ap_weights
    • Direct_NapnEqual.__init__()
    • Direct_NapnEqual.process()
    • Direct_NapnEqual._getindex()
    • Direct_NapnEqual._buildargs()
    • Direct_NapnEqual._nzcombis_tot()
    • Direct_NapnEqual.__annotations__
    • Direct_NapnEqual.__module__
    • Direct_NapnEqual._nzcombis_order()
    • Direct_NapnEqual._cumnzcombis_order()
    • Direct_NapnEqual.genzcombi()
    • Direct_NapnEqual.getnap()

Each of the above classes is a sub-class of the base class DirectEstimator, so they have a number of features in common about how they are constructed. The common features are documented here.

class orpheus.direct.DirectEstimator(Rmin, Rmax, nbinsr=None, binsize=None, aperture_centers='grid', accuracies=2.0, frac_covs=[0.0, 0.1, 0.3, 0.5, 1.0], dpix_hash=1.0, weight_outer=1.0, weight_inpainted=0.0, method='Discrete', multicountcorr=True, shuffle_pix=1, tree_resos=[0, 0.25, 0.5, 1.0, 2.0], tree_redges=None, rmin_pixsize=20, resoshift_leafs=0, minresoind_leaf=None, maxresoind_leaf=None, nthreads=16)

Class of aperture statistics up to nth order for various arbitrary tracer catalogs. This class contains attributes and methods that can be used across any of its children.

Rmin

The smallest aperture radius for which the cumulants are computed.

Type

float

Rmax

The largest aperture radius for which the cumulants are computed.

Type

float

nbinsr

The number of radial bins for the aperture radii. If set to None this attribute is inferred from the binsize attribute.

Type

int, optional

binsize

The logarithmic size of the radial bins for the aperture radii. If set to None this attribute is inferred from the nbinsr attribute.

Type

int, optional

aperture_centers

How to sample the apertures. Can be 'grid' or 'density'.

Type

str, optional

accuracies

The sampling density of aperture centers.

• If aperture_centers is set to 'grid', setting accuracy == x places the apertures on a regular grid with pixel size R_ap / x.

• If aperture_centers is set to 'density', randomly selects as many galaxies as there would be aperture centers on the regular grid.

Type

int or numpy.ndarray, optional

frac_covs

The different aperture coverage bins for which the statistics are evaluated. The first bin only includes apertures with coverage <= frac_covs[0] while the other coverage bins include the intervals between frac_covs[i] and frac_covs[i+1]. Coverage is defined as the percentage of the aperture area that is not within the survey area.

Type

numpy.ndarray, optional

dpix_hash

The pixel size of the spatial hash used to search through the catalog.

Type

float, optional

weight_outer

The fractional weight applied to galaxies not contained within the interior of the catalog. This only affects catalogs which are overlapping patches of a full-sky catalog.

Type

float, optional

weight_inpainted

The fractional weight applied to virtual galaxies inpainted into the catalog. This only affects catalogs which have objects in them that are labeled as inpainted.

Type

float, optional

method

The method to be employed for the estimator. Defaults to Discrete.

Type

str, optional

multicountcorr

Flag on whether to subtract multiplets in which the same tracer appears more than once. Defaults to True.

Type

bool, optional

shuffle_pix

Choice of how to define centers of the cells in the spatial hash structure. Defaults to 1, i.e. random positioning.

Type

int, optional

tree_resos

The cell sizes of the hierarchical spatial hash structure.

Type

list, optional

tree_redges

Deprecated (possibly).

Type

list, optional

rmin_pixsize

The limiting radial distance relative to the cell of the spatial hash after which one switches to the next hash in the hierarchy. At the moment has no effect. Defaults to 20.

Type

int, optional

resoshift_leafs

Allows for a difference in how the hierarchical spatial hash is traversed for pixels at the base of the NPCF and pixels at leafs. Positive values indicate that leafs will be evaluated at coarser resolutions than the base. At the moment does have no effect. Defaults to 0.

Type

int, optional

minresoind_leaf

Sets the smallest resolution in the spatial hash hierarchy which can be used to access tracers at leaf positions. If set to None uses the smallest specified cell size. At the moment has no effect. Defaults to None.

Type

int, optional

maxresoind_leafint, optional

Sets the largest resolution in the spatial hash hierarchy which can be used to access tracers at leaf positions. If set to None uses the largest specified cell size. At the moment has no effect. Defaults to None.

nthreadsint, optional

The number of OpenMP threads used for the reduction procedure. Defaults to 16.

get_pixelization(cat, R_ap, accuracy, R_crop=None, mgrid=True)

Computes pixel grid on inner region of survey field.

Parameters

• R_ap (float) – The radius of the aperture in pixel scale.

• accuracy (float) – Accuracy parameter for the pixel grid. A value of 0.5 results in a grid in which the apertures are only touching each other - hence minimizing correlations.

Returns

• grid_x (array of floats) – The grid cell centers for the x-coordinate.

• grid_y (array of floats) – The grid cell centers for the y-coordinate.

• Notes

• ——

• The grid covers the rectangle between the extremal x/y coordinates of

• the galaxy catalogue.

__getmap(R, cat, dotomo, field, filter_form)

This simply computes an aperture mass map together with weights and coverages