Skip to main content
`Ctrl`+`K`

# aequilibrae.paths.TransitAssignmentResults

class aequilibrae.paths.TransitAssignmentResults

  Assignment result holder for a single `Transit`

  __init__()

  Methods

  `__init__`() |
  `get_load_results`() | Translates the assignment results from the graph format into the network format
  `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
  `set_cores`(cores) | Sets number of cores (threads) to be used in computation

  get_load_results() → DataFrame

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

    Returns:

      dataset (`pd.DataFrame`): DataFrame data with the transit class assignment results

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

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

    Arguments:

      graph (`TransitGraph`): Needs to have been set with number of centroids

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

  reset() → None

    Resets object to prepared and pre-computation state

  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