NapnEqual: Nth order equal-scale aperture counts statistics

class orpheus.Direct_NapnEqual(order_max, Rmin, Rmax, field='scalar', filter_form='C02', ap_weights='Identity', **kwargs)[source]

Bases: DirectEstimator

Compute direct estimator for equal-scale aperture counts 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='scalar', filter_form='C02', ap_weights='Identity', **kwargs)[source]
process(cat, dotomo=True, Nbar_policy=1, 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.

  • Nbar_policy (int, optional) –

    What normalization to use:

    0 : Use local Nbar for normalization 1 : Use global Nbar for normalization 2 : No Nbar for normalization

    Default is 1.

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

  • 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, Nbar_policy, indR, forfunc='Equal')[source]
_nzcombis_tot(nbinsz, dotomo)[source]
__annotations__ = {}
__module__ = 'orpheus.direct'
_nzcombis_order(order, nbinsz, dotomo)[source]
_cumnzcombis_order(order, nbinsz, dotomo)[source]
genzcombi(zs, nbinsz=None)[source]
getnap(indR, cat, dotomo=True)[source]

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