v_sim.PairDistribution

Fields

Name	Type	Access	Description
ele1	v_sim.Element	r/w	one v_sim.Element.
ele2	v_sim.Element	r/w	one v_sim.Element.
histo	int	r/w	an array containing the distribution ;
initValue	float	r/w	the initial distance value (usualy 0) ;
nNodesEle1	int	r/w	the number of nodes used during the computation ;
nNodesEle2	int	r/w	idem for v_sim.Element 2.
nValues	int	r/w	the size of the array ;
stepValue	float	r/w	the step increase in distance at each value ;

Methods

getNextPick (startStopId, integral, max, posMax)

Details

class v_sim.PairDistribution

This structure stores for a given pair, the distance distribution on a given range [initValue;`nValues` * stepValue[.

getNextPick(startStopId, integral, max, posMax)

Parameters:

• startStopId (int) – two ids.

• integral (int) – a location for a int value, can be None.

• max (int) – a location to store the value ;

• posMax (int) – a location to store the position of the pick.

Returns:

True if a pick is found.

Return type:

bool

Try to find the next pick in the distribution. A pick is a group of consecutive non-null values, with a significant integral. On enter, startStopId contains the span to look into for the pick, and on output, it contains the span of the pick itself.

New in version 3.6.