source: trunk/doc/FUNCTIONS_DOC/peaklock.html @ 51

Last change on this file since 51 was 51, checked in by gostiaux, 11 years ago

added doc repository at the same level than src

File size: 3.2 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2                "http://www.w3.org/TR/REC-html40/loose.dtd">
3<html>
4<head>
5  <title>Description of peaklock</title>
6  <meta name="keywords" content="peaklock">
7  <meta name="description" content="'peaklock': determines peacklocking errors from velocity histograms.">
8  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
9  <meta name="generator" content="m2html &copy; 2003 Guillaume Flandin">
10  <meta name="robots" content="index, follow">
11  <link type="text/css" rel="stylesheet" href="../m2html.css">
12</head>
13<body>
14<a name="_top"></a>
15<div><a href="../index.html">Home</a> &gt;  <a href="index.html">.</a> &gt; peaklock.m</div>
16
17<!--<table width="100%"><tr><td align="left"><a href="../index.html"><img alt="<" border="0" src="../left.png">&nbsp;Master index</a></td>
18<td align="right"><a href="index.html">Index for .&nbsp;<img alt=">" border="0" src="../right.png"></a></td></tr></table>-->
19
20<h1>peaklock
21</h1>
22
23<h2><a name="_name"></a>PURPOSE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
24<div class="box"><strong>'peaklock': determines peacklocking errors from velocity histograms.</strong></div>
25
26<h2><a name="_synopsis"></a>SYNOPSIS <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
27<div class="box"><strong>function [histinter,x,error]=peaklock(nbb,minim,maxim,histu) </strong></div>
28
29<h2><a name="_description"></a>DESCRIPTION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
30<div class="fragment"><pre class="comment">'peaklock': determines peacklocking errors from velocity histograms.
31-------------------------------------------------------
32first smooth the input histogram 'histu' in such a way that the integral over
33n-n+1 is preserved, then deduce the peaklocking 'error' function of the pixcel displacement 'x'.
34
35 [histinter,x,error]=peaklock(nbb,minim,maxim,histu)
36OUTPUT:
37histinter: smoothed interpolated histogram
38 x: vector of displacement values.
39 error: vector of estimated errors corresponding to x
40INPUT:
41histu=vector representing the values of histogram  of measured velocity ;
42minim, maxim: extremal values of the measured velocity (absica for histu)
43nbb: number of bins inside each integer interval for the histograms
44SUBROUTINES INCLUDED:
45spline4.m% spline interpolation at 4th order
46splinhist.m: give spline coeff cc for a smooth histo (call spline4)
47histsmooth.m(x,cc): calculate the smooth histo for any value x
48histder.m(x,cc): calculate the derivative of the smooth histo</pre></div>
49
50<!-- crossreference -->
51<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
52This function calls:
53<ul style="list-style-image:url(../matlabicon.gif)">
54</ul>
55This function is called by:
56<ul style="list-style-image:url(../matlabicon.gif)">
57<li><a href="get_field.html" class="code" title="function varargout = get_field(varargin)">get_field</a>        'get_field': display variables and attributes from a Netcdf file, and RUN selected fields</li></ul>
58<!-- crossreference -->
59
60
61
62<hr><address>Generated on Wed 10-Mar-2010 20:42:36 by <strong><a href="http://www.artefact.tk/software/matlab/m2html/">m2html</a></strong> &copy; 2003</address>
63</body>
64</html>
Note: See TracBrowser for help on using the repository browser.