Selection Function API

Selection Function API#

class CHIMERA.selection_function.selection_function(theta_inj_det: theta_inj_det, N_inj: int, N_eff: Number | None = 5.0)#

Bases: object

A class to estimate GW selection effects, that is the fraction \(\xi(\lambda)\) of detected injections drawn from a population model.

Parameters:

  • inj_data (Dict[str, jnp.ndarray]) – Injected data, typically contains the parameters used for injection (e.g., luminosity distances, masses).

  • inj_prior (jnp.ndarray) – Prior probabilities for the injected data.

  • N_inj (int) – Total number of generated injections.

  • population (object) – A CHIMERA.population object.

  • neff_inj_min (Optional[Number], default=5) – Minimum effective number of injections, used for filtering the completeness factor.

Class Attributes:

  • check_Neff (bool): A flag indicating whether the minimum effective number of injections (neff_inj_min) is specified.

  • Tobs (int): Observation time.

N_exp(pop_lambdas)#

Estimates the number of expected detected events of the population.

Contents