DATAMANIP commands


PROGRAM NAME

kphase - Output = Phase Component of Input [atan2(imaginary, real)]

DESCRIPTION

The Phase operator returns the phase of each complex data point in the input data object, Input. If the input data is not complex, the imaginary component is assumed to be zero.

The output object data type will be the same as the input (regarding single or double floats).

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.

Executing Phase runs the program kcmplx2real with the -op output option.

REQUIRED ARGUMENTS

-i
type: infile
desc: input data object
-op
type: outfile
desc: resulting output data object

OPTIONAL ARGUMENTS

none

EXAMPLES

SEE ALSO

DATAMANIP::kcmplx2real, DATAMANIP::kcmplx, DATAMANIP::kreal2cmplx

RESTRICTIONS

The input object data type must be COMPLEX or DOUBLE COMPLEX.

This program has not yet been updated to completely support the polymorphic data model.

REFERENCES

COPYRIGHT

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