DATAMANIP commands
PROGRAM NAME
kprval - Print Data Value to Parser and/or Concatenate to File
DESCRIPTION
The Print Value operator (kprval) extracts a single data value
from the Input data object (i). The location of the value is based upon
the user indicated position within the specified data segment (Value, Map,
Mask, Location, or Time). The extracted data value can be assigned to a
Variable Name (var) via the parser. This is useful for variable assignment
within cantata, and can be used in any valid expression.
The extracted value can also be appended to an output file (o), which may
be useful for purposes such as tracking data during processing. If neither
the variable name nor the the output file is specified, the value will be
printed to standard out (kstdout).
The user can select which component of the polymorphic data model the
value will be extracted from. The components are Value Data (val), Map
Data (map), Mask Data (mask), Time Data (time), and Location Data (loc).
If Value Data is selected, and a map exists in the data object, the user can
specify whether the data should be mapped before the value is extracted.
The position of the data point can be specified by the offset values
Width (woff), Height (hoff), Depth (doff), Time (toff), and Elements (eoff).
If a Time Data point is being extracted, only the Time offset needs to
be specified.
If Location Data is selected, the Width, Height, and Depth offsets
can be specified, as well as a Dimension offset (dimoff).
The default position is the first point in the data set, located at position
0.
If the input object contains complex data, the real component of the
complex pair is returned.
REQUIRED ARGUMENTS
- -i
-
type: infile
desc: Input data object
Mutually Exclusive Group; you must specify ONE of:
- -val
-
type: flag
desc: operate on value data
OR
- -map
-
type: flag
desc: operate on map data
OR
- -mask
-
type: flag
desc: operate on mask data
OR
- -time
-
type: flag
desc: operate on time data
OR
ALL OF the Mutually Inclusive Group:
- -loc
-
type: flag
desc: operate on location data
AND
- -dimoff
-
type: integer
desc: offset of point along location dimension
default: 0
bounds: value >= 0
OPTIONAL ARGUMENTS
- -mapdata
-
type: boolean
desc: map value data through the map before processing
default: false
- -woff
-
type: integer
desc: offset of point along width dimension
default: 0
bounds: value >= 0
- -hoff
-
type: integer
desc: offset of point along height dimension
default: 0
bounds: value >= 0
- -doff
-
type: integer
desc: offset of point along depth dimension
default: 0
bounds: value >= 0
- -toff
-
type: integer
desc: offset of point along time dimension
default: 0
bounds: value >= 0
- -eoff
-
type: integer
desc: offset of point along elements dimension
default: 0
bounds: value >= 0
- -var
-
type: string
desc: Name of variable to which output value is assigned
default: {none}
- -o
-
type: outfile
desc: Output ASCII in which to append data value
default: {none}
EXAMPLES
SEE ALSO
RESTRICTIONS
REFERENCES
COPYRIGHT
Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.