# doc-cache created by Octave 4.2.0
# name: cache
# type: cell
# rows: 3
# columns: 4
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 4
thsp


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 2243

  This function creates the THSP (Time History Speckle Pattern)[1][2] of a set 
  of pixels in a line or column of a datapack (DATA).

  References:
  [1]  OULOMARA, G.; TRIBILLON, J.; DUVERNOY, J. Biological activity measurements 
       on botanical specimen surfaces using a temporal decorrelation effect of 
       laser speckle. Journal of Moderns Optics, London, v. 36, n. 2, p. 136-179, 
       Feb. 1989.

  [2]  XU, Z.; JOENATHAN, C.; KHORANA, B. M. Temporal and spatial properties of 
       the time-varying speckles of botanical specimens. Optical Enginnering, Virginia, 
       v. 34, n. 5, p. 1487-1502, May 1995.

  After starting the main routine just type the following command at the
  prompt:
  Y = thsp(DATA,R,S);
  Y = thsp(DATA,'line',100);   % THSP matrix with the line 100 of datapack.
  Y = thsp(DATA,1,100);        % THSP matrix with the line 100 of datapack.
  Y = thsp(DATA,'column',100); % THSP matrix with the column 100 of datapack.
  Y = thsp(DATA,2,100);        % THSP matrix with the column 100 of datapack.
  
  Input:
  DATA is the speckle data pack. Where DATA is a 3D matrix created grouping NTIMES 
       intensity matrices with NLIN lines and NCOL columns. When N=size(DATA), then
       N(1,1) represents NLIN and
       N(1,2) represents NCOL and
       N(1,3) represents NTIMES.
  R    is a parameter of analysis: 
       if R is equal to 1 or 'line', you choose the lines of images to create the THSP and
       if R is equal to 2 or 'column', you choose the columns of images to create the THSP.
       In other cases the function returns error.
  S    is the line or column position used to make the time history speckle patterns.
       The function do not verify if S is in the  possible range, this check must be done by the user.

  Output:
  Y    is the time history speckle patterns matrix. Where Y is a 2D matrix with
       M lines and NTIMES columns, being M equal to NCOL when R is 1 and M equal 
       to NLIN when R is 2.
       Y is a matrix where each column is a representation of one only line or column 
       in the S position of DATA.


  For help, bug reports and feature suggestions, please visit:
  http://nongnu.org/bsltl/




# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80

  This function creates the THSP (Time History Speckle Pattern)[1][2] of a set



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 13
thsp_gaussian


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 3057

  This function creates the THSP (Time History Speckle Pattern)[1][2] 
  of a set of M points (pixels) randomly (Gaussian) selected in EXAMPLE_MATRIX, 
  and through DATA(:,:,k) for all k value.   
  Around a point P0, M points are selected randomly, these points are concentrated
  mostly in a radius Sigma around the point P0.

  References:
  [1]  OULOMARA, G.; TRIBILLON, J.; DUVERNOY, J. Biological activity measurements 
       on botanical specimen surfaces using a temporal decorrelation effect of 
       laser speckle. Journal of Moderns Optics, London, v. 36, n. 2, p. 136-179, 
       Feb. 1989.

  [2]  XU, Z.; JOENATHAN, C.; KHORANA, B. M. Temporal and spatial properties of 
       the time-varying speckles of botanical specimens. Optical Engineering, Virginia, 
       v. 34, n. 5, p. 1487-1502, May 1995.

  After starting the main routine just type the following command at the
  prompt:
  Y         = thsp_gaussian(DATA,M,Sigma);
  [Y POINTS]= thsp_gaussian(DATA,M,Sigma);
  [Y POINTS]= thsp_gaussian(DATA,M,Sigma,'on');
  [Y POINTS]= thsp_gaussian(DATA,M,Sigma,P0);
  [Y POINTS]= thsp_gaussian(DATA,M,Sigma,P0,'on');
  [Y POINTS]= thsp_gaussian(DATA,M,Sigma,HG);
  [Y POINTS]= thsp_gaussian(DATA,M,Sigma,HG,'on');
  
  Input:
  DATA    is the speckle data pack. Where DATA is a 3D matrix created grouping NTIMES 
          intensity matrices with NLIN lines and NCOL columns. When N=size(DATA), then
          N(1,1) represents NLIN and
          N(1,2) represents NCOL and
          N(1,3) represents NTIMES.
  M       is the number of points, Gaussian randomly selected, in analysis.
  Sigma   is the standard deviation in pixels. 
  P0      [Optional] is the initial point [line column], around this point, M 
          values are selected to create the time history speckle pattern. If this parameter
          is not used, then a graphic window is enabled to the selection of a point P0.
  HG      [Optional] is the used graphic handler; Additionally, it is enable the graphic 
          selection of a point P0 in the figure pointed by the graphic handler.
  MAT     [Optional] is a matrix thats enable the graphic 
          selection of a point P0 in the figure created of imagesc the MAT.
  Show    [Optional] can be used in the last position of input, and its function 
          is used to enable a graphic output of the selected points that formed the
          THSP. Show='on', Show='on-red', Show='on-green' or Show='on-blue' to enable. 
          It is disabled in other cases, by default Show='off'.
          Show='on' plot the points in the color red, in other cases are used the
          specified colors.

  Output:
  Y      is the time history speckle pattern. Where, Y is a 2D matrix with
         M lines and NTIMES columns.
  POINTS [Optional] is a matrix with two columns and 
         M lines. Thus, each line represents one point in study, (line,column).


  For help, bug reports and feature suggestions, please visit:
  http://nongnu.org/bsltl/




# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80

  This function creates the THSP (Time History Speckle Pattern)[1][2] 
  of a



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 9
thsp_line


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 1940

  This function creates the THSP (Time History Speckle Pattern)[1][2] of a set 
  of pixels in a line in a data pack (DATA), (This function is an alias of 
  thsp() function).

  References:
  [1]  OULOMARA, G.; TRIBILLON, J.; DUVERNOY, J. Biological activity measurements 
       on botanical specimen surfaces using a temporal decorrelation effect of 
       laser speckle. Journal of Moderns Optics, London, v. 36, n. 2, p. 136-179, 
       Feb. 1989.

  [2]  XU, Z.; JOENATHAN, C.; KHORANA, B. M. Temporal and spatial properties of 
       the time-varying speckles of botanical specimens. Optical Enginnering, Virginia, 
       v. 34, n. 5, p. 1487-1502, May 1995.

  After starting the main routine just type the following command at the
  prompt:
  Y = thsp_line(DATA,R,S);
  
  Input:
  DATA is the speckle datapack. Where DATA is a 3D matrix created grouping NTIMES 
       intensity matrices with NLIN lines and NCOL columns. When N=size(DATA), then
       N(1,1) represents NLIN and
       N(1,2) represents NCOL and
       N(1,3) represents NTIMES.
  R    is a parameter of analysis: 
       if R is equal to 1, you choose the lines from the images to create the THSP and
       if R is equal to 2, you choose the columns of images to create the THSP.
       In other cases it returns error.
  S    is the line or column position used to create the time history speckle pattern.
       The function do not verify if S is in the range, this must be checked by the user.

  Output:
  Y    is the time history speckle patterns matrix. Where Y is a 2D matrix with
       M lines and NTIMES columns, being M equal to NCOL when R is 1 and M equal 
       to NLIN when R is 2.
       Y is a matrix where each column is a representation of one only line or column 
       in the S position of DATA.


  For help, bug reports and feature suggestions, please visit:
  http://nongnu.org/bsltl/




# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80

  This function creates the THSP (Time History Speckle Pattern)[1][2] of a set



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 11
thsp_random


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 1877

  This function creates the THSP (Time History Speckle Pattern)[1][2] of a set
  of  M points (pixels) randomly (Uniform) selected in DATA(:,:,1), and through 
  DATA(:,:,k) for all k value.

  References:
  [1]  OULOMARA, G.; TRIBILLON, J.; DUVERNOY, J. Biological activity measurements 
       on botanical specimen surfaces using a temporal decorrelation effect of 
       laser speckle. Journal of Moderns Optics, London, v. 36, n. 2, p. 136-179, 
       Feb. 1989.

  [2]  XU, Z.; JOENATHAN, C.; KHORANA, B. M. Temporal and spatial properties of 
       the time-varying speckles of botanical specimens. Optical Engineering, Virginia, 
       v. 34, n. 5, p. 1487-1502, May 1995.

  After starting the main routine just type the following command at the
  prompt:
  Y         = thsp_random(DATA, M);
  [Y POINTS]= thsp_random(DATA, M);
  [Y POINTS]= thsp_random(DATA, M, 'on');
  
  Input:
  DATA    is the speckle data pack. Where DATA is a 3D matrix created grouping NTIMES 
          intensity matrices with NLIN lines and NCOL columns. When N=size(DATA), then
          N(1,1) represents NLIN and
          N(1,2) represents NCOL and
          N(1,3) represents NTIMES.
  M       is the number of points, randomly selected, in analysis.
  Show    [Optional] can be used in the last position of input, and its
          function is to enable a graphic outcome of selected points in the
          THSP. Show='on' to enable. And disable in other cases, by default Show='off'.

  Output:
  Y      is the time history speckle pattern. Where Y is a 2D matrix with
         M lines and NTIMES columns.
  POINTS [Optional] is a matrix with two columns and 
         M lines. Thus, each line represents one point under study. (line,column).


  For help, bug reports and feature suggestions, please visit:
  http://nongnu.org/bsltl/




# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80

  This function creates the THSP (Time History Speckle Pattern)[1][2] of a set





