DATAMANIP commands
PROGRAM NAME
kgsin - Generate Object Containing Sinusoidal Value Data
DESCRIPTION
kgsin
creates a data object with sinusoidal values of dimension
Width * Height * Depth * Time * Elements.
The data type of the value segment can be
bit, byte, unsigned byte, short, unsigned short, integer, unsigned integer,
long, unsigned long, float, double, complex and double complex. When
the desired data type is complex, the generated function is cos(w+h+d..) + j*sin(angle).
The sine wave generated can be either a sum of sine functions along all
five dimensions(-sin5) or the sine of the sum of the coordinates at a point
(-sin1). When the sum of sine functions is specified the output is generated
using the expression:
sin(w) + sin(h) + sin(d) + sin(t) + sin(e)
For the sine of sum option the function used for generating the output looks
like:
sin(w + h + d + t +e)
The number of sine waves and phase offset for each of the five dimensions can
be specified. The number of cycles along each dimension represents the number
of sine waves that will appear along each dimension. The phase offset
is specified in degrees. wnum sine cycles and a phase offset of wp
changes the argument to the sine generating function as follows:
sin(2*PI*wnum*w/width + wp) where width denotes the size of the width dimension.
The amplitude of the sinusoidal function can also be specified. It represents
the maximum value that each sine wave can take. In the case when a sum of sine
waves is being generated the amplitude along each dimension has to be specified.
The generated expression looks like:
ampl*sin(angle) or wampl*sin(wnum*w/width+ wp) + hampl*sin(angle) + ...
REQUIRED ARGUMENTS
- -o
-
type: outfile
desc: Output file containing sinusoidal value data
Mutually Exclusive Group; you must specify ONE of:
ALL OF the Mutually Inclusive Group:
- -sin1
-
type: flag
desc: Apply sine function to the sum of coordinates at a point
AND
- -ampl
-
type: double
desc: Maximum level of output
default: 1
bounds: no range checking
ALL OF the Mutually Inclusive Group:
- -sin5
-
type: flag
desc: Apply sine to each coordinate and sum up the result
AND
- -wampl
-
type: double
desc: Amplitude along the width direction
default: 1
bounds: no range checking
AND
- -hampl
-
type: double
desc: Amplitude along the height direction
default: 1
bounds: no range checking
AND
- -dampl
-
type: double
desc: Amplitude along the depth direction
default: 1
bounds: no range checking
AND
- -tampl
-
type: double
desc: Amplitude along the time direction
default: 1
bounds: no range checking
AND
- -eampl
-
type: double
desc: Amplitude along the element direction
default: 1
bounds: no range checking
OPTIONAL ARGUMENTS
- -wsize
-
type: integer
desc: Width size of sinusoidal value data
default: 512
bounds: value > 0
- -hsize
-
type: integer
desc: Height size of sinusoidal value data
default: 512
bounds: value > 0
- -dsize
-
type: integer
desc: Depth size of sinusoidal value data
default: 1
bounds: value > 0
- -tsize
-
type: integer
desc: Time size of sinusoidal value data
default: 1
bounds: value > 0
- -esize
-
type: integer
desc: Elements dimension size of sinusoidal value data
default: 1
bounds: value > 0
- -wnum
-
type: double
desc: Number of sine waves along width dimension
default: 1
bounds: value >= 0.0
- -wp
-
type: double
desc: Phase offset along width dimension
default: 0
bounds: -100 < [-wp] < 100
- -hnum
-
type: double
desc: Number of sine waves along height dimension
default: 1
bounds: value >= 0.0
- -hp
-
type: double
desc: Phase offset along the height dimension
default: 0
bounds: -100 < [-hp] < 100
- -dnum
-
type: double
desc: Number of sine waves along depth dimension
default: 1
bounds: value >= 0.0
- -dp
-
type: double
desc: Phase offset along depth dimension
default: 0
bounds: -100 < [-dp] < 100
- -tnum
-
type: double
desc: Number of sine waves along time dimension
default: 1
bounds: value >= 0.0
- -tp
-
type: double
desc: Phase Offset for time dimension
default: 0
bounds: -100 < [-tp] < 100
- -enum
-
type: double
desc: Number of sine waves along Elements Dimension
default: 1
bounds: value >= 0.0
- -ep
-
type: double
desc: Phase Offset in the elements dimension
default: 0
bounds: -100 < [-ep] < 100
- -type
-
type: list
desc: Data type of sinusoidal value data
default: 10 "float"
EXAMPLES
SEE ALSO
RESTRICTIONS
REFERENCES
COPYRIGHT
Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.