DATAMANIP commands


PROGRAM NAME

kneg - Output = 0.0 - Input

DESCRIPTION

Output = 0 - Input The Negative operator returns the negative (0 - value) of each data point in the input data object, Input. The data type of of the output data object, Output, will be the same as the data type of Input.

Executing Negative runs the program karith1 with the -neg flag.

Data Type The data type of the output object is the same as the input object's data type. Internally, the data is processed using one of the following: unsigned byte, long, unsigned long, double, or double complex. Data will not be cast to a lower type for processing.

Map Data If the input object contains a map, then the operation is performed on the map data. If the input object does not have a map but has value data, then the operation is performed on the value data.

Validity Mask If there is a validity mask associated with the input object, the mask is transferred to the output object. To decrease processing time, the operation will still be performed on those data that have corresponding mask values equal to zero. If the data under the mask is genuinely fInotfP processable, such as NaN or infinity, the user can specify that a value be substituted in place of the original value when it is accessed. The masked data substitution attributes for a data object can be explicitly set and stored using the fISet AttributefP operator, DATAMANIP::ksetdattr.

Explicit Location and Time Data If the input object has time data or location data, it is transferred to the output object.

Failure Modes This program fails if the input object lacks both map data and value data.

REQUIRED ARGUMENTS

-i
type: infile
desc: Input data object
-o
type: outfile
desc: Resulting output data object

OPTIONAL ARGUMENTS

none

EXAMPLES

SEE ALSO

DATAMANIP::karith1

RESTRICTIONS

Operations on complex data are not supported at this time.

REFERENCES

COPYRIGHT

Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.