source: trunk/doc/FUNCTIONS_DOC/index.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: 14.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>Index for Directory .</title>
6  <meta name="keywords" content=".">
7  <meta name="description" content="Index for Directory .">
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<table width="100%"><tr><td align="left"><a href="../index.html"><img alt="<" border="0" src="../left.png">&nbsp;Master index</a></td>
16<td align="right"><a href="index.html">Index for .&nbsp;<img alt=">" border="0" src="../right.png"></a></td></tr></table>
17
18<h1>Index for .</h1>
19
20<h2>Matlab files in this directory:</h2>
21<table>
22<tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="ListDir.html">ListDir</a></td><td>'ListDir': scan the structure of the directory tree (for dataview.m) </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="RUN_FIX.html">RUN_FIX</a></td><td>'RUN_FIX': function for fixing velocity fields: </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="RUN_STLIN.html">RUN_STLIN</a></td><td>'RUN_STLIN': combine velocity fields for stereo PIV </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="calc_field.html">calc_field</a></td><td>'calc_field': defines fields (velocity, vort, div...) from civx data and calculate them </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="cell2tab.html">cell2tab</a></td><td>'cell2tab': transform a Matlab cell in a character array suitable for display in a table </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="check_field_structure.html">check_field_structure</a></td><td>'check_field_structure': check the validity of the field struture representation consistant with the netcdf format </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="check_functions.html">check_functions</a></td><td>'check_functions': check the path and modification date for all the </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="civ.html">civ</a></td><td>'civ': function associated with the interface 'civ.fig' for PIV, spline interpolation and stereo PIV (patch) </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="civ_3D.html">civ_3D</a></td><td>'civ_3D': function associated with the interface 'civ_3D.fig' for PIV in volume </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="close_fig.html">close_fig</a></td><td>'close_fig': function  activated when a figure is closed </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="copyfields.html">copyfields</a></td><td>'copyfields' copy fields between two matlab structures </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="create_grid.html">create_grid</a></td><td>'create_grid': called by the GUI geometry_calib to create a physical grid </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="dataview.html">dataview</a></td><td>'dataview': function for scanning directories in a campaign </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="delete_object.html">delete_object</a></td><td>'delete_object': delete a projection object, defined by its index in the Uvmat list or by its graphic handle </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="editxml.html">editxml</a></td><td>'editxml': function for editing xml files using a xml schema (associated with the GUI editxml.fig) </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="find_field_indices.html">find_field_indices</a></td><td>'find_file_indices': test field structure for input in proj_field and plot_field </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="geometry_calib.html">geometry_calib</a></td><td>'geometry_calib': performs geometric calibration from a set of reference points </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="get_field.html">get_field</a></td><td>'get_field': display variables and attributes from a Netcdf file, and RUN selected fields </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="get_plot_handles.html">get_plot_handles</a></td><td>'get_plot_handles': list the  handles of elements setting the plotting parameters in the uvmat interface </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="griddata_uvmat.html">griddata_uvmat</a></td><td>'griddata_uvmat': function griddata_uvmat(vec2_X,vec2_Y,vec2_U,vec_X,vec_Y,'linear') </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="hist_update.html">hist_update</a></td><td>'hist_update': update of a current global histogram by inclusion of a new field </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="imadoc2struct.html">imadoc2struct</a></td><td>'imadoc2struct': reads the xml file for image documentation </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="interp2_uvmat.html">interp2_uvmat</a></td><td>A matrix (npy,npx) to interpolate </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="keyboard_callback.html">keyboard_callback</a></td><td>'keyboard_callback:' function activated when a key is pressed on the keyboard </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="mouse_down.html">mouse_down</a></td><td>'mouse_down': function activated when the mouse button is pressed on a figure (callback for 'WindowButtonDownFcn' </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="mouse_motion.html">mouse_motion</a></td><td>'mouse_motion': permanently called by mouse motion over a figure (Callback for 'WindowButtonMotionFcn' of the figure) </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="mouse_up.html">mouse_up</a></td><td>'mouse_up': function  activated when the mouse button is released </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="msgbox_uvmat.html">msgbox_uvmat</a></td><td>'msgbox_uvmat': associated with GUI msgbox_uvmat.fig to display message boxes, for error, warning or input calls </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="name2display.html">name2display</a></td><td>'name2display': extracts the root name and field numbers from an input filename </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="name_generator.html">name_generator</a></td><td>'name_generator': creates a file name from a root name and indices. </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="nc2struct.html">nc2struct</a></td><td>'nc2struct': transform a netcdf file in a corresponding matlab structure </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="nc2struct_toolbox.html">nc2struct_toolbox</a></td><td>'nc2struct_toolbox': transform a netcdf file in a corresponding matlab structure, USE OLD NETCDF LIBRARY </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="nomtype2pair.html">nomtype2pair</a></td><td>'nomtype2pair': creates nomencalture for index pairs. </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="num2stra.html">num2stra</a></td><td>'num2stra': transform number to the corresponding character string depending on the nomenclature </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="peaklock.html">peaklock</a></td><td>'peaklock': determines peacklocking errors from velocity histograms. </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="plot_field.html">plot_field</a></td><td>'plot_field': plot any field with the structure defined in the uvmat package </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="plot_object.html">plot_object</a></td><td>'plot_object': draws a projection object (points, line, plane...) </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="plot_text.html">plot_text</a></td><td>'plot_text': function for displaying the content of a Matlab structure in a figure </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="proj_field.html">proj_field</a></td><td>'proj_field': projects the field on a projection object </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="proj_grid.html">proj_grid</a></td><td>'proj_grid': project  fields with unstructured coordinantes on a regular grid </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="px_XYZ.html">px_XYZ</a></td><td> </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="read_civxdata.html">read_civxdata</a></td><td>'read_civxdata': reads civx data from netcdf files </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="read_geometry_calib.html">read_geometry_calib</a></td><td>'read_geometry_calib': read data on the GUI geometry_calib </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="read_get_field.html">read_get_field</a></td><td>'read_get_field': read the list of selected variables from the GUI get_field </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="read_image.html">read_image</a></td><td>'read_image': reads an image from a single file or a movie file </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="read_imatext.html">read_imatext</a></td><td>'read_imatext': reads the .civ file for image documentation (obsolete) </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="read_plot_param.html">read_plot_param</a></td><td>'read_plot_param':  read plotting parameters from the interface uvmat </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="read_set_object.html">read_set_object</a></td><td>'read_set_object': read the data on the 'set_object' interface </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="read_xls.html">read_xls</a></td><td>'read_xls': function for reading and displaying Excel files </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="reinit.html">reinit</a></td><td>'reinit': delete the personal parameter file 'uvmat_perso.mat' </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="series.html">series</a></td><td>'series': master function associated to the GUI series.m for analysis field series </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="set_col_vec.html">set_col_vec</a></td><td>'set_col_vec': sets the color code for vectors depending on a scalar vec_C and parameters given by the struct colcode </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="set_grid.html">set_grid</a></td><td>'set_grid':produce grid for PIV with one or two images (stereo case) </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="set_object.html">set_object</a></td><td>'set_object': GUI to edit a projection object </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="set_title.html">set_title</a></td><td>'set_title': defines the 'TITLE' of a projection object </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="stra2num.html">stra2num</a></td><td>'stra2num': transform letters (a, b, c) or numerical strings ('1','2'..) to the corresponding numbers </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="struct2nc.html">struct2nc</a></td><td>'struct2nc': create a netcdf file from a Matlab structure </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="struct2nc_toolbox.html">struct2nc_toolbox</a></td><td>'struct2nc_toolbox': create a netcdf file from a Matlab structure: use of netcdf toolbox </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="struct2xml.html">struct2xml</a></td><td>'struct2xml': transform a matlab structure to a xml tree. </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="sub_field.html">sub_field</a></td><td>'sub_field': combines two input fields </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="translate_points.html">translate_points</a></td><td>'translate_points': associated with GUI translate_points.fig to display message boxes, for error, warning or input calls </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="update_imadoc.html">update_imadoc</a></td><td>'update_imadoc': update an xml file with geometric calibration parameters </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="update_menu.html">update_menu</a></td><td>'update_menu': find an input string in a menu, add it to the menu at the penultimate position if it does not exist </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="update_obj.html">update_obj</a></td><td>'update_obj': update the object graph representation and its projection field, record it in the uvmat interface </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="update_waitbar.html">update_waitbar</a></td><td>'update_waitbar': update the waitbar display, used for ACTION functions in the GUI 'series' </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="uvmat.html">uvmat</a></td><td>'uvmat': function associated with the GUI 'uvmat.fig' for images and data field visualization </td></tr><tr><td><img src="../matlabicon.gif" alt="" border="">&nbsp;<a href="write_plot_param.html">write_plot_param</a></td><td>'write_plot_param': update the plotting parameters on the uvmat interface after a plotting operation </td></tr></table>
23
24
25<h2>Subsequent directories:</h2>
26<ul style="list-style-image:url(../matlabicon.gif)">
27<li>.svn</li><li>@xmltree</li><li>get_field</li><li>series</li><li>transform_field</li><li>uvmat_doc</li></ul>
28
29<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>
30</body>
31</html>
Note: See TracBrowser for help on using the repository browser.