Changes between Version 24 and Version 25 of UvmatHelp


Ignore:
Timestamp:
Jun 2, 2013, 10:12:21 AM (7 years ago)
Author:
sommeria
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • UvmatHelp

    v24 v25  
    1717 * '''editxml.fig:'''  displays and edits xml files according to an xml schema. xml reading and editing is performed by the toolbox [http://www.artefact.tk/software/matlab/xml/ xmltree] , copied in the subdirectory /@xmltree.
    1818 * '''geometry_calib.fig''': determines geometric calibration parameters for relating image to physical coordinates. The toolbox http://www.vision.caltech.edu/bouguetj/calib_doc/ is used, copied in the subdirectory /toolbox_calib.
    19  * '''get_field.fig:''' selects coordinates and field in a general NetCDF file. 
     19 * '''get_field.fig:''' selects coordinates and field in a general NetCDF file.
    2020 * '''series.fig:''' apply various processing functions to series of fields. These functions are stored in the subdirectory /series.
    2121 * '''set_object.fig:''' creates and edits geometric objects used to project data: points, lines, planes...
     
    708708
    709709=== Other GUIs:(function .m and associated figure .fig) ===
     710 * 'browse_data';...% function, associated with the GUI 'browse_data.fig' for scanning directories in a project/campaign
    710711 * 'civ';...   %function associated with the interface 'civ.fig' for PIV and spline interpolation
    711712 * 'create_grid';...% called by the GUI geometry_calib to create a physical grid
     
    717718 * 'rotate_points';...%'rotate_points': associated with GUI rotate_points.fig to introduce (2D) rotation parameters
    718719 * 'series';...% master function for analysis field series, with interface 'series.fig'
    719  * 'set_grid';...% creates a grid for PIV  * 'set_object';...%  edit a projection object
     720 * 'set_grid';...% creates a grid for PIV
     721 * 'set_object';...%  edit a projection object
    720722 * 'translate_points';...% associated with GUI translate_points.fig to display translation parameters
    721723 * 'view_field';...% function for visualisation of projected fields'
     
    723725=== functions activated by mouse and keybord in GUI : ===
    724726 * 'keyboard_callback';... % function activated when a key is pressed on the keyboard
    725  * 'mouse_down';% function activated when the mouse button is pressed on a figure (callback for 'WindowButtonDownFcn')
    726  * 'mouse_motion';...% permanently called by mouse motion over a figure (callback for 'WindowButtonMotionFcn')
    727  * 'mouse_up';... % function to be activated when the mouse button is released (callback for 'WindowButtonUpFcn')
     727 * 'mouse_down';% function activated when the mouse button is pressed on a figure (callback for '[wiki:WindowButtonDownFcn !WindowButtonDownFcn]')
     728 * 'mouse_motion';...% permanently called by mouse motion over a figure (callback for '[wiki:WindowButtonMotionFcn !WindowButtonMotionFcn]')
     729 * 'mouse_up';... % function to be activated when the mouse button is released (callback for '! WindowButtonUpFcn')
    728730
    729731=== main functions used: ===
     
    737739 * 'cell2tab';... % transform a Matlab cell in a character array suitable for display in a table
    738740 * 'fill_GUI';... % fill a GUI with handles 'handles' from input data Param
    739  * 'imadoc2struct';...% convert the image documentation file ImaDoc into a Matlab structure
     741 * 'imadoc2struct';...% convert the image documentation file [wiki:ImaDoc !ImaDoc] into a Matlab structure
    740742 * 'nomtype2pair';... creates nomenclature for index pairs knowing the image nomenclature, used by series fct
    741743 * 'nc2struct';...% transform a netcdf file in a corresponding matlab structure
    742744 * 'num2stra';...% transform number to the corresponding character string depending on the nomenclature.
    743745 * 'read_field':...% read the fields from files in different formats (netcdf files, images, video)
    744  * 'read_GUI'::...% read a GUI and provide the data as a Matlab structure 'read_image';... read images or video objects
     746 * 'read_GUI'::...% read a GUI and provide the data as a Matlab structure
     747 * 'read_image';... read images or video objects
    745748 * 'read_multimadoc';... %read a set of Imadoc files and compare their timing of different file series 'read_xls';...%read excel files containing the list of the experiments
    746749 * 'stra2num';...% transform letters (a, b, A, B,) or numerical strings ('1','2'..) to the corresponding numbers
     
    758761 * 'compile';...% compile a Matlab function, create a binary in a subdirectory /bin
    759762 * 'copyfields';...% copy fields between two matlab structures
    760  * 'delete_object';...%delete a projection object, defined by its index in the Uvmat list or by its graphic handle 
     763 * 'delete_object';...%delete a projection object, defined by its index in the Uvmat list or by its graphic handle
    761764 * 'displ_uvmat';...% display a message using  msgbox_uvmat or on the log file in batch mode
    762765 * 'fileparts_uvmat': splits a file name in root and indices and recognize file naming convention
     
    771774 * 'griddata_uvmat';...%make 2D linear interpolation using griddata, with input appropriate for both Matlab 6.5 and 7
    772775 * 'hist_update';...%  update of a current global histogram by inclusion of a new field
    773  * 'imadoc2struct';...%convert the image documentation file ImaDoc into a Matlab structure
     776 * 'imadoc2struct';...%convert the image documentation file [wiki:ImaDoc !ImaDoc] into a Matlab structure
    774777 * 'interp2_uvmat';...% linearly interpolate an image or scalar defined on a regular grid
    775778 * '!ListDir';... scan the structure of the directory tree (for dataview.m)
    776779 * 'mask_proj';...% restrict input fields to a mask region, set to 0 outside
    777780 * 'open_uvmat';...% open with uvmat the  field selected in the list of 'civ/status' or 'series/check_data_files'
    778  * 'peaklock';...% 
    779  * 'phys_XYZ';...% transform coordiantes from pixels to phys
     781 * 'peaklock';...%
     782 * 'phys_XYZ';...% transform coordinates from pixels to phys
    780783 * 'px_XYZ';...% transform coordiantes from phys to pixels
    781784 * 'read_civxdata';...reads civx data from netcdf files
    782785 * 'read_civdata';... reads new civ data from netcdf files
    783  * 'read_get_field';... read the list of selected variables from the GUI get_field (TODO: use read_GUI)
     786 * 'read_geometry_calib';... read data on the GUI geometry_calib
    784787 * 'read_imatext';...%read .civ files (obsolete, but can be adapted to other text documentation files)
    785788 * 'read_xls';...%read excel files containing the list of the experiments
    786789 * 'reinit';...% suppress the personal parameter file 'uvmat_perso.mat'
    787790 * 'set_col_vec';...% sets the color code for vectors depending on a scalar and input parameters (used for plot_field)
     791 * 'set_subdomains';...% sort a set of points defined by scattered coordinates in subdomains, as needed for tps interpolation
    788792 * 'tps_coeff';...% calculate the thin plate spline (tps) coefficients
     793 * 'tps_coeff_field';...% calculate the thin plate spline (tps) coefficients with subdomains for a field structure
    789794 * 'tps_eval';... %calculate the thin plate spline (tps) interpolation at a set of points
    790795 * 'tps_eval_dxy';...% calculate the derivatives of thin plate spline (tps) interpolation at a set of points (limited to the 2D case)
    791  * 'update_imadoc';...  %update the ImaDoc xml file
    792  * 'update_obj';... update the object representation graph and its projection field, record it in the uvmat interface
     796 * 'update_imadoc';...  %update the [wiki:ImaDoc !ImaDoc] xml file
    793797 * 'update_waitbar';... update the waitbar display, used for ACTION functions in the GUI 'series'
    794  * 'write_plot_param'...%update plotting parameters after plot, TODO: change into a general function: fill_GUI
    795798
    796799=== series functions ===
     
    807810 * 'ima_remove_particles': removes particles from an image (keeping the local minimum)
    808811 * 'FFT2_detrend': calculate the 2D spectrum of the input scalar after removing the linear trend (requires the Matlab image processing toolbox).
    809  * 'phys': transforms image (Unit='pixel') to real world (phys) coordinates using geometric calibration parameters. It acts if the input field contains the tag 'CoordUnit' with value 'pixel'
     812 * 'phys': transforms image (Unit='pixel') to real world (phys) coordinates using geometric calibration parameters. It acts if the input field contains the tag '[wiki:CoordUnit !CoordUnit]' with value 'pixel'
    810813 * 'phys_polar': this transforms the fields to polar coordinates, radius in abscissa (same unit as x, y) and azimuth in ordinate (unit =degree).