DATAMANIP (kdatamanip) functions


LIBRARY ROUTINE

lkimpulse - generate impulse value data

LIBRARY CALL

int lkimpulse(int w, int h,
              int d, int t,
              int e, int wsp,
              int hsp, int dsp,
              int tsp, int esp,
              int w_num, int h_num,
              int d_num, int t_num,
              int e_num, int w_off,
              int h_off, int d_off,
              int t_off, int e_off,
              double imp_rval, double imp_ival,
              double back_rval, double back_ival,
              int data_type, kobject dst_obj)

INPUT

OUTPUT

RETURN VALUE

TRUE (1) on success, FALSE (0) otherwise

DESCRIPTION

This routine creates impulses at locations controlled by the various parameters passed to it. The value segment is created if one does not already exist and is set to size w*h*d*t*e. The datatype of the value segment is set according to the variable data_type. It can be either one of bit, byte, unsigned byte, short, unsigned short, integer, unsigned integer, long, unsigned long, float, double, complex and double complex. The value assumed by the impulse generated can be specified by imp_rval and imp_ival which denote its real and imaginary component respectively. The value assumed by the background can also be specified by the back_rval and back_ival parameters which denote it's real and imaginary components. Three parameters are available to control the location of the impulses. The spacing between two impulses, the starting point of the first impulse and the number of impulses can be specified for each of the five dimensions in the object.

ADDITIONAL INFORMATION

none

EXAMPLES

none

SIDE EFFECTS

If the value segment already exists, then all data will be overwritten with the impulse data of the specified datatype. The size of the object will also be changed to the size requested in the function call.

RESTRICTIONS

none

MODIFICATION

none

FILES

$DATAMANIP/objects/library/kdatamanip/src/lkimpulse.c

SEE ALSO

kdatamanip(3)

COPYRIGHT

Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.