pyhgf.model.get_couplings#

pyhgf.model.get_couplings(value_parents, volatility_parents, value_children, volatility_children)[source]#

Transform coupling parameter into tuple of indexes and strenghts.

Parameters:

  • value_parents (tuple | list | int | None) – The value parents, given as a node index, a list of indexes, or a tuple of indexes and coupling strengths.

  • volatility_parents (tuple | list | int | None) – The volatility parents, in the same format as value_parents.

  • value_children (tuple | list | int | None) – The value children, in the same format as value_parents.

  • volatility_children (tuple | list | int | None) – The volatility children, in the same format as value_parents.

Returns:

A tuple of (indexes, strengths) pairs for the value parents, volatility parents, value children and volatility children, in that order.

Return type:

couplings