--------------------------------------------------------------------------------
MODULE DTIEDIT

--------------------------------------------------------------------------------
REPLACES MATRIX module DTI

--------------------------------------------------------------------------------

FUNCTION

--------------------------------------------------------------------------------

FORMAT

--------------------------------------------------------------------------------

PROMPTS

--------------------------------------------------------------------------------

--------------------------------------------------------------------------------

DESCRIPTION

--------------------------------------------------------------------------------

--------------------------------------------------------------------------------

--------------------------------------------------------------------------------

DTIEDIT COMMANDS

_@ COMMAND

--------------------------------------------------------------------------------
_@

--------------------------------------------------------------------------------
FORMAT: _@ file-spec

--------------------------------------------------------------------------------
Command parameters:

--------------------------------------------------------------------------------
DESCRIPTION:

DTIEDIT offers the facility of command input from an indirect command file. The '@' character preceding a file-spec will cause DTIEDIT to open and read commands from the specified file until:

Nested command files are not supported (i_.e_. a command file containing an '@' command), although sequential '@' commands are supported when read from SYS$COMMAND.

As an aid to batch log interpretation DTIEDIT will echo all commands read from an indirect command file.

--------------------------------------------------------------------------------
Messages:

The following messages are specific to the _@ command:


*** ERROR *** Specifying command @
Command file specification is missing

*** ERROR *** Specifying command @
Unable to open indirect command file 'file-spec'

*** ERROR *** Specifying command @
Nested command files not supported

--------------------------------------------------------------------------------
Examples:


DTIEDIT> @DTIEDIT_EDITS
DTIEDIT> DISABLE BELL
DTIEDIT> ENABLE EDIT
DTIEDIT> RETURN
DTIEDIT>

_! COMMAND

--------------------------------------------------------------------------------
_!

--------------------------------------------------------------------------------
FORMAT: _! [comment text]

--------------------------------------------------------------------------------
Command parameters:

--------------------------------------------------------------------------------
DESCRIPTION:

An exclamation mark is the standard MATRIX package comment delimiter. All text (and numbers) which lie to the right of a '!' character are excluded from command interpretation. Comments are useful for annotating command procedures used in batch processing etc.

--------------------------------------------------------------------------------
Messages: None.

--------------------------------------------------------------------------------
Examples:


DTIEDIT> FILEIN TEST !open the file<CR>
DTIEDIT> !Define the screen width<CR>
DTIEDIT> SET SCREEN 132<CR>
DTIEDIT>

CHANGE COMMAND

--------------------------------------------------------------------------------
CHANGE

--------------------------------------------------------------------------------
FORMAT: CHANGE

--------------------------------------------------------------------------------
Command parameters: _None

--------------------------------------------------------------------------------
DESCRIPTION:

The CHANGE command transfers control from command line mode to keypad mode.
On giving the command, the DTI data is displayed on the screen as a series of characters. Each character represents a separate value step. The step interval is defined when the DTI file is first opened, or may be specifically set using the STEP command. The LIMITS command controls the range of data values that will be shown.
The ORIGIN command determines which area of the matrix will be displayed. The column and row specified with the ORIGIN command will appear in the bottom lefthand corner of the screen.

Once the matrix has been displayed, it is possible to move the cursor around the screen using the appropriate keypad commands. If the command ENABLE EDIT has been previously specified, it is also possible to interactively edit the DTI data values. The introductory section provides full details on available keypad commands.

Control may be transferred back to command line mode using the keypad key ',' or by using (pressing the Ctrl and Z keys together).

Note that the CHANGE command cannot be given from an indirect command file.

--------------------------------------------------------------------------------
Messages:

The following messages are specific to the CHANGE command:


*** ERROR *** Specifying command CHANGE
No DTI file has been defined

*** ERROR *** Specifying command CHANGE
Command not valid when reading from a command file

*** ERROR *** Specifying command CHANGE
Terminal is not a VT100 compatible display

--------------------------------------------------------------------------------
Examples:

DTIEDIT>CHANGE<CR>

DISABLE BELL COMMAND

--------------------------------------------------------------------------------
DISABLE BELL

--------------------------------------------------------------------------------
FORMAT: DISABLE BELL

--------------------------------------------------------------------------------
DESCRIPTION:

DISABLE BELL turns off the audible warning that is normally given when an attempt is made to move the screen cursor beyond the lefthand or righthand edge of the screen, or outside the bounds of the DTI data area.

The current status of the option may be examined using the SHOW DISPLAY command.

--------------------------------------------------------------------------------
Messages:

The following messages are specific to the DISABLE command:


*** ERROR *** Specifying command DISABLE
Command qualifiers are BELL or EDIT

--------------------------------------------------------------------------------
Examples:

DTIEDIT>DISABLE BELL<CR>
DTIEDIT>

DISABLE EDIT COMMAND

--------------------------------------------------------------------------------
DISABLE EDIT

--------------------------------------------------------------------------------
FORMAT: DISABLE EDIT

--------------------------------------------------------------------------------
Command parameters:
_None

--------------------------------------------------------------------------------
DESCRIPTION:

DISABLE EDIT is used to disable the editing of DTI data values. If EDIT is disabled, any attempt to change a data value using a command line EDIT command, or using the keypad key '-' in keypad mode, will be disallowed, and will cause the error message Edit option is not enabled to be displayed.

By default editing of the matrix is disabled, and if required must be enabled using the ENABLE EDIT command.

The current status of the option may be examined using the SHOW DISPLAY command. --------------------------------------------------------------------------------
Messages:

The following messages are specific to the DISABLE command:


*** ERROR *** Specifying command DISABLE
Command qualifiers are BELL or EDIT

--------------------------------------------------------------------------------
Examples:

DTIEDIT>DISABLE EDIT<CR>
DTIEDIT>

EDIT AREA COMMAND

--------------------------------------------------------------------------------
EDIT AREA

--------------------------------------------------------------------------------
FORMAT: EDIT AREA xmin ymin xmax ymax data_value

--------------------------------------------------------------------------------
Command parameters:

--------------------------------------------------------------------------------
DESCRIPTION:

The EDIT AREA command is used to change the value of all matrix points in a rectangular area to a specified value.

The coordinates of the defining rectangle must lie within the bounds of the DTI file data area.

Note, that as with all DTI edit commands, the edit is performed immediately and 'in situ' on the current DTI file.

--------------------------------------------------------------------------------
Messages:

The following messages are specific to the EDIT and EDIT AREA commands:


*** ERROR *** Specifying command EDIT
Command qualifiers are AREA, LINE, or POINT

*** ERROR *** Specifying command EDIT AREA
No DTI file has been defined

*** ERROR *** Specifying command EDIT AREA
The coordinates of the rectangle are out of range

*** ERROR *** Specifying command EDIT AREA
The top righthand point must exceed the bottom lefthand point

*** ERROR *** Specifying command EDIT AREA
The data value is missing

*** ERROR *** Specifying command EDIT AREA
The data value is invalid for the DTI data type

--------------------------------------------------------------------------------
Examples:

DTIEDIT>EDIT AREA 1 1 34 45 345<CR>
DTIEDIT>

EDIT LINE COMMAND

--------------------------------------------------------------------------------
EDIT LINE

--------------------------------------------------------------------------------
FORMAT: EDIT LINE xstart ystart xend yend data_value

--------------------------------------------------------------------------------
Command parameters:

--------------------------------------------------------------------------------
DESCRIPTION:

The EDIT LINE command is used to change the value of all matrix points along the defined line to a specified value.

The start and end points of the line must lie within the bounds of the DTI file data area.

Note, that as with all DTI edit commands, the edit is performed immediately and 'in situ' on the current DTI file.

--------------------------------------------------------------------------------
Messages:

The following messages are specific to the EDIT and EDIT LINE commands:


*** ERROR *** Specifying command EDIT
Command qualifiers are AREA, LINE, or POINT

*** ERROR *** Specifying command EDIT LINE
No DTI file has been defined

*** ERROR *** Specifying command EDIT LINE
The coordinates of the line are out of range

*** ERROR *** Specifying command EDIT LINE
The data value is missing

*** ERROR *** Specifying command EDIT LINE
The data value is invalid for the DTI data type

--------------------------------------------------------------------------------
Examples:

DTIEDIT>EDIT LINE 12 24 34 45 345<CR>
DTIEDIT>

EDIT POINT COMMAND

--------------------------------------------------------------------------------
EDIT POINT

--------------------------------------------------------------------------------
FORMAT: EDIT POINT x_coord y_coord data_value

--------------------------------------------------------------------------------
Command parameters:

--------------------------------------------------------------------------------
DESCRIPTION:

The EDIT POINT command is used to change the value of a single matrix point to a specified value.

The point must lie within the bounds of the DTI file data area.

Note, that as with all DTI edit commands, the edit is performed immediately and 'in situ' on the current DTI file.

--------------------------------------------------------------------------------
Messages:

The following messages are specific to the EDIT and EDIT POINT commands:


*** ERROR *** Specifying command EDIT
Command qualifiers are AREA, LINE, or POINT

*** ERROR *** Specifying command EDIT POINT
No DTI file has been defined

*** ERROR *** Specifying command EDIT POINT
The coordinates of the point are out of range

*** ERROR *** Specifying command EDIT POINT
The data value is missing

*** ERROR *** Specifying command EDIT POINT
The data value is invalid for the DTI data type

--------------------------------------------------------------------------------
Examples:

DTIEDIT>EDIT POINT 34 45 345<CR>
DTIEDIT>

ENABLE BELL COMMAND

--------------------------------------------------------------------------------
ENABLE BELL

--------------------------------------------------------------------------------
FORMAT: ENABLE BELL

--------------------------------------------------------------------------------
Command parameters:
_None

--------------------------------------------------------------------------------
DESCRIPTION:

ENABLE BELL selects the output of an audible warning when an attempt is made to move the screen cursor beyond the lefthand or righthand edge of the screen, or outside the bounds of the DTI data area.
An explanatory warning message is displayed on the bottom line of the screen.

By default the option is selected, and may be disabled using the DISABLE BELL command. --------------------------------------------------------------------------------
Messages:

The following messages are specific to the ENABLE command:


*** ERROR *** Specifying command ENABLE
Command qualifiers are BELL or EDIT

--------------------------------------------------------------------------------
Examples:

DTIEDIT>ENABLE BELL<CR>
DTIEDIT>

ENABLE EDIT COMMAND

--------------------------------------------------------------------------------
ENABLE EDIT

--------------------------------------------------------------------------------
FORMAT: ENABLE EDIT

--------------------------------------------------------------------------------
Command parameters:
_None

--------------------------------------------------------------------------------
DESCRIPTION:

ENABLE EDIT selects the option of editing matrix values. By default editing of the matrix is disabled. The ENABLE EDIT command must therefore be given in order to use the various command line EDIT commands, or in order to edit values when in keypad mode.
If an attempt to edit the matrix is made before the ENABLE EDIT command is given, an error message is generated.

The current status of the option may be examined using the SHOW DISPLAY command. --------------------------------------------------------------------------------
Messages:

The following messages are specific to the ENABLE command:


*** ERROR *** Specifying command ENABLE
Command qualifiers are BELL or EDIT

--------------------------------------------------------------------------------
Examples:

DTIEDIT>ENABLE EDIT<CR>
DTIEDIT>

EXIT COMMAND

--------------------------------------------------------------------------------
EXIT

--------------------------------------------------------------------------------
FORMAT: EXIT

--------------------------------------------------------------------------------
Command parameters:
None.

--------------------------------------------------------------------------------
DESCRIPTION:

The EXIT command is used to exit from DTIEDIT.
(pressing the Ctrl and Z keys together) may also be used to exit from the program.

If the values in the DTI file have been edited such that the minimum and maximum value range has been changed, the range values in the header of the DTI file will be updated before the file is closed.

--------------------------------------------------------------------------------
Messages:

The following message is specific to the EXIT command:


Updating minimum and maximum range values -  Please wait.

--------------------------------------------------------------------------------
Examples:

DTIEDIT>EXIT

$

FILEIN COMMAND

--------------------------------------------------------------------------------
FILEIN

--------------------------------------------------------------------------------
FORMAT: FILEIN file-spec

--------------------------------------------------------------------------------
Command parameters:

--------------------------------------------------------------------------------
DESCRIPTION:

The FILEIN command opens and maps into memory a DTI file.
Details derived from the header of the file are displayed on the terminal to confirm that the file has been successfully opened.

On reading a file, the values associated with the ORIGIN command are set to column 1, row 1, and the data value range in the file is used to calculate a default display step interval. The values associated with the LIMITS command are set to the minimum and maximum data values contained in the header.

--------------------------------------------------------------------------------
Messages:

The following error message is specific to the FILEIN command:


*** ERROR *** Specifying command FILEIN
Input DTI filename is missing

--------------------------------------------------------------------------------
Example:

DTIEDIT>FILEIN TEST


LSL$DTI:TEST.DTI	
Header: LSLA	 Data: WORD

Units are DTI Matrix Values

Matrix Coverage    SW:    1     1    NE:   301   251
Matrix Interval	    E:	  1	      N:     1
Value Range	     :      0   to    851


DTIEDIT>

HELP COMMAND

--------------------------------------------------------------------------------
HELP

--------------------------------------------------------------------------------
FORMAT: HELP command

--------------------------------------------------------------------------------
Command parameters:

--------------------------------------------------------------------------------
Description:

A brief description is given of the function and format of the specified command.

The information is extracted from the DTIEDIT section of the MATRIX help library, LSL$HELP:MATRIX.HLB.

If no parameter is specified, a list of all the commands available in DTIEDIT is displayed.

--------------------------------------------------------------------------------
Messages:

Where required, warning messages are output via the VMS LBR$OUTPUT_HELP utility.

--------------------------------------------------------------------------------
Examples:


DTIEDIT>HELP FILEIN<CR>


DTIEDIT

     FILEIN

     The FILEIN command opens and maps into memory a DTI file.
     Details derived form the header of the file are displayed on the 
     terminal to confirm that the file has been successfully opened.


DTIEDIT>

LIMITS COMMAND

--------------------------------------------------------------------------------
LIMITS

--------------------------------------------------------------------------------
FORMAT: LIMITS lower_value upper_value

--------------------------------------------------------------------------------
Command parameters:

--------------------------------------------------------------------------------
DESCRIPTION:

The LIMITS command is used to define lower and upper data display limits.

When the CHANGE command is given, any data value that lies below the lower limit is shown using the character '-', while a data value above the upper limit is shown as the character '+'.

By default the LIMITS values are set to the minimum and maximum data values in the DTI file, when the file is opened. The LIMITS command is used to change these defaults, while the RESET LIMITS command may be used to reset to the default values.

Note that if the data display range specified with the LIMITS command, when taken in conjunction with the current STEP value, results in the generation of more than 26 step intervals, the STEP value is adjusted appropriately.

After giving the LIMITS command, details of the current limits and step values, are shown on the terminal.

--------------------------------------------------------------------------------
Messages:

The following messages are specific to the LIMITS command:


*** ERROR *** Specifying command LIMITS
Command requires 2 integer arguments

*** ERROR *** Specifying command LIMITS
Upper value must exceed lower value

--------------------------------------------------------------------------------
Examples:

DTIEDIT>LIMITS 120 550<CR>


Display Origin      :     1      1

Data Display Limits :   120    550
Data Display Step   :    50

Screen Width        :    80
Warning Bell        :   Off

Edit of Data Values :   Off


DTIEDIT>

ORIGIN COMMAND

--------------------------------------------------------------------------------
ORIGIN

--------------------------------------------------------------------------------
FORMAT: ORIGIN x_coord y_coord

--------------------------------------------------------------------------------
Command parameters:

--------------------------------------------------------------------------------
DESCRIPTION:

The ORIGIN command is used to define the origin of the display. The coordinate values supplied with the command determine which area of the matrix will be displayed on the screen. The specified matrix point will appear at the bottom lefthand corner of the screen when the matrix is displayed using the CHANGE command.
The screen cursor will automatically be positioned on this point.

The coordinates supplied with the command must lie within the bounds of the DTI file.

The number of columns of data displayed is dependent on the size of the matrix and the current screen width defined using the SET SCREEN command.

--------------------------------------------------------------------------------
Messages:

The following messages are specific to the ORIGIN command:


*** ERROR *** Specifying command ORIGIN
Command requires 2 integer arguments

*** ERROR *** Specifying command ORIGIN
No DTI file has been defined

*** ERROR *** Specifying command ORIGIN
The coordinates of the origin are out of range

--------------------------------------------------------------------------------
Examples:

DTIEDIT>ORIGIN 120 50<CR>
DTIEDIT>

PRINT COMMAND

--------------------------------------------------------------------------------
PRINT

--------------------------------------------------------------------------------
FORMAT: PRINT number_columns number_rows [file-spec]

--------------------------------------------------------------------------------
Command parameters:

--------------------------------------------------------------------------------
DESCRIPTION:

The PRINT command is used to output the whole or part of the DTI file, either to a disk file, or to a printer on SYS$PRINT. The data values are output in the same classified form as they would appear on the screen if the CHANGE command is given.

The area output is determined by the current ORIGIN values, and by the parameter arguments.

The number of columns output may not exceed 132. The number of columns will be truncated if necessary. There is no restriction on the number of rows that may be output.

Current LIMITS and STEP values are used to determine the representation of the matrix values.

--------------------------------------------------------------------------------
Messages:

The following messages are specific to the PRINT command:


*** ERROR *** Specifying command PRINT
No DTI file has been defined

*** ERROR *** Specifying command PRINT
Number of columns exceeds 132
Number of columns will be truncated

--------------------------------------------------------------------------------
Examples:

DTIEDIT>PRINT 100 100<CR>
DTIEDIT>

RESET LIMITS COMMAND

--------------------------------------------------------------------------------
RESET LIMITS

--------------------------------------------------------------------------------
FORMAT: RESET LIMITS

--------------------------------------------------------------------------------
Command parameters:
None.

--------------------------------------------------------------------------------
DESCRIPTION:

The command RESET LIMITS is used to set the lower and upper matrix display limits to the minimum and maximum data values in the DTI file. The command is generally used to return to the default values, when the lower and upper display values have been previously set using the LIMITS command, or to set the limits to be equal to new DTI minimum and maximum values.

Note that if the data display range when taken in conjunction with the current STEP value, results in the generation of more than 26 step intervals, the STEP value is adjusted appropriately.

After giving the RESET LIMITS command, details of the current limits and step values, are shown on the terminal.

--------------------------------------------------------------------------------
Messages:

The following messages are specific to the RESET and RESET LIMITS commands:


*** ERROR *** Specifying command RESET
Command qualifiers are LIMITS, MINMAX or STEP

*** ERROR *** Specifying command RESET LIMITS
No DTI file has been defined

--------------------------------------------------------------------------------
Examples:

DTIEDIT>RESET LIMITS


Display Origin      :     1      1

Data Display Limits :   120    550
Data Display Step   :    50

Screen Width        :    80
Warning Bell        :   Off

Edit of Data Values :   Off

DTIEDIT>

RESET MINMAX COMMAND

--------------------------------------------------------------------------------
RESET MINMAX

--------------------------------------------------------------------------------
FORMAT: RESET MINMAX

--------------------------------------------------------------------------------
Command parameters:
None.

--------------------------------------------------------------------------------
DESCRIPTION:

The command RESET MINMAX is used to determine the minimum and maximum data values in the DTI file. The command is generally used to recalculate the minimum and maximum range following a series of edit commands, and often preceding a RESET LIMITS command. The newly determined values are written to the header of the DTI file.

Note, that if any edits are performed on the DTI file, and no RESET MINMAX command is given before the EXIT command is used, the minimum and maximum data values will be calculated before closing the DTI file.

The message Determining minimum and maximum values - please wait indicates that the data values are being calculated.

After giving the RESET MINMAX command, details from the DTI header are output to the terminal.

--------------------------------------------------------------------------------
Messages:

The following messages are specific to the RESET and RESET MINMAX commands:


*** ERROR *** Specifying command RESET
Command qualifiers are LIMITS, MINMAX or STEP

*** ERROR *** Specifying command RESET MINMAX
No DTI file has been defined

--------------------------------------------------------------------------------
Examples:

DTIEDIT>RESET MINMAX


LSL$DTI:TEST.DTI	
Header: LSLA	 Data: WORD

Units are DTI Matrix Values

Matrix Coverage    SW:    1     1    NE:   301   251
Matrix Window      SW:    1     1    NE:   200   200
Matrix Interval	    E:	  1	      N:     1
Value Range	     :      0   to    851

DTIEDIT>

RESET STEP COMMAND

--------------------------------------------------------------------------------
RESET STEP

--------------------------------------------------------------------------------
FORMAT: RESET STEP

--------------------------------------------------------------------------------
Command parameters:
None.

--------------------------------------------------------------------------------
DESCRIPTION:

The command RESET STEP is used to calculate a default display step interval. The step interval is calculated using the the current lower and upper limit values. The procedure involves divided the current limit range by 26.

After giving the RESET STEP command, details of the current limits and step values, are shown on the terminal.

--------------------------------------------------------------------------------
Messages:

The following messages are specific to the RESET and RESET STEP commands:


*** ERROR *** Specifying command RESET
Command qualifiers are LIMITS, MINMAX or STEP

*** ERROR *** Specifying command RESET STEP
No DTI file has been defined

--------------------------------------------------------------------------------
Examples:

DTIEDIT>RESET STEP


Display Origin      :     1      1

Data Display Limits :   120    550
Data Display Step   :    50

Screen Width        :    80
Warning Bell        :   Off

Edit of Data Values :   Off

DTIEDIT>

RETURN COMMAND

--------------------------------------------------------------------------------
RETURN

--------------------------------------------------------------------------------
FORMAT: RETURN

--------------------------------------------------------------------------------
Command parameters: None.

--------------------------------------------------------------------------------
DESCRIPTION:

Restores command input from an indirect command file to SYS$COMMAND.

A typical application is to use an indirect command file to set up a number of run time defaults for a flowline, and then return to input from the terminal for the run specific commands. To do this RETURN must be the last command in the indirect command file.

A RETURN command is only valid if present in a command file.

--------------------------------------------------------------------------------
Messages:

The following messages are specific to the RETURN command:


*** ERROR *** Specifying command RETURN
The RETURN command is only valid in a command file

Returning to terminal input

--------------------------------------------------------------------------------
Examples:


DTIEDIT> @SETUP<CR>
DTIEDIT> ENABLE EDIT
DTIEDIT> DISABLE BELL
DTIEDIT> RETURN
Returning to terminal input
DTIEDIT>

SET SCREEN COMMAND

--------------------------------------------------------------------------------
SET SCREEN

--------------------------------------------------------------------------------
FORMAT: SET SCREEN width

--------------------------------------------------------------------------------
Command parameters:

--------------------------------------------------------------------------------
DESCRIPTION:

The SET SCREEN command is to change the the width of the terminal screen. A width of 80 or 132 characters may be selected. The width value is used when the matrix values are displayed on the screen using the CHANGE command.

The current screen width may be examined using the SHOW DISPLAY command.

--------------------------------------------------------------------------------
Messages:

The following error messages are specific to the SET and SET SCREEN commands:


*** ERROR *** Specifying command SET
Command qualifier is SCREEN

*** ERROR *** Specifying command SET SCREEN
Command requires an integer argument

*** ERROR *** Specifying command SET SCREEN
Valid screen widths are 80 or 132

--------------------------------------------------------------------------------
Examples:

DTIEDIT> SET SCREEN 132
DTIEDIT>

SHOW DISPLAY COMMAND

--------------------------------------------------------------------------------
SHOW DISPLAY

--------------------------------------------------------------------------------
FORMAT: SHOW DISPLAY

--------------------------------------------------------------------------------
Command parameters:
None.

--------------------------------------------------------------------------------
DESCRIPTION:

The command SHOW DISPLAY may be used to examine the current status of the parameters that control how the DTI data values will be displayed on the screen.

Information on the ORIGIN, LIMITS, and STEP, along with details of the screen width is given. The status of the BELL and EDIT options are shown.

--------------------------------------------------------------------------------
Messages:

The following message is specific to the command SHOW:


*** ERROR *** Specifying command SHOW
Command qualifiers are DISPLAY or FILEIN

--------------------------------------------------------------------------------
Examples:

DTIEDIT>SHOW DISPLAY


Display Origin      :     1      1

Data Display Limits :   120    550
Data Display Step   :    50

Screen Width        :    80
Warning Bell        :   Off

Edit of Data Values :   Off

DTIEDIT>

SHOW FILEIN COMMAND

--------------------------------------------------------------------------------
SHOW FILEIN

--------------------------------------------------------------------------------
FORMAT: SHOW FILEIN

--------------------------------------------------------------------------------
Command parameters:
None.

--------------------------------------------------------------------------------
DESCRIPTION:

Details extracted from the header of the DTI file are displayed on the terminal.

The header values are shown in the current units of measurement.

--------------------------------------------------------------------------------
Messages:

The following messages are specific to the commands SHOW and SHOW FILEIN:


*** ERROR *** Specifying command SHOW
Command qualifiers are DISPLAY, FILEIN

*** WARNING *** The input DTI file is undefined

--------------------------------------------------------------------------------
Examples:

DTIEDIT>SHOW FILEIN


LSL$DTI:TEST.DTI	
Header: LSLA	 Data: WORD

Units are DTI Matrix Values

Matrix Coverage    SW:    1     1    NE:   301   251
Matrix Window      SW:    1     1    NE:   200   200
Matrix Interval	    E:	  1	      N:     1
Value Range	     :      0   to    851


DTIEDIT>

SPAWN COMMAND

--------------------------------------------------------------------------------
SPAWN

--------------------------------------------------------------------------------
FORMAT: SPAWN command-line

--------------------------------------------------------------------------------
Command parameters:

--------------------------------------------------------------------------------
DESCRIPTION:

The SPAWN command enables you to create a subprocess while within DTIEDIT. When the subprocess terminates, control is returned to DTIEDIT.

--------------------------------------------------------------------------------
Messages:

The following error messages are specific to the SPAWN command:


*** ERROR *** Specifying command SPAWN 
Command requires a valid DCL command line

*** ERROR *** Specifying command SPAWN 
DCL command line cannot exceed 80 characters

*** ERROR *** Unable to spawn command, returning to DTIEDIT

--------------------------------------------------------------------------------
Examples:

DTIEDIT> SPAWN DIRECTORY LSL$DTI:*_._DTI

Directory DUA3:[LSL.DTI]
TEST1_.DTI;1              8/8       18-AUG-1987 07:56  [LSL,DAVEC]
TEST2_.DTI;1              7/8       18-AUG-1987 17:17  [LSL,DAVEC]
TEST2_.DTI;2              7/8       18-AUG-1987 17:34  [LSL,DAVEC]
Total of 3 files, 22/24 blocks.

DTIEDIT>

STEP COMMAND

--------------------------------------------------------------------------------
STEP

--------------------------------------------------------------------------------
FORMAT: STEP step_interval

--------------------------------------------------------------------------------
Command parameters:

--------------------------------------------------------------------------------
DESCRIPTION:

The command STEP is used to set a display step interval, and therefore to classify the data into a series of value ranges. When the CHANGE command is given a different letter will be used by used to display each step range.

A default step interval is calculated when the DTI file is first opened, or when the RESET STEP command is given, using the lower and upper limit values. This default may be changed using the STEP command.

Note that if the step interval value, taken in conjunction with the current lower and upper display limit values, results in the generation of more than 26 step intervals, the upper limits value is adjusted appropriately.

After giving the STEP command, details of the current limits and step values, are shown on the terminal.

--------------------------------------------------------------------------------
Messages:

The following messages are specific to the STEP command:


*** ERROR *** Specifying command STEP
Command requires an integer argument

*** ERROR *** Specifying command STEP
Command requires a positive integer argument

--------------------------------------------------------------------------------
Examples:

DTIEDIT>STEP 100


Display Origin      :     1      1

Data Display Limits :   120    550
Data Display Step   :   100

Screen Width        :    80
Warning Bell        :   Off

Edit of Data Values :   Off

DTIEDIT>

SUBSTITUTE COMMAND

--------------------------------------------------------------------------------
SUBSTITUTE

--------------------------------------------------------------------------------
FORMAT: SUBSTITUTE [ AREA xmin ymin xmax ymax ] old_value new_value

--------------------------------------------------------------------------------
Command parameters:

--------------------------------------------------------------------------------
DESCRIPTION:

The SUBSTITUTE command is used to replace all occurrences of a matrix data value with a new data value eg. using the command SUBSTITUTE 4 24, all matrix points with a value of 4 are replaced by a value of 24.

Using the AREA qualifier, substitution may be restricted to a rectangular area. The coordinates of the defining rectangle are supplied as command parameters, and must lie within the bounds of the DTI file data area. If the AREA qualifier is not present, substitution is performed on the total DTI file.

Note, that as with all DTI edit commands, the edit is performed immediately and 'in situ' on the current DTI file.

--------------------------------------------------------------------------------
Messages:

The following messages are specific to the SUBSTITUTE and SUBSTITUTE AREA commands:


*** ERROR *** Specifying command SUBSTITUTE
No DTI file has been defined

*** ERROR *** Specifying command SUBSTITUTE AREA
The coordinates of the rectangle are out of range

*** ERROR *** Specifying command SUBSTITUTE AREA
The top righthand point must exceed the bottom lefthand point

*** ERROR *** Specifying command SUBSTITUTE 
The data value is invalid for the DTI data type

--------------------------------------------------------------------------------
Examples:

DTIEDIT>ENABLE EDIT
DTIEDIT>SUBSTITUTE AREA 1 1 34 45 345 23<CR>
DTIEDIT>

UNITS COMMAND

--------------------------------------------------------------------------------
UNITS

--------------------------------------------------------------------------------
FORMAT: UNITS units

--------------------------------------------------------------------------------
Command parameters:

--------------------------------------------------------------------------------
DESCRIPTION:

The UNITS command controls in what format details from the header of the DTI are displayed, when the SHOW FILEIN command is given.
The command should be given after defining the input DTI file, since DTI matrix units are always used by default when a file is opened.

--------------------------------------------------------------------------------
Messages:

The following error messages are specific to the UNITS command:


*** ERROR *** Specifying command UNITS
Command qualifiers are MATRIX, METRES, SECONDS, LATLONG or PROJECTION

*** ERROR *** Specifying command UNITS
Command qualifier is invalid for the input file

--------------------------------------------------------------------------------
Examples:


DTIEDIT> UNITS MATRIX<CR>
DTIEDIT>

DTIEDIT examples

EXAMPLES

--------------------------------------------------------------------------------

EXAMPLES

$ DTIEDIT

DTIEDIT>FILEIN TEST

LSL$DTI:TEST.DTI	
Header: LSLA	 Data: WORD

Units are DTI Matrix Values

Matrix Coverage    SW:    1     1    NE:   301   251
Matrix Window      SW:    1     1    NE:   200   200
Matrix Interval	    E:	  1	      N:     1
Value Range	     :      0   to    851


DTIEDIT>ENABLE EDIT<CR>
DTIEDIT>EDIT AREA 1 1 50 50 50
DTIEDIT>EDIT AREA 30 30 40 40 200
DTIEDIT>EDIT LINE 1 1 10 10 100
DTIEDIT>PRINT 50 50
DTIEDIT>EXIT
Determining minimum and maximum values - please wait

$

In the example above command line mode is used to define the input DTI file; to enable the editing of the file; to perform three edits on the matrix data, and to print the results of the edit on the lineprinter.

The representation of 50 columns and 50 rows of the matrix, as it would appear on the lineprinter is shown below.


AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAADDDDDDDDDDDAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAADDDDDDDDDDDAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAADDDDDDDDDDDAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAADDDDDDDDDDDAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAADDDDDDDDDDDAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAADDDDDDDDDDDAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAADDDDDDDDDDDAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAADDDDDDDDDDDAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAADDDDDDDDDDDAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAADDDDDDDDDDDAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAADDDDDDDDDDDAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
ABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
BAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
 
 
DTI file: LSL$DTI:TEST.DTI      DTI window:  SW 1 1  NE 50 50
Character Values: =0 ,A = 1 to 50, Z=1251 to 1300, step=50

DTIEDIT messages

MESSAGES (OTHER)

--------------------------------------------------------------------------------

MESSAGES (OTHER)

In addition to the above messages which are generated by the program itself, other messages may be produced by by Laser-Scan libraries. In particular, messages may be generated by the DTI library or by the Laser-Scan I/O library, LSLLIB. DTI library messages are introduced by %DTI and are documented in the MATRIX Reference manual. LSLLIB messages are introduced by '%LSLLIB' and are generally self-explanatory. They are often used to explain the details of program generated errors.

If the cause of the error cannot be traced by the user, and Laser-Scan are consulted, then the output file should be preserved to facilitate diagnosis.