travis/qtrocket2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
qtrocket2/docs/doxygen/html/classPlotter.html

334 lines
16 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QtRocket: Plotter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">QtRocket
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('classPlotter.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classPlotter-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Plotter Class Reference<span class="mlabels"><span class="mlabel abstract">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Abstract interface for plotting flight data.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Plotter_8h_source.html">Plotter.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Plotter:</div>
<div class="dyncontent">
<div class="center"><img src="classPlotter__inherit__graph.png" border="0" usemap="#aPlotter_inherit__map" alt="Inheritance graph"/></div>
<map name="aPlotter_inherit__map" id="aPlotter_inherit__map">
<area shape="rect" title="Abstract interface for plotting flight data." alt="" coords="38,5,103,33"/>
<area shape="rect" href="classMatplotlibPlotter.html" title="Matplotlib&#45;cpp implementation of the Plotter interface." alt="" coords="5,81,136,109"/>
<area shape="poly" title=" " alt="" coords="73,49,73,81,68,81,68,49"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a16c3e02fb889a4fb8218b20c6b5a12ee" id="r_a16c3e02fb889a4fb8218b20c6b5a12ee"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a16c3e02fb889a4fb8218b20c6b5a12ee">~Plotter</a> ()=default</td></tr>
<tr class="separator:a16c3e02fb889a4fb8218b20c6b5a12ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc6d4559aeb6bb57584bf84beb5a1b46" id="r_adc6d4559aeb6bb57584bf84beb5a1b46"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adc6d4559aeb6bb57584bf84beb5a1b46">plot2D</a> (const std::vector&lt; double &gt; &amp;xData, const std::vector&lt; double &gt; &amp;yData, const std::string &amp;title, const std::string &amp;xLabel, const std::string &amp;yLabel)=0</td></tr>
<tr class="memdesc:adc6d4559aeb6bb57584bf84beb5a1b46"><td class="mdescLeft">&#160;</td><td class="mdescRight">Plot a 2D line graph. <br /></td></tr>
<tr class="separator:adc6d4559aeb6bb57584bf84beb5a1b46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a897a38cfb07fc9c32ab5b78760e6fed0" id="r_a897a38cfb07fc9c32ab5b78760e6fed0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a897a38cfb07fc9c32ab5b78760e6fed0">addMarker</a> (double xValue, const std::string &amp;label)=0</td></tr>
<tr class="memdesc:a897a38cfb07fc9c32ab5b78760e6fed0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a vertical marker at a specific x-axis value. <br /></td></tr>
<tr class="separator:a897a38cfb07fc9c32ab5b78760e6fed0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18c94c381b1cdffd2f03e3291c9daa6b" id="r_a18c94c381b1cdffd2f03e3291c9daa6b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a18c94c381b1cdffd2f03e3291c9daa6b">plotPosVelAcc</a> (const std::vector&lt; double &gt; &amp;time, const std::vector&lt; double &gt; &amp;altitude, const std::vector&lt; double &gt; &amp;velocity, const std::vector&lt; double &gt; &amp;acceleration)=0</td></tr>
<tr class="memdesc:a18c94c381b1cdffd2f03e3291c9daa6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Plot altitude, velocity, and acceleration together on a single canvas. <br /></td></tr>
<tr class="separator:a18c94c381b1cdffd2f03e3291c9daa6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Abstract interface for plotting flight data. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a16c3e02fb889a4fb8218b20c6b5a12ee" name="a16c3e02fb889a4fb8218b20c6b5a12ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16c3e02fb889a4fb8218b20c6b5a12ee">&#9670;&#160;</a></span>~Plotter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Plotter::~Plotter </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel virtual">virtual</span><span class="mlabel default">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a897a38cfb07fc9c32ab5b78760e6fed0" name="a897a38cfb07fc9c32ab5b78760e6fed0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a897a38cfb07fc9c32ab5b78760e6fed0">&#9670;&#160;</a></span>addMarker()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Plotter::addMarker </td>
<td>(</td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>xValue</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>label</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a vertical marker at a specific x-axis value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">xValue</td><td>The x position (e.g., time in seconds) </td></tr>
<tr><td class="paramname">label</td><td>Text label to display near the marker </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classMatplotlibPlotter.html#a28a29f732ce721ac4eb32dfa266cedd1">MatplotlibPlotter</a>.</p>
</div>
</div>
<a id="adc6d4559aeb6bb57584bf84beb5a1b46" name="adc6d4559aeb6bb57584bf84beb5a1b46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc6d4559aeb6bb57584bf84beb5a1b46">&#9670;&#160;</a></span>plot2D()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Plotter::plot2D </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; double &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>xData</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; double &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>yData</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>title</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>xLabel</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>yLabel</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Plot a 2D line graph. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">xData</td><td>Vector of x-axis values (e.g., time) </td></tr>
<tr><td class="paramname">yData</td><td>Vector of y-axis values (e.g., altitude) </td></tr>
<tr><td class="paramname">title</td><td>Plot title </td></tr>
<tr><td class="paramname">xLabel</td><td>Label for x-axis </td></tr>
<tr><td class="paramname">yLabel</td><td>Label for y-axis </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classMatplotlibPlotter.html#a2f06fef0a2bd9a918522d111d3021489">MatplotlibPlotter</a>.</p>
</div>
</div>
<a id="a18c94c381b1cdffd2f03e3291c9daa6b" name="a18c94c381b1cdffd2f03e3291c9daa6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18c94c381b1cdffd2f03e3291c9daa6b">&#9670;&#160;</a></span>plotPosVelAcc()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Plotter::plotPosVelAcc </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; double &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>time</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; double &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>altitude</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; double &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>velocity</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; double &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>acceleration</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Plot altitude, velocity, and acceleration together on a single canvas. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">time</td><td>Time points </td></tr>
<tr><td class="paramname">altitude</td><td>Altitude (Z position) </td></tr>
<tr><td class="paramname">velocity</td><td>Vertical velocity </td></tr>
<tr><td class="paramname">acceleration</td><td>Vertical acceleration </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classMatplotlibPlotter.html#ac5761e936fa12c8039779e65e068c3ae">MatplotlibPlotter</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/plotting/<a class="el" href="Plotter_8h_source.html">Plotter.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classPlotter.html">Plotter</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink