Prev Up Next
Go backward to 7.1 An example batch file.
Go up to 7 Tcl functions for implementing wavefront reconstruction
Go forward to 7.3 Output of results.

7.2 ef_seq and related commands.

The command ef_seq is found in the file ef_process.tcl together with several other procedures, which together comprise the bulk of the Tcl data analysis functions. Three most important functions in this file are the ef_seq, ef_iter and ef_setup

7.2.1 Running a reduction sequence; ef_seq

This procedure performs a set sequence of iterations of the data reduction algorithm as defined by the current sequence choice. Automatic sequences are defined as a number of stages, each of which can be comprises of 1 or more iterations. The procedure takes 1 argument:
  1. ef_claude object
    Specifies the object for which the data reduction is to be carried out.
In addition the procedure uses the following global variables:
prog_param(iteration)
Initially sets this variable to zero, the value is incremented for each iteration of the algorithm.
prog_param(stage)
Set to the current stage of the automatic sequence.
prog_param(stage,iteration)
Set to the value of iteration in the current sequence step.
prog_param(zernike_list_increments)
Set to zero. This value serves no function at the moment.
efRunContinueRunning
Set to 1. If this value is set to zero, by the Stop button for example, the subroutine exits after completing the pending iteration cycle.
data_graphocity
Values in this array are read to determine if images should be displayed. The procedure does not modify these values.
prog_param(autoseq,...)
Variables matching this pattern are used to set define the automatic sequence, they are read but never changed by this subroutine.
prog_param(feedback_gain)
Set from the sequence instructions at the beginning of each step.
prog_param(signal_sum_clip_level)
Set from the sequence instructions at the beginning of each step.
prog_param(zernike_correct)
Set from the sequence instructions at the beginning of each step.

7.2.2 Setting up the data reduction; ef_setup

The command efRun re-initializes and sets up an ef_claude object for data reduction. The function takes 4 arguments:
  1. ef_claude object
    The name of a previously allocated ef_claude object . If this object has been used previously for a data reduction run, the results of that run will be cleared.
  2. ef_image
  3. ef_image
    These arguments are the names of two extra-focal image objects (ef_image objects) for which you wish to carry out the data reduction process. You should take care not to delete either of these objects while data reduction is in progress.
  4. true or false
    If this argument is set to the string true, the extra-focal images will be re-ordered so that the one with the smallest focus value becomes the pre-focus image. For any other value of this argument the argument 2 becomes the pre-focus image and argument 3 the post-focus image, independent of their true focus positions.

The ef_setup procedure uses values from the data_files and the prog_param tcl arrays to set up the ef_claude object. After setup the procedure runs the number of iterations of the reconstruction algorithm stored in the variable prog_param(iterations), this value may be set to zero if no iterations are desired.

The procedure sets the variable prog_param(iteration) to zero.

7.2.3 Performing algorithm iterations; ef_iter

This procedure performs a set number of iterations of the data reduction algorithm. The procedure takes 1 argument:
  1. Argument 1 ef_claude object
    Specifies the object for which the data reduction is to be carried out.
In addition the procedure reads the following global variables:
prog_param(iterations)
This variable should be set to the number of iterations that is required. The procedure does not modify this value.
data_graphocity
Values in this array are read to determine if images should be displayed. The procedure does not modify these values.
efRunContinueRunning
Set to 1. If this value is set to zero, by the Stop button for example, the subroutine exits after completing the pending iteration cycle.

Laplacian Optics Inc.     Email:   laplace@laplacian.com

Prev Up Next