Parameter lists in detail:

FCNTRL

Operation control file

This file is read in by PROCMAT before processing of every batch of traces is performed. It may be output by the Matlab/Octave script before it exits, or it can be created manually and present permanently.

Each line of this file should contain a (case-insensitive) command determining requested actions by PROCMAT:

  1. STOP N: stop invoking the Matlab/Octave script after TRACEID = N (but continue passing the data through);

  3. START N: start invoking the Matlab/Octave script at or after TRACEID = N;

  5. RESTART N: following STOP, restart invoking the Matlab/Octave script at or after TRACEID = N;

  7. SKIP N: do not invoke the Matlab/Octave script for N subsequent sets of data traces.

Additional lines starting with '

Usage: FCNTRL TRACEID FNAME
2 parameters in this list:

TRACEID

 Integer header value (usually) or constant serving as trace ID by which the commands "stop", "start", or "restart" can be keyed.
  • Format: Trace Header (table entry), name, or numerical value (8 characters)
  • Default value: Not specified

FNAME

 Name of the control file.
  • Format: Character (80 characters)
  • Default value: Not specified

1 group of 2 REPEAT parameters per line:

Additional control commands. These commands override the contents of control file (interpreted as appended to the end of this file). For example, by adding command START )or STOP) with parameter N, you can make PROCMAT to start from (stop after) record TRACEID=N regardless of the instructions in control file

COMMAND

 Comand:
  • START - start processing from TRACEID=TRIDVAL
  • STOP - stop processing after TRACEID=TRIDVAL.
    •
    • Format: Selection
    • Selectable Values: (codes in parentheses)
      • Start ( START)
      • STOP ( STOP)
    • Default value: START

    TRIDVAL

    		 Value of TRACEID at which the command is applied
    • Format: Trace Header (table entry), name, or numerical value (8 characters)
    • Default value: Not specified

    FHDRIN

    Input file for trace headers

    Specifies a name of additional text file name input into Matlab/Octave (Not implemented)

    Usage: FHDRIN FNAME
    1 parameter in this list:

    FNAME

    		 File name
    • Format: Character (88 characters)
    • Default value: Not specified

    Preceding list (FCNTRL)

    FHDROUT

    Output file for trace headers

    Specifies the name of text file expected to be output by Matlab/Octave program and loaded into output trace headers.

    This file can be viewed as a log of interactive editing (for example, time picking) process. Each line in this file should contain one or several triplets of string tokens separated by spaces or tabs. Each triplet is interpreted as follows:

    1. Number of trace record to which the value refers;
    3. Name of the attribute (INDEX in Repeat list below) edited at this step;
    5. Keyword indicating the operation applied to the attribute (case-insensitive): SET, ADD, SUBTRACT, MULTIPLY, DIVIDE. If the key word is skipped (i.e., only one string token left), SET is assumed.
    7. New value of the edited attribute.

    Examples: 1 fbreak set 111.222 static set 4.555
    1 chan set 1

    If only two tokens are given in a line, keyword "SET" is assumed. Additional lines starting with '

    Usage: FHDROUT FNAME
    1 parameter in this list:

    FNAME

    		 File name
    • Format: Character (88 characters)
    • Default value: Not specified

    1 group of 2 REPEAT parameters per line:

    HEADER

    		 Trace header into which the value will be loaded after the processing Octave/matlab script returns. This trace header must be defined prior to entering PROCMAT. For example, you can define this header by using list SET in tool HDRMATH.
    • Format: Character (8 characters)
    • Default value: Not specified

    INDEX

    		 Text string (key word) identifying the values for this header in the input file
    • Format: Character (80 characters)
    • Default value: Not specified

    Preceding list (FHDRIN)

    FTRCOUT

    Output file for trace data

    Specifies the name of text file expected to be output by Matlab/Octave program and loaded into output trace records

    This file should be formatted in the following way:

    1. Keyword TRC (or TRACE, REC, or RECORD) followed by two integers: NTRC and NCOMP, where NTRC is the sequence number of the trace record to which the following values refer (starting from 1, default value 1), and NCOMP is the trace component number (starting from 1, default value 1).
    3. Pairs of values

    Additional lines starting with '

    Usage: FTRCOUT FNAME
    1 parameter in this list:

    FNAME

    		 File name
    • Format: Character (88 characters)
    • Default value: Not specified

    Preceding list (FHDROUT)

    HEADERS

    Trace header variables

    This list should follow WORKIN, WORKOUT, FILIN, or FILEOUT. For the corresponding input or output workspaces, it specifies the trace header records included in them.

    Usage: HEADERS PREFIX
    1 parameter in this list:

    PREFIX

    		 Prefix of the name of the variable in Matlab/Octave program. With this prefix, the trace record will be named "_val", its mapping to segments "_segm", and names of the segments "_name"
    • Format: Character (16 characters)
    • Default value: Not specified

    1 group of 3 REPEAT parameters per line:

    HEADER

    		 Trace header into which the value will be loaded after return from processing shell
    • Format: Character (8 characters)
    • Default value: Not specified

    INDEX

    		 Integer index associated with this attribute. Thi sindex is used for loading this field from file FILEOUT.
    • Format: Trace Header (table entry), name, or numerical value (8 characters)
    • Default value: Not specified

    LABEL

    		 Text string assigned as the value of variable "_name"
    • Format: Character (72 characters)
    • Default value: Not specified

    Preceding list (FTRCOUT)

    MAXTRC

    Maximum number of traces

    Restricts the maximum number of traces allowed in Matlab/Octave scripts. When this number is reached or exceeded, the script is executed as in Ensemble input mode

    Usage: MAXTRC NUM
    1 parameter in this list:

    NUM

    		 Maximum number of traces allowed for passing into Matlab/Octave.
    • Format: Trace Header (table entry), name, or numerical value (8 characters)
    • Default value: Not specified

    Preceding list (HEADERS)

    TRACES

    Trace records

    This list should follow WORKIN, WORKOUT, FILIN, or FILEOUT. For the corresponding input or output workspaces, it specifies the content of trace records in them.

    Usage: TRACES COMP TSTART TLENGTH PREFIX LABEL
    5 parameters in this list:

    COMP

    		 Trace component (counting from one)
    • Format: Trace Header (table entry), name, or numerical value (8 characters)
    • Min value: 1
    • Default value: 1

    TSTART

    		 Time start of the record (default - trace time start)
    • Format: Trace Header (table entry), name, or numerical value (8 characters)
    • Default value: Not specified

    TLENGTH

    		 Time length of the record (values <= 0 mean the whole trace)
    • Format: Trace Header (table entry), name, or numerical value (8 characters)
    • Default value: 0

    PREFIX

    		 Prefix of the name of the variable in Matlab/Octave program. With this prefix, the trace record will be named "_val", its mapping to segments "_segm", and names of the segments "_name"
    • Format: Character (16 characters)
    • Default value: Not specified

    LABEL

    		 Text label to identify the trace record in the interactive plot
    • Format: Character (56 characters)
    • Default value: Not specified

    Preceding list (MAXTRC)

    WORKDIR

    Work directory

    Specifies the work directory for Octave or Matlab codes. The file path to Octave/Matlab script in parameter COMMAND in the main tool call should be relative to this directory

    Usage: WORKDIR DIR
    1 parameter in this list:

    DIR

    		 Directory name
    • Format: Character (80 characters)
    • Default value: Not specified

    Preceding list (TRACES)

    WORKIN

    Input workspace

    Specifies the file name for workspace input into Matlab/Octave. The variables placed in this workspace are described by subsequent lists TRACES and VAR

    Usage: WORKIN FNAME
    1 parameter in this list:

    FNAME

    		 File name
    • Format: Character (80 characters)
    • Default value: Not specified

    1 group of 1 REPEAT parameter per line:

    Additional Matlab/Octave code (variables, functions, etc.) added after all variables specified in the workspace

    LINE

    		 One line of additional Matlab or Octave code
    • Format: Character (88 characters)
    • Default value: Not specified

    Preceding list (WORKDIR)

    WORKOUT

    Output workspace

    Specifies the file name for workspace output from Matlab/Octave and loaded into traces and headers (Not implemented yet)

    Usage: WORKOUT FNAME
    1 parameter in this list:

    FNAME

    		 File name
    • Format: Character (88 characters)
    • Default value: Not specified

    1 group of 1 REPEAT parameter per line:

    Additional Matlab/Octave code (variables, functions, etc.) added after all variables specified in the workspace

    LINE

    		 One line of additional Matlab or Octave code
    • Format: Character (88 characters)
    • Default value: Not specified

    Preceding list (WORKIN)
    IGeoS version 5.1
    Copyright (c) 1995-2015, I.B.Morozov
    Updated Wed Apr 1 21:42:08 2020