MapnEqual: Nth order equal-scale aperture mass statistics

class orpheus.Direct_MapnEqual(order_max, Rmin, Rmax, field='polar', filter_form='C02', ap_weights='InvShot', **kwargs)[source]

Bases: DirectEstimator

Compute direct estimator for equal-scale aperture mass statistics.

order_max

Maximum order of the statistics to be computed.

Type

int

Rmin

Minimum aperture radius.

Type

float

Rmax

Maximum aperture radius.

Type

float

field

Type of input field ("scalar" or "polar").

Type

str, optional

filter_form

Filter type used in the aperture function ("S98", "C02", "Sch04", etc.).

Type

str, optional

ap_weights

Aperture weighting strategy ("Identity", "InvShot").

Type

str, optional

\*\*kwargs

Additional keyword arguments passed to DirectEstimator.

Type

dict

Notes

Inherits all other parameters and attributes from DirectEstimator. Additional child-specific parameters can be passed via kwargs.

__init__(order_max, Rmin, Rmax, field='polar', filter_form='C02', ap_weights='InvShot', **kwargs)[source]
process(cat, dotomo=True, Emodeonly=True, connected=True, dpix_innergrid=2.0)[source]

Computes aperture statistics on a catalog.

Parameters

  • cat (orpheus.SpinTracerCatalog) – The catalog instance to be processed.

  • dotomo (bool, optional) – Whether to compute the statistics for all tomographic bin combinations. Default is True.

  • Emodeonly (bool, optional) – Currently does not have an impact. Default is True.

  • connected (bool, optional) – Whether to output only the connected part of the aperture mass statistics. Does not have an impact at the moment. Default is True.

  • dpix_innergrid (float, optional) – Pixel size for a rough reconstruction of the angular mask. Used to preselect aperture centers in the interior of the survey. Default is 2.

Returns

Currently does not return any value.

Return type

None

_getindex(order, mode, zcombi)[source]
_buildargs(cat, args_innergrid, dotomo, indR, forfunc='Equal')[source]
_nzcombis_tot(nbinsz, dotomo)[source]
_nzcombis_order(order, nbinsz, dotomo)[source]
_cumnzcombis_order(order, nbinsz, dotomo)[source]
genzcombi(zs, nbinsz=None)[source]

Returns index of tomographic bin combination of Map^n output.

Parameters

  • zs (list of integers) – Target combination of tomographic redshifts ([z1, …, zk]).

  • nbinsz (int, optional) – The number of tomographic bins in the computation of Map^n. If not set, reverts to corresponding class attribute.

Returns

zind_flat – Index of flattened Map^k(z1,…,zk) datavector in global output.

Return type

int

getmap(indR, cat, dotomo=True)[source]

Computes various maps that are part of the basis of the Map^n estimator.

Parameters

  • indR (int) – Index of aperture radius for which maps are computed.

  • cat (orpheus.SpinTracerCatalog) – The catalog instance to be processed.

  • dotomo (bool, optional) – Whether the tomographic information in cat should be used for the map construction.

Returns

counts – Aperture number counts.

Return type

ndarray

__annotations__ = {}
__module__ = 'orpheus.direct'