aequilibrae.paths.AssignmentResults

class aequilibrae.paths.AssignmentResults

Assignment result holder for a single TrafficClass with multiple user classes

__init__()

Methods

__init__()
get_graph_to_network_mapping()
get_load_results()	Translates the assignment results from the graph format into the network format
get_sl_results()
prepare(graph, matrix)	Prepares the object with dimensions corresponding to the assignment matrix and graph objects
reset()	Resets object to prepared and pre-computation state
save_to_disk([file_name, output])	Function to write to disk all outputs computed during assignment.
set_cores(cores)	Sets number of cores (threads) to be used in computation
total_flows()	Totals all link flows for this class into a single link load

prepare(graph: Graph, matrix: AequilibraeMatrix) → None

Prepares the object with dimensions corresponding to the assignment matrix and graph objects

Arguments:

graph (Graph): Needs to have been set with number of centroids and list of skims (if any)

matrix (AequilibraeMatrix): Matrix properly set for computation with matrix.computational_view(:obj:`list`)

reset() → None

Resets object to prepared and pre-computation state

total_flows() → None

Totals all link flows for this class into a single link load

Results are placed into total_link_loads class member

get_graph_to_network_mapping()

get_load_results() → AequilibraeData

Translates the assignment results from the graph format into the network format

Returns:

dataset (AequilibraeData): AequilibraE data with the traffic class assignment results

get_sl_results() → AequilibraeData

save_to_disk(file_name=None, output='loads') → None

Function to write to disk all outputs computed during assignment.

Deprecated since version 0.7.0.

Arguments:

file_name (str): Name of the file, with extension. Valid extensions are: [‘aed’, ‘csv’, ‘sqlite’]

output (str, Optional): Type of output (‘loads’, ‘path_file’). Defaults to ‘loads’

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

Arguments:

cores (int): Number of cores to be used in computation