The BINDGEN function creates a byte array with the specified dimensions. Each element of the array is set to the value of its one-dimensional subscript, converted to type byte.

Example

As an example, create a four-element by four-element byte array and store the result in the variable A. Copy and paste the following code at the IDL command line:

A = BINDGEN(4,4)
PRINT, A

IDL prints:

   0   1   2   3
   4   5   6   7
   8   9  10  11
  12  13  14  15

Syntax

Result = BINDGEN(D1 [, ..., D8] [, INCREMENT=value] [, START=value])

Return Value

Returns an array of the specified dimensions where each element of the array is set to the value of its one-dimensional subscript.

Arguments

Di

Either an array or a series of scalar expressions specifying the dimensions of the result. If a single argument is specified, it can be either a scalar expression or an array of up to eight elements. If multiple arguments are specified, they must all be scalar expressions. Up to eight dimensions can be specified. If the dimension arguments are not integer values, IDL will convert them to integer values before creating the new array.

Keywords

INCREMENT

Set this keyword to a double-precision number giving the spacing between values in the array. The default is 1. Setting this keyword is equivalent to multiplying each array element by this value and then converting to the result type.

START

Set this keyword to a double-precision number giving the value of the first element in the array. The default is 0. Setting this keyword is equivalent to adding a constant offset to each element (after first multiplying by INCREMENT if necessary) and then converting to the result type.

Thread Pool Keywords

This routine is written to make use of IDL’s thread pool, which can increase execution speed on systems with multiple CPUs. The values stored in the !CPU system variable control whether IDL uses the thread pool for a given computation. In addition, you can use the thread pool keywords TPOOL_MAX_ELTS, TPOOL_MIN_ELTS, and TPOOL_NOTHREAD to override the defaults established by !CPU for a single invocation of this routine. See Thread Pool Keywords for details.

Version History

Original

Introduced

8.2.1

Added START keyword

8.3

Added INCREMENT keyword

See Also

BINDGEN, CINDGEN, DCINDGEN, DINDGEN, FINDGEN, INDGEN, L64INDGEN, LINDGEN, SINDGEN, UINDGEN, UL64INDGEN, ULINDGEN, MAKE_ARRAY