git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/Documentation/DSP_Lib/html/group__clarke.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <title>CMSIS DSP Software Library: Vector Clarke Transform</title>
   6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   7 <link href="search/search.css" rel="stylesheet" type="text/css"/>
   8 <script type="text/javaScript" src="search/search.js"></script>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 </head>
  11 <body onload='searchBox.OnSelectItem(0);'>
  12 <!-- Generated by Doxygen 1.7.2 -->
  13 <script type="text/javascript"><!--
  14 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  15 --></script>
  16 <div class="navigation" id="top">
  17   <div class="tabs">
  18     <ul class="tablist">
  19       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  20       <li><a href="modules.html"><span>Modules</span></a></li>
  21       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  22       <li><a href="files.html"><span>Files</span></a></li>
  23       <li><a href="examples.html"><span>Examples</span></a></li>
  24       <li id="searchli">
  25         <div id="MSearchBox" class="MSearchBoxInactive">
  26         <span class="left">
  27           <img id="MSearchSelect" src="search/mag_sel.png"
  28                onmouseover="return searchBox.OnSearchSelectShow()"
  29                onmouseout="return searchBox.OnSearchSelectHide()"
  30                alt=""/>
  31           <input type="text" id="MSearchField" value="Search" accesskey="S"
  32                onfocus="searchBox.OnSearchFieldFocus(true)"
  33                onblur="searchBox.OnSearchFieldFocus(false)"
  34                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  35           </span><span class="right">
  36             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  37           </span>
  38         </div>
  39       </li>
  40     </ul>
  41   </div>
  42 </div>
  43 <div class="header">
  44   <div class="summary">
  45 <a href="#func-members">Functions</a>  </div>
  46   <div class="headertitle">
  47 <h1>Vector Clarke Transform<br/>
  48 <small>
  49 [<a class="el" href="group__group_controller.html">Controller Functions</a>]</small>
  50 </h1>  </div>
  51 </div>
  52 <div class="contents">
  53 <table class="memberdecls">
  54 <tr><td colspan="2"><h2><a name="func-members"></a>
  55 Functions</h2></td></tr>
  56 <tr><td class="memItemLeft" align="right" valign="top">static __INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__clarke.html#ga2b4ebec76215e1277c970c269ffdbd76">arm_clarke_f32</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> Ia, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> Ib, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pIalpha, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pIbeta)</td></tr>
  57 <tr><td class="memItemLeft" align="right" valign="top">static __INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__clarke.html#ga7fd106ca8d346a2a472842e0656014c1">arm_clarke_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Ia, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Ib, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pIalpha, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pIbeta)</td></tr>
  58 </table>
  59 <hr/><a name="_details"></a><h2>Detailed Description</h2>
  60 <p>Forward Clarke transform converts the instantaneous stator phases into a two-coordinate time invariant vector. Generally the Clarke transform uses three-phase currents <code>Ia, Ib and Ic</code> to calculate currents in the two-phase orthogonal stator axis <code>Ialpha</code> and <code>Ibeta</code>. When <code>Ialpha</code> is superposed with <code>Ia</code> as shown in the figure below </p>
  61 <div align="center">
  62 <img src="clarke.gif" alt="clarke.gif"/>
  63 <p><strong>Stator current space vector and its components in (a,b).</strong></p></div>
  64 <p> and <code>Ia + Ib + Ic = 0</code>, in this condition <code>Ialpha</code> and <code>Ibeta</code> can be calculated using only <code>Ia</code> and <code>Ib</code>.</p>
  65 <p>The function operates on a single sample of data and each call to the function returns the processed output. The library provides separate functions for Q31 and floating-point data types. </p>
  66 <dl class="user"><dt><b>Algorithm</b></dt><dd><div align="center">
  67 <img src="clarkeFormula.gif" alt="clarkeFormula.gif"/>
  68 </div>
  69  where <code>Ia</code> and <code>Ib</code> are the instantaneous stator phases and <code>pIalpha</code> and <code>pIbeta</code> are the two coordinates of time invariant vector. </dd></dl>
  70 <dl class="user"><dt><b>Fixed-Point Behavior</b></dt><dd>Care must be taken when using the Q31 version of the Clarke transform. In particular, the overflow and saturation behavior of the accumulator used must be considered. Refer to the function specific documentation below for usage guidelines. </dd></dl>
  71 <hr/><h2>Function Documentation</h2>
  72 <a class="anchor" id="ga2b4ebec76215e1277c970c269ffdbd76"></a><!-- doxytag: member="arm_math.h::arm_clarke_f32" ref="ga2b4ebec76215e1277c970c269ffdbd76" args="(float32_t Ia, float32_t Ib, float32_t *pIalpha, float32_t *pIbeta)" -->
  73 <div class="memitem">
  74 <div class="memproto">
  75       <table class="memname">
  76         <tr>
  77           <td class="memname">static __INLINE void arm_clarke_f32 </td>
  78           <td>(</td>
  79           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td>
  80           <td class="paramname"> <em>Ia</em>, </td>
  81         </tr>
  82         <tr>
  83           <td class="paramkey"></td>
  84           <td></td>
  85           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td>
  86           <td class="paramname"> <em>Ib</em>, </td>
  87         </tr>
  88         <tr>
  89           <td class="paramkey"></td>
  90           <td></td>
  91           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  92           <td class="paramname"> <em>pIalpha</em>, </td>
  93         </tr>
  94         <tr>
  95           <td class="paramkey"></td>
  96           <td></td>
  97           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  98           <td class="paramname"> <em>pIbeta</em>&#160;</td>
  99         </tr>
 100         <tr>
 101           <td></td>
 102           <td>)</td>
 103           <td></td><td><code> [static]</code></td>
 104         </tr>
 105       </table>
 106 </div>
 107 <div class="memdoc">
 108
 109 <p>Floating-point Clarke transform. </p>
 110 <dl><dt><b>Parameters:</b></dt><dd>
 111   <table class="params">
 112     <tr><td class="paramdir">[in]</td><td class="paramname">Ia</td><td>input three-phase coordinate <code>a</code> </td></tr>
 113     <tr><td class="paramdir">[in]</td><td class="paramname">Ib</td><td>input three-phase coordinate <code>b</code> </td></tr>
 114     <tr><td class="paramdir">[out]</td><td class="paramname">*pIalpha</td><td>points to output two-phase orthogonal vector axis alpha </td></tr>
 115     <tr><td class="paramdir">[out]</td><td class="paramname">*pIbeta</td><td>points to output two-phase orthogonal vector axis beta </td></tr>
 116   </table>
 117   </dd>
 118 </dl>
 119 <dl class="return"><dt><b>Returns:</b></dt><dd>none. </dd></dl>
 120
 121 <p>Definition at line <a class="el" href="arm__math_8h_source.html#l04905">4905</a> of file <a class="el" href="arm__math_8h_source.html">arm_math.h</a>.</p>
 122
 123 </div>
 124 </div>
 125 <a class="anchor" id="ga7fd106ca8d346a2a472842e0656014c1"></a><!-- doxytag: member="arm_math.h::arm_clarke_q31" ref="ga7fd106ca8d346a2a472842e0656014c1" args="(q31_t Ia, q31_t Ib, q31_t *pIalpha, q31_t *pIbeta)" -->
 126 <div class="memitem">
 127 <div class="memproto">
 128       <table class="memname">
 129         <tr>
 130           <td class="memname">static __INLINE void arm_clarke_q31 </td>
 131           <td>(</td>
 132           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td>
 133           <td class="paramname"> <em>Ia</em>, </td>
 134         </tr>
 135         <tr>
 136           <td class="paramkey"></td>
 137           <td></td>
 138           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td>
 139           <td class="paramname"> <em>Ib</em>, </td>
 140         </tr>
 141         <tr>
 142           <td class="paramkey"></td>
 143           <td></td>
 144           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
 145           <td class="paramname"> <em>pIalpha</em>, </td>
 146         </tr>
 147         <tr>
 148           <td class="paramkey"></td>
 149           <td></td>
 150           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
 151           <td class="paramname"> <em>pIbeta</em>&#160;</td>
 152         </tr>
 153         <tr>
 154           <td></td>
 155           <td>)</td>
 156           <td></td><td><code> [static]</code></td>
 157         </tr>
 158       </table>
 159 </div>
 160 <div class="memdoc">
 161
 162 <p>Clarke transform for Q31 version. </p>
 163 <dl><dt><b>Parameters:</b></dt><dd>
 164   <table class="params">
 165     <tr><td class="paramdir">[in]</td><td class="paramname">Ia</td><td>input three-phase coordinate <code>a</code> </td></tr>
 166     <tr><td class="paramdir">[in]</td><td class="paramname">Ib</td><td>input three-phase coordinate <code>b</code> </td></tr>
 167     <tr><td class="paramdir">[out]</td><td class="paramname">*pIalpha</td><td>points to output two-phase orthogonal vector axis alpha </td></tr>
 168     <tr><td class="paramdir">[out]</td><td class="paramname">*pIbeta</td><td>points to output two-phase orthogonal vector axis beta </td></tr>
 169   </table>
 170   </dd>
 171 </dl>
 172 <dl class="return"><dt><b>Returns:</b></dt><dd>none.</dd></dl>
 173 <p><b>Scaling and Overflow Behavior:</b> </p>
 174 <dl class="user"><dt><b></b></dt><dd>The function is implemented using an internal 32-bit accumulator. The accumulator maintains 1.31 format by truncating lower 31 bits of the intermediate multiplication in 2.62 format. There is saturation on the addition, hence there is no risk of overflow. </dd></dl>
 175
 176 <p>Definition at line <a class="el" href="arm__math_8h_source.html#l04934">4934</a> of file <a class="el" href="arm__math_8h_source.html">arm_math.h</a>.</p>
 177
 178 </div>
 179 </div>
 180 </div>
 181 <!--- window showing the filter options -->
 182 <div id="MSearchSelectWindow"
 183      onmouseover="return searchBox.OnSearchSelectShow()"
 184      onmouseout="return searchBox.OnSearchSelectHide()"
 185      onkeydown="return searchBox.OnSearchSelectKey(event)">
 186 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</a></div>
 187
 188 <!-- iframe showing the search results (closed by default) -->
 189 <div id="MSearchResultsWindow">
 190 <iframe src="" frameborder="0"
 191         name="MSearchResults" id="MSearchResults">
 192 </iframe>
 193 </div>
 194
 195 <hr class="footer"/><address class="footer"><small>Generated on Fri Jul 15 2011 13:16:21 for CMSIS DSP Software Library by&#160;
 196 <a href="http://www.doxygen.org/index.html">
 197 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 198 </body>
 199 </html>