vmul(1)

PROGRAM
vmul - Multiply two images pixel by pixel.

SYNTAX

vmul

-i1 first input image

-i2 second input image

-o  resulting output image

[-m]
    multiply operation masking image

[-j]
    Complex arithmetic [True] Scalar [False]

[-V]
    Gives the version for vmul

[-U]
    Gives the usage for vmul

[-P]
    Prompts for command line options

[-A [file1]]
    Creates the answer file called vmul.ans or file1

[-a [file1]]
    Uses vmul.ans or file1 as the answer file

DESCRIPTION
vmul computes the product of the two input images on a pixel by pixel basis. The optional input mask image is used to gate the operation.

The two input images must be of the same size and have the same number of data bands, as must the optional mask image. The input images may be of the same or different data types. If the input images are of different data types, then all input images will be upcast to the highest input image data type. The output image data type will be the same as that of the highest data type of the input images.

The optional mask (gating) image will be upcast to the highest data type of the input images. The mask image is used to gate the operation. A non-zero mask pixel enables the output pixel to contain the result of the division. A zero mask pixel just transfers the value of the corresponding pixel in the first input image to the output pixel.

REQUIRED ARGUMENTS

-i1 type: infile
    desc: first input image

-i2 type: infile
    desc: second input image

-o  type: outfile
    desc: resulting output image

OPTIONAL ARGUMENTS

-m  type: infile
    desc: multiply operation masking image

-j  type: boolean
    desc: Complex arithmetic [True] Scalar [False]
    default: true

EXAMPLES
vmul -i1 input.image1 -i2 input.image2 -o output.image -m mask.image -j 0

Multiply input.image1 by input.image2 using a mask image and store the result in output.image. The "-j 0" specifies not to use complex arithmetic.

SEE ALSO
intro(1), verror(3), vgparms(3), vutils(3), lvmul(3) vcast(1)

RESTRICTIONS
vmul will not operate on:
    Bit
data storage types.

COPYRIGHT
Copyright 1991, University of New Mexico. All rights reserved.