|
437 | 437 | </dl> |
438 | 438 | <dl class="py method"> |
439 | 439 | <dt class="sig sig-object py" id="suboptimumg.compsim.custom_run.CustomRun.comparison_track_overlays"> |
440 | | -<span class="sig-name descname"><span class="pre">comparison_track_overlays</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sim_var</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_var</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lat</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">long</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_coast</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rotate_by_deg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_matching_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">font_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layout_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colorbar_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/suboptimumg/compsim/custom_run.html#CustomRun.comparison_track_overlays"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#suboptimumg.compsim.custom_run.CustomRun.comparison_track_overlays" title="Link to this definition">#</a></dt> |
| 440 | +<span class="sig-name descname"><span class="pre">comparison_track_overlays</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sim_var</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_var</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lat</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">long</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_coast</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rotate_by_deg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_matching_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_raw_data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interpolate_gaps</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">font_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layout_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colorbar_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/suboptimumg/compsim/custom_run.html#CustomRun.comparison_track_overlays"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#suboptimumg.compsim.custom_run.CustomRun.comparison_track_overlays" title="Link to this definition">#</a></dt> |
441 | 441 | <dd><p>Overlay plot comparing simulation results to real-world data on the track layout.</p> |
442 | 442 | <dl class="field-list simple"> |
443 | 443 | <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
|
449 | 449 | <li><p><strong>use_coast</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to use coasting results from the simulation. Default is True</p></li> |
450 | 450 | <li><p><strong>rotate_by_deg</strong> (<em>float</em><em>, </em><em>optional</em>) – Degrees to rotate the track plot for better visualization. Default is 0.0</p></li> |
451 | 451 | <li><p><strong>show_matching_info</strong> (<em>bool</em><em>, </em><em>optional</em>) – If True, print matching information during GPS to track matching. Default is False</p></li> |
| 452 | +<li><p><strong>display_raw_data</strong> (<em>bool</em><em>, </em><em>optional</em>) – If True, plot the projected GPS data rather than the difference. Default is False</p></li> |
452 | 453 | <li><p><strong>font_config</strong> (<a class="reference internal" href="suboptimumg.plotting.plotting_constants.html#suboptimumg.plotting.plotting_constants.FontConfig" title="suboptimumg.plotting.plotting_constants.FontConfig"><em>FontConfig</em></a><em> | </em><em>None</em><em>, </em><em>optional</em>)</p></li> |
453 | 454 | <li><p><strong>layout_config</strong> (<a class="reference internal" href="suboptimumg.plotting.plotting_constants.html#suboptimumg.plotting.plotting_constants.LayoutConfig" title="suboptimumg.plotting.plotting_constants.LayoutConfig"><em>LayoutConfig</em></a><em> | </em><em>None</em><em>, </em><em>optional</em>)</p></li> |
454 | 455 | <li><p><strong>colorbar_config</strong> (<a class="reference internal" href="suboptimumg.plotting.plotting_constants.html#suboptimumg.plotting.plotting_constants.ColorbarConfig" title="suboptimumg.plotting.plotting_constants.ColorbarConfig"><em>ColorbarConfig</em></a><em> | </em><em>None</em><em>, </em><em>optional</em>)</p></li> |
| 456 | +<li><p><strong>interpolate_gaps</strong> (<em>bool</em>)</p></li> |
455 | 457 | </ul> |
456 | 458 | </dd> |
457 | 459 | <dt class="field-even">Return type<span class="colon">:</span></dt> |
|
0 commit comments