pmultcst

Multiplies constant to image, graph or region map.

Synopsis

pmultcst cst [-m mask] [im_in|-] [im_out|-]

Description

pmultcst builds the new output im_out by multiplying the specified constant to each value of im_in.

For image, pmultcst multiplies the specified value to each pixel. The values are clipped if they are greater than the maximum possible value or lower than the minimum:

   val = pixel(im_in) * cst;
   if (val > MAX) pixel(im_out) = MAX;
   else if (val < MIN) pixel(im_out) = MIN;
   else pixel(im_out) = val;

For color or multispectral image, pmultcst is computed separately on each band.

For region map, pmultcst multiplies the specified value to each label.

For graph, pmultcst multiplies the specified value to each node value.

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

Parameters

cst is a real value.

Inputs

im_in: an image, a graph or a region map.

Outputs

im_out: an object of the same type as im_in.

Result

Returns SUCCESS or FAILURE.

For region map, returns the new higher label value.

Examples

Divides the tangram.pan pixel values by 2:

   pmultcst 0.5 tangram.pan a.pan

C++ prototype

Errc PMultCst( const Img2duc &im_in, Img2duc &im_out, float cst );

Version française

Multiplication par une constante des valeurs d'une image, d'un graphe ou d'une carte de région.

Author: Régis Clouard