GWForge.population_fisher.compare

Fit a population block to the injections and report what came back.

Attributes

BLOCK_ROLE

Functions

compare_block(model, block, injections[, free_parameters])

Fit one block to the injections and format the comparison.

Module Contents

GWForge.population_fisher.compare.BLOCK_ROLE[source]
GWForge.population_fisher.compare.compare_block(model, block, injections, free_parameters=None)[source]

Fit one block to the injections and format the comparison.

Parameters:

  • model (GWForge.population_fisher.base.PopulationModel) – Fitted in place: on return model.fiducial holds the fitted values, so the Fisher that follows is evaluated at them.

  • block (str) – "mass", "redshift" or "spin".

  • injections (dict) – Every injection, detected or not.

  • free_parameters (sequence of str or None) –

    Vary only these, holding the rest at their config values. Defaults to every parameter the model has.

    The driver passes the Fisher’s free list, so the fit varies exactly what the forecast will vary. That matters when a parameter is pinned because the data cannot constrain it: delta_m for a taper narrower than the sampling grid has no maximum to find, so an optimiser given it rails against whichever bound it was handed and drags the correlated parameters with it. Since the catalogue was generated here, such parameters are known exactly and there is nothing to fit.

Returns:

Lines for the summary file.

Return type:

list of str