PyANGKernel.GKExperimentODParameters

class GKExperimentODParameters

This class holds route choice parameters for each Origin/Destination pair.

Details

Route Choice models depend on a series of parameters for each Origin and Destination, which can be defined using this class. It can define parameters for the following route choice models: - Binomial - Proportional - Logit - C-Logit

More information regarding these Route Choice models can be found in the manual.

Synopsis

Methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

__init__()
__init__(origin, destination)
Parameters:
getAlfaFactor()
Return type:

float

Gets the proportional parameter.

getBetaFactor()
Return type:

float

Gets the Beta parameter for the C-Logit function.

getDestination()
Return type:

GKCentroid

Gets the destination centroid.

getGammaFactor()
Return type:

float

Gets the Gamma parameter for the C-Logit function.

getOrigin()
Return type:

GKCentroid

Gets the origin centroid.

getProbability()
Return type:

float

Gets the binomial parameter.

getScaleFactor()
Return type:

float

Gets the scale factor for the Logit and C-Logits functions.

setAlfaFactor(alfa)
Parameters:

alfa – float

Sets the proportional parameter.

setBetaFactor(beta)
Parameters:

beta – float

Sets the Beta parameter for the C-Logit function.

setDestination(origin)
Parameters:

origin – GKCentroid

Sets the destination centroid.

setGammaFactor(gamma)
Parameters:

gamma – float

Sets the Gamma parameter for the C-Logit function.

setOrigin(origin)
Parameters:

origin – GKCentroid

Sets the origin centroid.

setProbability(p)
Parameters:

p – float

Sets the binomial parameter.

setScaleFactor(scale)
Parameters:

scale – float

Sets the scale factor for the Logit and C-Logits functions.