9.5.3. aequilibrae.SkimResults¶
-
class
aequilibrae.
SkimResults
¶ Bases:
object
Network skimming result holder
from aequilibrae.project import Project from aequilibrae.paths.results import SkimResults proj = Project() proj.load('path/to/project.sqlite') proj.network.build_graphs() # Mode c is car in this project car_graph = proj.network.graphs['c'] # minimize travel time car_graph.set_graph('free_flow_travel_time') # Skims travel time and distance car_graph.set_skimming(['free_flow_travel_time', 'distance']) res = SkimResults() res.prepare(car_graph) res.compute_skims() res.skims.export('path/to/matrix.aem')
-
__init__
()¶ Initialize self. See help(type(self)) for accurate signature.
Methods
__init__
()Initialize self.
Computes the skims as set
prepare
(graph)Prepares the object with dimensions corresponding to the graph objects
reset
()Resets object to prepared and pre-computation state
set_cores
(cores)Sets number of cores (threads) to be used in computation
-
__init__
() Initialize self. See help(type(self)) for accurate signature.
-
prepare
(graph)¶ Prepares the object with dimensions corresponding to the graph objects
- Args:
graph (
Graph
): Needs to have been set with number of centroids and list of skims (if any)
-
set_cores
(cores: int) → None¶ Sets number of cores (threads) to be used in computation
Value of zero sets number of threads to all available in the system, while negative values indicate the number of threads to be left out of the computational effort.
Resulting number of cores will be adjusted to a minimum of zero or the maximum available in the system if the inputs result in values outside those limits
- Args:
cores (
int
): Number of cores to be used in computation
-
reset
() → None¶ Resets object to prepared and pre-computation state
-
compute_skims
() → None¶ Computes the skims as set
-