DATAMANIP commands


PROGRAM NAME

kclipbelow - Clip Data Values that are Below Specified Cutoff

DESCRIPTION

The Clip Below operator performs clipping on the Input data object (i), limiting the range of values in the object. Data values greater than or equal to the Cutoff Value (lc) remain the same, and values below the Cutoff Value are set to the Cutoff Value. If the Alternate Output value parameter (fval) is specified, clipped data are set to that value instead of the Cutoff Value.

The following histogram defines the results of the clipping operation.


                                |<-F->|<----T---->|
                                |     | :     .   |
                                |    .:.:.  .:::  |
                                |:. .::::::.::::: |
                                |::::::::::::::::.|
                                ------|------------
                                      Cutoff

T: if value >= Cutoff, Output = Input F: if value < Cutoff, Output = Cutoff (or Alternate Value)

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.

Executing Clip Below runs the program kclip with the -thresh option set to FALSE (-thresh 0).

REQUIRED ARGUMENTS

-i
type: infile
desc: Input file
-o
type: outfile
desc: output file

OPTIONAL ARGUMENTS

-lc
type: double
desc: Lower cutoff - values below lc are clipped
default: 128
bounds: no range checking
-fval
type: double
desc: Alternate value assigned to clipped output data
default: 0
bounds: no range checking

EXAMPLES

SEE ALSO

DATAMANIP::kclipabove, DATAMANIP::kclipin, DATAMANIP::kclipout, DATAMANIP::kmegaclip, DATAMANIP::kclip

RESTRICTIONS

REFERENCES

COPYRIGHT

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