Changeset 169


Ignore:
Timestamp:
Jan 4, 2011, 3:43:23 PM (10 years ago)
Author:
sommeria
Message:

comments added at the head of functions

Location:
trunk/src/series
Files:
5 edited

Legend:

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

    r158 r169  
     1%'aver_stat': calculate field average, used with series.fig
     2%------------------------------------------------------------------------
     3% function GUI_input=aver_stat(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%
    115function GUI_input=aver_stat(num_i1,num_i2,num_j1,num_j2,Series)
    216%----------------------------------------------------------------------
  • trunk/src/series/check_files.m

    r32 r169  
     1%'check_files': check the existence and status of the files selected by series.fig
     2%------------------------------------------------------------------------
     3% function GUI_input=check_files(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%
    115function GUI_input=check_files(num_i1_cell,num_i2_cell,num_j1_cell,num_j2_cell,Series) %(filecell,filecell_1,num_i,num_j,vel_type,field,param);
    216%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  • trunk/src/series/merge_proj.m

    r158 r169  
     1%'merge_proj': project and concatene fields, used with series.fig
     2%------------------------------------------------------------------------
     3% function GUI_input=merge_proj(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%
    115function GUI_input=merge_proj(num_i1,num_i2,num_j1,num_j2,Series)
    216
  • trunk/src/series/sub_background.m

    r143 r169  
    1 %----------------------------------------------------------------------
    2 % --- substract background to the images: rank the images by luminosity at each point and substracts to the images
     1%'sub_background': substract background to an image series, used with series.fig
     2%------------------------------------------------------------------------
     3% function GUI_input=aver_stat(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%       .RootPath: path to the image series
     15%       .RootFile: root file name
     16%       .FileExt: image file extension
     17%       .NomType: nomenclature type for file indexing
     18%       .NbSlice: %number of slices defined on the interface
    319%----------------------------------------------------------------------
    420% Method:
     
    1430    % The processing can be done in slices (number nbslice), with bursts of
    1531    % nbfield2 successive images for a given slice (mode 'multilevel')
    16     % In the mode 'volume', nbfield2=1 (1 image at each level), and
    17     % nbslice=
    18 %INPUT:
    19 % num_i1: matrix of image indices i
    20 % num_j1: matrix of image indices j, must be the same size as num_i1
    21 % num_i2 and num_j2: not used for a function acting on images
    22 % Series: matlab structure containing parameters, as defined by the interface UVMAT/series
    23 %       Series.RootPath: path to the image series
    24 %       Series.RootFile: root file name
    25 %       Series.FileExt: image file extension
    26 %       Series.NomType: nomenclature type for file indexing
    27 %       Series.NbSlice: %number of slices defined on the interface
    28 
     32    % In the mode 'volume', nbfield2=1 (1 image at each level)
     33%
    2934function GUI_input=sub_background (num_i1,num_i2,num_j1,num_j2,Series)
    3035
  • trunk/src/series/time_series.m

    r158 r169  
    1 function GUI_input=time_series(num_i1,num_i2,num_j1,num_j2,Series)
    2 %----------------------------------------------------------------------
    3 % --- make a time series analysis
    4 %----------------------------------------------------------------------
    5 %INPUT:
     1%'time_series': extract a time series, used with series.fig
     2%------------------------------------------------------------------------
     3% function GUI_input=time_series(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:
    69%num_i1: series of first indices i (given from the series interface as first_i:incr_i:last_i, mode and list_pair_civ)
    710%num_i2: series of second indices i (given from the series interface as first_i:incr_i:last_i, mode and list_pair_civ)
    811%num_j1: series of first indices j (given from the series interface as first_j:incr_j:last_j, mode and list_pair_civ )
    912%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
     13%Series: Matlab structure containing information set by the series interface
     14%
     15function GUI_input=time_series(num_i1,num_i2,num_j1,num_j2,Series)
    1116
    1217%requests for the visibility of input windows in the GUI series  (activated directly by the selection in the menu ACTION)
Note: See TracChangeset for help on using the changeset viewer.