
vgauss(1)                    Khoros                     vgauss(1)

PROGRAM
     vgauss - Create an image containing one or more Gaussians

SYNTAX
     vgauss

     -o             output image

     [-trigger]     trigger input

     [-c]           Number of Columns

     [-r]           Number of rows

     [-x]           X peak location

     [-y]           Y peak location

     [-vx]          X variance

     [-vy]          Y variance

     [-ra]          Rotation angle

     [-amp]         Peak Amplitude

     [-p]           Parameters input image

     [-n]           Normalize Gaussian(s)

     [-V]           Gives the version for vgauss

     [-U]           Gives the usage for vgauss

     [-P]           Prompts for command line options

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

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

DESCRIPTION
     vgauss generates an image that contains one or more Gaussian
     distributions. The bivariate mean and variance can be speci-
     fied along with a (possibly normalized) amplitude and rota-
     tion angle between the major and minor axes of the isocon-
     tour ellipse. These parameters can be specified on the com-
     mand line when only a single Gaussian is desired in the out-
     put image.  When multiple Gaussians are desired, the parame-
     ters are specified in a multiband image where the number of
     vectors in the image controls the number of Gaussians to be
     generated.

     For the multiple Gaussian case the parameters image should
     contain six bands: 1) X peak location, 2) Y peak location,
     3) X variance, 4) Y variance, 5) Rotation Angle, 6) Peak
     amplitude. All six bands must be present and be in the above
     order.

     If the normalize flag (-n) is set then the amplitude infor-
     mation (either from the command line of the parameter image)
     is ignored, and the proper amplitude is computed so that the
     Gaussian distribution is a probability distribution.

     The rotation angle argument controls the correlation between
     the variables in the distribution. The correleation coeffi-
     cient is the sine of this angle (in degrees). This angle
     must lie in the range of -90 < 0 < 90. Note that +/- 90
     degrees are EXCLUDED from the range since this is a degen-
     erate case.

     If the parameter image is supplied then the values it con-
     tains override all other distribution parameters except the
     normalize flag.

     -x : X peak location - defaults to 256
     -y : Y peak location - defaults to 256
     -vx : X variance - defaults to 30
     -vy : Y variance - defaults to 30
     -ra : Rotation angle - defaults to 0.0
     -amp : Peak amplitude - defaults to 1.0
     -n : Normalization flag - defaults to non-normalized
     -r : Number of rows - defaults to 512
     -c : Number of columns - defaults to 512

     The trigger input can be used to cause vgauss to re-execute
     when used inside cantata. No image is read from this input.

REQUIRED ARGUMENTS
     -o     type: outfile
            desc: output image

OPTIONAL ARGUMENTS
     -trigger
            type: infile
            desc: trigger input

     -c     type: integer
            desc: Number of Columns
            default: 512
            bounds: value > 0

     -r     type: integer
            desc: Number of rows
            default: 512
            bounds: value > 0

     -x     type: float
            desc: X peak location
            default: 256
            bounds: value >= 0.0

     -y     type: float
            desc: Y peak location
            default: 256
            bounds: value >= 0.0

     -vx    type: float
            desc: X variance
            default: 30
            bounds: value >= 0.0

     -vy    type: float
            desc: Y variance
            default: 30
            bounds: value >= 0.0

     -ra    type: float
            desc: Rotation angle
            default: 0
            bounds: -90.000000 < [-ra] < 90.000000

     -amp   type: float
            desc: Peak Amplitude
            default: 1
            bounds: no range checking

     -p     type: infile
            desc: Parameters input image

     -n     type: boolean
            desc: Normalize Gaussian(s)
            default: false

EXAMPLES
     vgauss -c 128 -r 128 -x 64 -y 64 -amp 5.0 -o test.xv

     This creates a 128 by 128 image with a maximum Gaussian
     amplitude of 5.0.  The resulting image will have the peak
     value located at coordinates 64,64, or the center of the
     image.  The default values of the variances for X and Y (30
     and 30) will be used in the generation of the image.

SEE ALSO
     intro(1), verror(3), vgparms(3), vutils(3), lvgauss(3)

RESTRICTIONS
     The output image is of type FLOAT.

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

Khoros                    Release: 1.0                          1

