Analyze

The Analyze submodule of polaris-studio.

• KPI
  • Adding new metrics
  • Standard cached metrics
  • Comparing metrics
  • API Overview
    • polaris.analyze.result_kpis.ResultKPIs
      • ResultKPIs
        • ResultKPIs.__init__()
        • ResultKPIs.result_time_step
        • ResultKPIs.__init__()
        • ResultKPIs.from_iteration()
        • ResultKPIs.from_dir()
        • ResultKPIs.from_args()
        • ResultKPIs.cache_all_available_metrics()
        • ResultKPIs.available_metrics()
        • ResultKPIs.close()
        • ResultKPIs.get_kpi_value()
        • ResultKPIs.get_cached_kpi_value()
        • ResultKPIs.has_cached_kpi()
        • ResultKPIs.cached_metrics()
        • ResultKPIs.metric_summary()
        • ResultKPIs.metric_gaps()
        • ResultKPIs.one_value()
        • ResultKPIs.metric_population()
        • ResultKPIs.metric_num_adults()
        • ResultKPIs.metric_num_employed()
        • ResultKPIs.metric_num_persons_by_age_band_5()
        • ResultKPIs.metric_num_persons_by_age_band_10()
        • ResultKPIs.metric_num_hh()
        • ResultKPIs.metric_num_hh_by_hh_size()
        • ResultKPIs.metric_tts()
        • ResultKPIs.metric_distance_by_act_type()
        • ResultKPIs.metric_planned_modes()
        • ResultKPIs.metric_executed_modes()
        • ResultKPIs.metric_mode_shares()
        • ResultKPIs.metric_executed_activity_mode_share_by_income()
        • ResultKPIs.metric_activity_start_distribution()
        • ResultKPIs.metric_activity_rate_distribution()
        • ResultKPIs.metric_activity_duration_distribution()
        • ResultKPIs.metric_vmt_vht()
        • ResultKPIs.metric_ev_charging()
        • ResultKPIs.metric_vmt_vht_by_link()
        • ResultKPIs.load_link_types()
        • ResultKPIs.metric_activity_distances()
        • ResultKPIs.metric_vehicle_technology()
        • ResultKPIs.metric_tnc_request_stats()
        • ResultKPIs.metric_tnc_trip_stats()
        • ResultKPIs.metric_tnc_stats()
        • ResultKPIs.metric_avo_by_tnc_operator()
        • ResultKPIs.metric_road_pricing()
        • ResultKPIs.metric_transit_boardings()
        • ResultKPIs.network_gaps_by_x()
        • ResultKPIs.metric_network_gaps_by_link_type()
        • ResultKPIs.metric_network_gaps_by_hour()
        • ResultKPIs.metric_skim_stats()
        • ResultKPIs.metric_rmse_vs_observed()
        • ResultKPIs.metric_calibration_act_gen()
        • ResultKPIs.metric_calibration_mode_share()
        • ResultKPIs.metric_calibration_timing()
        • ResultKPIs.metric_calibration_destination()
        • ResultKPIs.metric_trip_length_distribution()
        • ResultKPIs.metric_activity_start_time_distributions()
        • ResultKPIs.metric_traffic_cumulative_gap()
    • polaris.analyze.kpi_comparator.KpiComparator
      • KpiComparator
        • KpiComparator.__init__()
        • KpiComparator.__init__()
        • KpiComparator.add_run()
        • KpiComparator.has_run()
        • KpiComparator.dump_to_csvs()
        • KpiComparator.plot_everything()
        • KpiComparator.available_plots()
        • KpiComparator.plot_mode_share()
        • KpiComparator.plot_population()
        • KpiComparator.plot_congestion_pricing()
        • KpiComparator.plot_transit()
        • KpiComparator.add_iter()
        • KpiComparator.across_iterations()
        • KpiComparator.plot_act_dist()
        • KpiComparator.plot_vmt()
        • KpiComparator.plot_vehicle_connectivity()
        • KpiComparator.plot_vmt_by_link_type()
        • KpiComparator.plot_gaps()
        • KpiComparator.plot_multiple_gaps()
        • KpiComparator.plot_pax_in_network()
        • KpiComparator.plot_cpu_mem()
        • KpiComparator.plot_network_gaps()
        • KpiComparator.plot_skim_stats()
        • KpiComparator.plot_trip_length_distributions()
        • KpiComparator.plot_activity_start_time_distributions()
        • KpiComparator.plot_tnc()
        • KpiComparator.plot_rmse_vs_observed()
        • KpiComparator.plot_calibration_for_activity_generation()
        • KpiComparator.plot_calibration_for_mode_share()
        • KpiComparator.plot_calibration_timing()
        • KpiComparator.plot_calibration_destination()
• Post-processing
  • Transit