completeness#

anri.index.completeness(table, eta, om, ok, ring_j, tol_e, tol_o, om0, b_e, b_o, n_e, n_o)[source]#

Fraction of each orientation’s valid predictions with a lit bin within its own tolerance box.

Parameters:

  • table (Array) – Summed-area table of the lit map, from anri.index.lit_table()

  • eta (Array) – [Nq, Nj] predictions, from predict() (with any extra cuts applied to ok)

  • om (Array) – [Nq, Nj] predictions, from predict() (with any extra cuts applied to ok)

  • ok (Array) – [Nq, Nj] predictions, from predict() (with any extra cuts applied to ok)

  • ring_j (Array) – [Nj] ring of each prediction

  • tol_e (Array) – [Nq, Nj] tolerances (degrees), e.g. from match_tolerances(); tol_e below 360

  • tol_o (Array) – [Nq, Nj] tolerances (degrees), e.g. from match_tolerances(); tol_e below 360

  • om0 (float) – The lit map’s first omega bin edge and bin widths

  • b_e (float) – The lit map’s first omega bin edge and bin widths

  • b_o (float) – The lit map’s first omega bin edge and bin widths

  • n_e (int) – The lit map’s numbers of eta and omega bins

  • n_o (int) – The lit map’s numbers of eta and omega bins

Returns:

completeness, n_valid (jax.Array) – [Nq] each