ranking_HM.maximization_info_from_pclists

Back to Module page

Summary

Returns information useful for maximize_over_groups

Signature

def maximization_info_from_pclists(pclists, incoherent_score_func = utils.incoherent_score)

Input variables

Name	Type	Default	Description
pclists			n_candidates x n_det x len(processedclist) array
incoherent_score_func		utils.incoherent_score	Function that accepts processedclists for trigger(s) and returns incoherent score(s) used for ranking

Output variables

Return annotation	Docstring type	Description
None		n_candidates x … array with t_H, t_L, .., incoherent score used for ranking, rho^2

Docstring

Returns information useful for maximize_over_groups
:param pclists: n_candidates x n_det x len(processedclist) array
:param incoherent_score_func:
    Function that accepts processedclists for trigger(s) and returns
    incoherent score(s) used for ranking
:return:
    n_candidates x ... array with
    t_H, t_L, .., incoherent score used for ranking, rho^2