Changeset 171


Ignore:
Timestamp:
Jan 4, 2011, 7:57:03 PM (10 years ago)
Author:
sommeria
Message:

cleaning of documentation

Location:
trunk/src/series
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/series/clean_civ_cmx.m

    r27 r171  
     1%'clean_civ_cmx': suppress all ancillary files used for PIV: ;cmx,log,.bat...
     2%------------------------------------------------------------------------
     3% function GUI_input=clean_civ_cmx(num_i1,num_i2,num_j1,num_j2,Series)
     4%
     5%OUTPUT
     6% GUI_input=list of options in the GUI series.fig needed for the function
     7%
     8%INPUT:
     9%num_i1: (not used) series of first indices i (given from the series interface as first_i:incr_i:last_i, mode and list_pair_civ)
     10%num_i2: (not used) series of second indices i (given from the series interface as first_i:incr_i:last_i, mode and list_pair_civ)
     11%num_j1: (not used) series of first indices j (given from the series interface as first_j:incr_j:last_j, mode and list_pair_civ )
     12%num_j2: (not used) series of second indices j (given from the series interface as first_j:incr_j:last_j, mode and list_pair_civ)
     13%Series: Matlab structure containing information set by the series interface
     14%
    115function GUI_input=clean_civ_cmx(num_i1,num_i2,num_j1,num_j2,Series) %(filecell,filecell_1,num_i,num_j,vel_type,field,param);
    2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
    3  %detect the chosen series of files and check their date of modification:
    4 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
    5 %INPUT:
    6 %num_i1: series of first indices i (given from the series interface as first_i:incr_i:last_i, mode and list_pair_civ)
    7 %num_i2: series of second indices i (given from the series interface as first_i:incr_i:last_i, mode and list_pair_civ)
    8 %num_j1: series of first indices j (given from the series interface as first_j:incr_j:last_j, mode and list_pair_civ )
    9 %num_j2: series of second indices j (given from the series interface as first_j:incr_j:last_j, mode and list_pair_civ)
    10 %OTHER INPUTS given by the structure Series
    1116
    1217%requests for the visibility of input windows in the GUI series  (activated directly by the selection in the menu ACTION)
  • trunk/src/series/ima2vol.m

    r73 r171  
    1 % relabel_i_j: relabel an image series with two indices, according to the time matrix given by ImaDoc
     1%'ima2vol': concatene  image series to form a 'volume' image .vol used for 3D PIV
     2%------------------------------------------------------------------------
     3% function GUI_input=ima2vol(num_i1,num_i2,num_j1,num_j2,Series)
     4%
     5%OUTPUT
     6% GUI_input=list of options in the GUI series.fig needed for the function
     7%
     8%INPUT:
     9%num_i1: series of first indices i (given from the series interface as first_i:incr_i:last_i, mode and list_pair_civ)
     10%num_i2:  series of second indices i (given from the series interface as first_i:incr_i:last_i, mode and list_pair_civ)
     11%num_j1:  series of first indices j (given from the series interface as first_j:incr_j:last_j, mode and list_pair_civ )
     12%num_j2:  series of second indices j (given from the series interface as first_j:incr_j:last_j, mode and list_pair_civ)
     13%Series: Matlab structure containing information set by the series interface
     14%
    215%----------------------------------------------------------------------
    316function GUI_input=ima2vol(num_i1,num_i2,num_j1,num_j2,Series)
  • trunk/src/series/ima_levels.m

    r160 r171  
    1 % relabel_i_j: relabel an image series with two indices, according to the time matrix given by ImaDoc
     1%'ima_levels': rescale the image intensity to reduce strong luminosity peaks
     2%------------------------------------------------------------------------
     3% function GUI_input=ima_levels(num_i1,num_i2,num_j1,num_j2,Series)
     4%
     5%OUTPUT
     6% GUI_input=list of options in the GUI series.fig needed for the function
     7%
     8%INPUT:
     9%num_i1: series of first indices i (given from the series interface as first_i:incr_i:last_i, mode and list_pair_civ)
     10%num_i2:  series of second indices i (given from the series interface as first_i:incr_i:last_i, mode and list_pair_civ)
     11%num_j1:  series of first indices j (given from the series interface as first_j:incr_j:last_j, mode and list_pair_civ )
     12%num_j2:  series of second indices j (given from the series interface as first_j:incr_j:last_j, mode and list_pair_civ)
     13%Series: Matlab structure containing information set by the series interface% relabel_i_j: relabel an image series with two indices, according to the time matrix given by ImaDoc
    214%----------------------------------------------------------------------
    315function GUI_input=ima_levels(num_i1,num_i2,num_j1,num_j2,Series)
Note: See TracChangeset for help on using the changeset viewer.