520 lines
26 KiB
HTML
520 lines
26 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>PEARL Procedures: pearl-vector-operations.ipf File 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>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
</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>
|
|
<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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">PEARL Procedures
|
|
 <span id="projectnumber">rev-distro-2.1.1-1-gf419e92-dirty</span>
|
|
</div>
|
|
<div id="projectbrief">Igor procedures for the analysis of PEARL data</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</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">
|
|
$(document).ready(function(){initNavTree('pearl-vector-operations_8ipf.html','');});
|
|
</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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#namespaces">Namespaces</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">pearl-vector-operations.ipf File Reference<div class="ingroups"><a class="el" href="group___arpes_package.html">ARPES package</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>basic vector geometry operations.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><a href="pearl-vector-operations_8ipf_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
|
|
Namespaces</h2></td></tr>
|
|
<tr class="memitem:namespace_pearl_vector_operations"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_pearl_vector_operations.html">PearlVectorOperations</a></td></tr>
|
|
<tr class="memdesc:namespace_pearl_vector_operations"><td class="mdescLeft"> </td><td class="mdescRight">basic vector geometry operations. <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ac579a92f012f0d0ef7b8f097e1c8b3c7"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-vector-operations_8ipf.html#ac579a92f012f0d0ef7b8f097e1c8b3c7">rotate2d_x</a> (variable xx, variable yy, variable angle)</td></tr>
|
|
<tr class="memdesc:ac579a92f012f0d0ef7b8f097e1c8b3c7"><td class="mdescLeft"> </td><td class="mdescRight">rotate a 2D cartesian vector and returns its x component. <a href="#ac579a92f012f0d0ef7b8f097e1c8b3c7">More...</a><br /></td></tr>
|
|
<tr class="separator:ac579a92f012f0d0ef7b8f097e1c8b3c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a355150c423ab975fe7f1832917118ea3"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-vector-operations_8ipf.html#a355150c423ab975fe7f1832917118ea3">rotate2d_y</a> (variable xx, variable yy, variable angle)</td></tr>
|
|
<tr class="memdesc:a355150c423ab975fe7f1832917118ea3"><td class="mdescLeft"> </td><td class="mdescRight">rotate a 2D cartesian vector and returns its y component. <a href="#a355150c423ab975fe7f1832917118ea3">More...</a><br /></td></tr>
|
|
<tr class="separator:a355150c423ab975fe7f1832917118ea3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a72c3200a7344c708ea76e20cc2c19c43"><td class="memItemLeft" align="right" valign="top">wave </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-vector-operations_8ipf.html#a72c3200a7344c708ea76e20cc2c19c43">create_rotation_matrix_free</a> ()</td></tr>
|
|
<tr class="memdesc:a72c3200a7344c708ea76e20cc2c19c43"><td class="mdescLeft"> </td><td class="mdescRight">create a free matrix wave which represents the 3-vector identity. <a href="#a72c3200a7344c708ea76e20cc2c19c43">More...</a><br /></td></tr>
|
|
<tr class="separator:a72c3200a7344c708ea76e20cc2c19c43"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8a8dff94d9f7b992c2c2c0744001e74b"><td class="memItemLeft" align="right" valign="top">wave </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-vector-operations_8ipf.html#a8a8dff94d9f7b992c2c2c0744001e74b">set_rotation_x</a> (wave matrix, variable angle)</td></tr>
|
|
<tr class="memdesc:a8a8dff94d9f7b992c2c2c0744001e74b"><td class="mdescLeft"> </td><td class="mdescRight">calculate a matrix representing a 3-vector rotation around the x axis. <a href="#a8a8dff94d9f7b992c2c2c0744001e74b">More...</a><br /></td></tr>
|
|
<tr class="separator:a8a8dff94d9f7b992c2c2c0744001e74b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adfdf1cfe8812d8d0006228f6c14c9582"><td class="memItemLeft" align="right" valign="top">wave </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-vector-operations_8ipf.html#adfdf1cfe8812d8d0006228f6c14c9582">set_rotation_y</a> (wave matrix, variable angle)</td></tr>
|
|
<tr class="memdesc:adfdf1cfe8812d8d0006228f6c14c9582"><td class="mdescLeft"> </td><td class="mdescRight">calculate a matrix representing a 3-vector rotation around the y axis <a href="#adfdf1cfe8812d8d0006228f6c14c9582">More...</a><br /></td></tr>
|
|
<tr class="separator:adfdf1cfe8812d8d0006228f6c14c9582"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a76feca10fe5d3e085f01c73a59b38424"><td class="memItemLeft" align="right" valign="top">wave </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-vector-operations_8ipf.html#a76feca10fe5d3e085f01c73a59b38424">set_rotation_z</a> (wave matrix, variable angle)</td></tr>
|
|
<tr class="memdesc:a76feca10fe5d3e085f01c73a59b38424"><td class="mdescLeft"> </td><td class="mdescRight">calculate a matrix representing a 3-vector rotation around the z axis <a href="#a76feca10fe5d3e085f01c73a59b38424">More...</a><br /></td></tr>
|
|
<tr class="separator:a76feca10fe5d3e085f01c73a59b38424"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ada80428496dc748b960bd9c65df7da8b"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-vector-operations_8ipf.html#ada80428496dc748b960bd9c65df7da8b">rotate_x_wave</a> (wave inout, variable angle)</td></tr>
|
|
<tr class="memdesc:ada80428496dc748b960bd9c65df7da8b"><td class="mdescLeft"> </td><td class="mdescRight">rotate a wave of 3-vectors about the x axis. <a href="#ada80428496dc748b960bd9c65df7da8b">More...</a><br /></td></tr>
|
|
<tr class="separator:ada80428496dc748b960bd9c65df7da8b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adfd1d68e739694982fbd00b76568c1c0"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-vector-operations_8ipf.html#adfd1d68e739694982fbd00b76568c1c0">rotate_y_wave</a> (wave inout, variable angle)</td></tr>
|
|
<tr class="memdesc:adfd1d68e739694982fbd00b76568c1c0"><td class="mdescLeft"> </td><td class="mdescRight">rotates a wave of 3-vectors about the y axis <a href="#adfd1d68e739694982fbd00b76568c1c0">More...</a><br /></td></tr>
|
|
<tr class="separator:adfd1d68e739694982fbd00b76568c1c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0030e927980581d57781ad391f2d872a"><td class="memItemLeft" align="right" valign="top">variable </td><td class="memItemRight" valign="bottom"><a class="el" href="pearl-vector-operations_8ipf.html#a0030e927980581d57781ad391f2d872a">rotate_z_wave</a> (wave inout, variable angle)</td></tr>
|
|
<tr class="memdesc:a0030e927980581d57781ad391f2d872a"><td class="mdescLeft"> </td><td class="mdescRight">rotates a wave of 3-vectors about the z axis <a href="#a0030e927980581d57781ad391f2d872a">More...</a><br /></td></tr>
|
|
<tr class="separator:a0030e927980581d57781ad391f2d872a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>basic vector geometry operations. </p>
|
|
<p>this procedure file contains basic vector geometry functions, such as rotations.</p>
|
|
<dl class="section author"><dt>Author</dt><dd>matthias muntwiler, <a href="#" onclick="location.href='mai'+'lto:'+'mat'+'th'+'ias'+'.m'+'unt'+'wi'+'ler'+'@p'+'si.'+'ch'; return false;">matth<span style="display: none;">.nosp@m.</span>ias.<span style="display: none;">.nosp@m.</span>muntw<span style="display: none;">.nosp@m.</span>iler<span style="display: none;">.nosp@m.</span>@psi.<span style="display: none;">.nosp@m.</span>ch</a></dd></dl>
|
|
<dl class="section copyright"><dt>Copyright</dt><dd>2011-17 Paul Scherrer Institut <br />
|
|
Licensed under the Apache License, Version 2.0 (the "License"); <br />
|
|
you may not use this file except in compliance with the License. <br />
|
|
You may obtain a copy of the License at <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a> </dd></dl>
|
|
|
|
<p class="definition">Definition in file <a class="el" href="pearl-vector-operations_8ipf_source.html">pearl-vector-operations.ipf</a>.</p>
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a72c3200a7344c708ea76e20cc2c19c43"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a72c3200a7344c708ea76e20cc2c19c43">◆ </a></span>create_rotation_matrix_free()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">wave create_rotation_matrix_free </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>create a free matrix wave which represents the 3-vector identity. </p>
|
|
<p>the matrix is initialized as identity.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>3x3 identity matrix in a free wave. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-vector-operations_8ipf_source.html#l00073">73</a> of file <a class="el" href="pearl-vector-operations_8ipf_source.html">pearl-vector-operations.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac579a92f012f0d0ef7b8f097e1c8b3c7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac579a92f012f0d0ef7b8f097e1c8b3c7">◆ </a></span>rotate2d_x()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable rotate2d_x </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>xx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>yy</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>angle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>rotate a 2D cartesian vector and returns its x component. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">xx</td><td>x coordinate. </td></tr>
|
|
<tr><td class="paramname">yy</td><td>y coordinate. </td></tr>
|
|
<tr><td class="paramname">angle</td><td>rotation angle in degrees.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>x coordinate of the rotated vector. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-vector-operations_8ipf_source.html#l00045">45</a> of file <a class="el" href="pearl-vector-operations_8ipf_source.html">pearl-vector-operations.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a355150c423ab975fe7f1832917118ea3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a355150c423ab975fe7f1832917118ea3">◆ </a></span>rotate2d_y()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable rotate2d_y </td>
|
|
<td>(</td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>xx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>yy</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>angle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>rotate a 2D cartesian vector and returns its y component. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">xx</td><td>x coordinate. </td></tr>
|
|
<tr><td class="paramname">yy</td><td>y coordinate. </td></tr>
|
|
<tr><td class="paramname">angle</td><td>rotation angle in degrees.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>y coordinate of the rotated vector. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-vector-operations_8ipf_source.html#l00060">60</a> of file <a class="el" href="pearl-vector-operations_8ipf_source.html">pearl-vector-operations.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ada80428496dc748b960bd9c65df7da8b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ada80428496dc748b960bd9c65df7da8b">◆ </a></span>rotate_x_wave()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable rotate_x_wave </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>inout</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>angle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>rotate a wave of 3-vectors about the x axis. </p>
|
|
<p>this function rotates multiple vectors.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">inout</td><td>wave with dimensions (M, N), M >= 3 (x, y, z), N >= 1. the result will be in same wave. only the first three rows of dimension 0 are used, extra rows are left unchanged. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">angle</td><td>rotation angle in degrees.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-vector-operations_8ipf_source.html#l00175">175</a> of file <a class="el" href="pearl-vector-operations_8ipf_source.html">pearl-vector-operations.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adfd1d68e739694982fbd00b76568c1c0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adfd1d68e739694982fbd00b76568c1c0">◆ </a></span>rotate_y_wave()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable rotate_y_wave </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>inout</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>angle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>rotates a wave of 3-vectors about the y axis </p>
|
|
<p>this function rotates multiple vectors.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">inout</td><td>wave with dimensions (M, N), M >= 3 (x, y, z), N >= 1. the result will be in same wave. only the first three rows of dimension 0 are used, extra rows are left unchanged. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">angle</td><td>rotation angle in degrees.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-vector-operations_8ipf_source.html#l00203">203</a> of file <a class="el" href="pearl-vector-operations_8ipf_source.html">pearl-vector-operations.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0030e927980581d57781ad391f2d872a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0030e927980581d57781ad391f2d872a">◆ </a></span>rotate_z_wave()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">variable rotate_z_wave </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>inout</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>angle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>rotates a wave of 3-vectors about the z axis </p>
|
|
<p>this function rotates multiple vectors.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">inout</td><td>wave with dimensions (M, N), M >= 3 (x, y, z), N >= 1. the result will be in same wave. only the first three rows of dimension 0 are used, extra rows are left unchanged. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">angle</td><td>rotation angle in degrees.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-vector-operations_8ipf_source.html#l00231">231</a> of file <a class="el" href="pearl-vector-operations_8ipf_source.html">pearl-vector-operations.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8a8dff94d9f7b992c2c2c0744001e74b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8a8dff94d9f7b992c2c2c0744001e74b">◆ </a></span>set_rotation_x()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">wave set_rotation_x </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>matrix</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>angle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>calculate a matrix representing a 3-vector rotation around the x axis. </p>
|
|
<p>the function calculates the matrix elements of a rotation about the x axis.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">matrix</td><td>3x3 wave to receive the rotation matrix elements. the function calculates only the 2x2 block of the rotation. the other elements must be initialized by the caller, e.g. set to the identity matrix. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">angle</td><td>rotation angle in degrees.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>rotation matrix. this is the same wave instance as the matrix input. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-vector-operations_8ipf_source.html#l00092">92</a> of file <a class="el" href="pearl-vector-operations_8ipf_source.html">pearl-vector-operations.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adfdf1cfe8812d8d0006228f6c14c9582"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adfdf1cfe8812d8d0006228f6c14c9582">◆ </a></span>set_rotation_y()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">wave set_rotation_y </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>matrix</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>angle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>calculate a matrix representing a 3-vector rotation around the y axis </p>
|
|
<p>the function calculates the matrix elements of a rotation about the y axis.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">matrix</td><td>3x3 wave to receive the rotation matrix elements. the function calculates only the 2x2 block of the rotation. the other elements must be initialized by the caller, e.g. set to the identity matrix. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">angle</td><td>rotation angle in degrees.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>rotation matrix. this is the same wave instance as the matrix input. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-vector-operations_8ipf_source.html#l00120">120</a> of file <a class="el" href="pearl-vector-operations_8ipf_source.html">pearl-vector-operations.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a76feca10fe5d3e085f01c73a59b38424"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a76feca10fe5d3e085f01c73a59b38424">◆ </a></span>set_rotation_z()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">wave set_rotation_z </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wave </td>
|
|
<td class="paramname"><em>matrix</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">variable </td>
|
|
<td class="paramname"><em>angle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>calculate a matrix representing a 3-vector rotation around the z axis </p>
|
|
<p>the function calculates the matrix elements of a rotation about the z axis.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">matrix</td><td>3x3 wave to receive the rotation matrix elements. the function calculates only the 2x2 block of the rotation. the other elements must be initialized by the caller, e.g. set to the identity matrix. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">angle</td><td>rotation angle in degrees.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>rotation matrix. this is the same wave instance as the matrix input. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="pearl-vector-operations_8ipf_source.html#l00148">148</a> of file <a class="el" href="pearl-vector-operations_8ipf_source.html">pearl-vector-operations.ipf</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</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="dir_fe5dc42579d4b99403482a3a637d9f7d.html">pearl</a></li><li class="navelem"><a class="el" href="pearl-vector-operations_8ipf.html">pearl-vector-operations.ipf</a></li>
|
|
<li class="footer">Generated on Tue Jun 16 2020 14:32:36 for PEARL Procedures by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|