Interaction with other programs

The program is PEP-client. Thus it is started from under the shell of the packet execution program pktexec, which gives tools for setting the parameters, control of execution of the program and viewing the protocol of program operation.

Description

Session

Setting of parameters and start of the program are performed from under the shell of the packet execution program pktexec. The standard session consists of the following steps:

1. Setting of the project, the data directory of which contains the initial modification (menu item File - > Project...).
2. Start of the program from the menu of the VSP package.
3. Setting of the number of trace, for which it is necessary to do normalization. If the normalization should be done for all traces, this field should be empty.
4. Setting of coefficient of normalization. Usually coefficient is > 0 and < 1 to reduce the amplitude after execution of some processing programs. If the coefficient is < 0, the change of the traces polarity occurs. If the coefficient is equal to zero, a zeroing of traces takes place.
5. Start of the program on execution (button Start in the toolbar or menu item Gain - > Start).
6. To view the resulting modification it is necessary to press the button View for a name of output modification in the panel of results. To view the protocol of passing of the program it is necessary to press the button View log in the toolbar or to select the menu item Gain - > View log.
7. To exit the environment of the packet execution program it is necessary to press the buttonExit in the toolbar or to select the menu item File - > Exit.

Parameters of processing

Input parameters (panel Parameters)

Name: Data modification for gain
The type: nmod_s
The description: a name of the input modification

Name: Resulting data modification
The type: nmod_e
The description: a name of output modification. The name should be given in the form Sxxx, where xxx are the digits.

Name: Parametrs for gain
The type: float
The description: normalizing coefficient.

Information of an operating time of the program (panel Runtime)

Name: Current cable depth, m
The type: float
The description: current cable depth of the processed trace

Parameters of results (panel Results)

Name: Resulting data modification
The type: nmod_s
The description: a name of output modification

Name: Count of all input traces
The type: int
The description: the counter of input traces

Name: Count of actual input traces
The type: int
The description: the counter of output traces

User interface

For detailed acquaintance with the user interface of the shell of packet execution program, see the description of the program pktexec. An example of the shell window with the active panel of input parameters is shown below:

Input data

Traces

All traces of the given modification are moved to the input of the program

Output data

Traces

All actual traces are written down to the resulting file with a name of output modification. In these traces the values of samples within the effective times are multiplied by normalizing coefficient.

Requirements to the environment

Operational environment

The program gets the name of the operative project through the variable of environment PROJECT. If the program is started from under the shell, this condition is fulfilled by selection of the operative project.

The program determines the location of the system files of the packet from a variable VSPHOME, defined in the user`s profile or in the file setup in a home directory of the user of the package. In the file setup the given variable can appear also under the name of VSP.

Used files

The program searches for the definition of parameters in the files $VSPHOME/etc/Gain.pep and $VSPHOME/etc/vsp.pep.

The user`s home directory should contain a setup file. This file should contain paths to the directories of data, jobs and protocols of execution of the projects and also paths to the system files of the VSP package.

Other requirements

Other requirements are defined by the shell of the packet execution program pktexec.

Messages to the user

Bringing messages to the notice of the user

All messages are output in the standard stream of errors. If the program is started from under the interactive shell, the messages are saved to the file of the protocol of the transmission of the job LOG/$PROJECT/Gain-#.log. The messages of classes EL_FATAL and EL_ERROR are placed in the area of messages of the interactive shell after the program termination.

Description of the information messages

7.3. Description of the diagnostic messages