PyMacroAdjustmentPlugin.MacroAdjustmentExperiment¶

class MacroAdjustmentExperiment¶

Synopsis¶

Methods¶

def __init__()
def addCongestedSection()
def getGradientDescentIterations()
def getOuterIterations()
def getOutput()
def getParams()
def getTargetR2()
def getTargetSlopeDev()
def isCongestedSection()
def readOutput()
def setDefaultParamsForAllUserClasses()
def setGradientDescentIterations()
def setOuterIterations()
def setOutput()
def setParams()
def setTargetR2()
def setTargetSlopeDev()
def setTripMatrix()
def setTripMatrixCentroidGrouping()
def setTripMatrixReliability()
def syncUserClassesDemand()
def tripMatrix()
def tripMatrixCentroidGrouping()
def tripMatrixReliability()

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

Detailed Description¶

A Static OD Adjustment Experiment. It holds variables that affect the internal models. They can be changed to calibrate a model.

An Experiment is part of one, and only one, Scenario ( MacroScenario ).

__init__()¶

addCongestedSection(congestedSection)¶

Parameters:: congestedSection – GKSection

Collects all congested sections for all user classes

getGradientDescentIterations()¶

Return type:: int

getOuterIterations()¶

Return type:: int

getOutput()¶

Return type:: MacroAdjustmentOutput

getParams()¶

Return type:: MacroAdjustmentScenarioParams

getTargetR2()¶

Return type:: float

getTargetSlopeDev()¶

Return type:: float

isCongestedSection(section)¶

Parameters:: section – GKSection
Return type:: bool

readOutput(iFileName)¶

Parameters:: iFileName – str
Return type:: bool

setDefaultParamsForAllUserClasses([alpha=1.0f[, tripLengthDistributionElasticity=0.5f]])¶

Parameters:

alpha – float
tripLengthDistributionElasticity – float

Set default macro adjustment parameters for each user class in the scenario’s demand

setGradientDescentIterations(value)¶

Parameters:: value – int

setOuterIterations(value)¶

Parameters:: value – int

setOutput(iOutput)¶

Parameters:: iOutput – MacroAdjustmentOutput

setParams(params)¶

Parameters:: params – MacroAdjustmentScenarioParams

setTargetR2(targetR2)¶

Parameters:: targetR2 – float

setTargetSlopeDev(targetSlopeDev)¶

Parameters:: targetSlopeDev – float

setTripMatrix(iMatrix)¶

Parameters:: iMatrix – GKODMatrix

Sets the additional goal Trip Matrix for the static OD adjustment. Data loaded from params.

See also

tripMatrix()

setTripMatrixCentroidGrouping(iGroup)¶

Parameters:: iGroup – GKGroup

Sets the Grouping Category of Centroids used to aggregate zones for Trip Matrix processing. Data loaded from params.

See also

tripMatrixCentroidGrouping()

setTripMatrixReliability(iFactor)¶

Parameters:: iFactor – float

Sets the Trip Matrix Reliability factor for the static OD adjustment. Data loaded from params.

See also

tripMatrixReliability()

syncUserClassesDemand()¶

Return type:: bool

Syncronize demand user classes with the scenario user classes. It will return true if the syncronisation was successful and false if the run needs to be stopped in order to verify some parameters.

tripMatrix()¶

Return type:: GKODMatrix

Returns the additional goal Trip Matrix for the static OD adjustment. Data stored in params.

See also

setTripMatrix()

tripMatrixCentroidGrouping()¶

Return type:: GKGroup

Returns the Grouping Category of Centroids used to aggregate zones for Trip Matrix processing. Data stored in params.

See also

setTripMatrixCentroidGrouping()

tripMatrixReliability()¶

Return type:: float

Returns the Trip Matrix Reliability factor for the static OD adjustment. Data stored in params.

See also

setTripMatrixReliability()