
dgpoiss(1)                   Khoros                    dgpoiss(1)

PROGRAM
     dgpoiss - Creates a Poisson distributed noise data set.

SYNTAX
     dgpoiss

     -o             resulting image

     [-i]           input value file (xviff file)

     [-trigger]     trigger input

     [-s]           number of vectors

     [-n]           number of points

     [-v]           variance

     [-x]           time

     [-d]           data processing direction (0 = down vectors,
                    1 = across bands)

     [-t]           lets user choose data type of image:
                     'float' (select data type),
                      or 'complex' (choose data type)
                       [default = float]

     [-V]           Gives the version for dgpoiss

     [-U]           Gives the usage for dgpoiss

     [-P]           Prompts for command line options

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

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

DESCRIPTION
     creates a one dimensional Poisson distributed noise data
     set.  The user can specify the variance, the time argument,
     and signal dimensions.

     The time argument represents a positive interval of time.
     Each element of the resulting data set represents the number
     of discrete events occuring within that time period.  The
     result is an integer data set.  To maintain consistency with
     other noise generators available in this package, the
     resulting data set can be of type float or complex.

     If a "value file" is specified, it will contain a kernel
     that describes the signal ensemble to be generated.  This is
     an viff format file.  The information will be contained in a
     single vector of float type information.  The row and column
     size information is irrelevant.  The format of the informa-
     tion is as follows:

     [<variance><time>]

     where each item enclosed in triangular brackets represents a
     single float.  The information set in square brackets is
     repeated as a group one per vector.

     For example if 2 vectors are specified, the first has a
     variance of 1.0 and a time argument of 3.0, the second vec-
     tor has a variance of 6.0 and a time argument of 4.0, the
     "parameter file" will look like this:

     band #1:  1.0 6.0
     band #2:  3.0 4.0

     The advantage of this "parameter file" is that it allows the
     creation of an ensemble of 1D signals that are independant
     of each other.  Number of data sets, number of points per
     data set, data type, and process direction must be entered
     on the command line, or the defaults can be taken.  If more
     data sets are requested than are specified in the parameter
     file, then an error will occur.  If fewer data sets are
     requested than are specified, then the unused parameters
     will be ignored.

     Data can be processed with either band or vector orienta-
     tion.  The default data processing direction is in the vec-
     tor direction.  This means that data stored in multiband
     format will be processed as a set of data sequences, where
     each sequence corresponds to a pixel location, and the
     points of each sequence are defined by the bands correspond-
     ing to that pixel location.  The direction of processing can
     be changed so that each band is processed as a signal
     (instead of each vector being a signal) by setting the -d
     option to 1.

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

REQUIRED ARGUMENTS
     -o     type: outfile
            desc: resulting image

OPTIONAL ARGUMENTS
     -i     type: infile
            desc: input value file (xviff file)

     -trigger
            type: infile
            desc: trigger input

     -s     type: integer
            desc: number of vectors
            default: 1
            bounds: value > 0

     -n     type: integer
            desc: number of points
            default: 256
            bounds: value > 0

     -v     type: float
            desc: variance
            default: 1
            bounds: value >= 0.0

     -x     type: float
            desc: time
            default: 1
            bounds: value >= 0.0

     -d     type: boolean
            desc: data processing direction (0 = down vectors, 1
            = across bands)
            default: true

     -t     type: string
            desc: lets user choose data type of image
            allowed values:
             'float' (select data type),
              or 'complex' (choose data type)

EXAMPLES
     dgpoiss -i params.xv -o noise.xv -t float -d 0
     dgpoiss -o test.xv -t complex -d 1

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

RESTRICTIONS
     can only generate VFF_TYP_FLOAT and VFF_TYP_COMPLEX type
     images.

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

Khoros                    Release: 1.0                          1

