psubval

Subtracts constants stored in collection to image bands.

Synopsis

psubval [-m mask] [col_in|-] [im_in|-] [im_out|-]

Description

psubval builds the new output im_out by subtracting constants stored in the collection col_in to each band of the input image im_in. The first constant in the collection is subtracted to the first band, the second constant to the second, etc.

The values are clipped if they are greater than the maximum allowed value or lower than the minimum:

   val = pixel(im_in) - col_in;
   if (val > MAX) pixel(im_out) = MAX;
   else if (val < MIN) pixel(im_out) = MIN;
   else pixel(im_out) = val;

The output file is of the same type as the input file.

Inputs

col_in: a collection with a number of float values equals to the number of bands of the input image.
im_in: an image.

Outputs

im_out: an object of the same type as im_in.

Result

Returns SUCCESS or FAILURE.

Examples

Subtracts the mean value of tangram.pan image to tangram.pan:

   pmeanvalue tangram.pan col.pan
   psubval col.pan tangram.pan a.pan

More examples

C++ prototype

Errc PSubVal( const Collection &col_in, const Img2duc &im_in, Img2duc &im_out );

Version française

Soustraction d'une image avec des constantes stockées dans une collection.

Author: Régis Clouard