BINDGEN

Syntax | Return Value | Arguments | Keywords | Examples | Version History | See Also

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.

Syntax

Result = BINDGEN(D₁ [, ...,D₈])

Return Value

This function returns a byte array with the specified dimensions.

Arguments

D_i

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 or array elements are not integer values, IDL will convert them to integer values before creating the new array.

Keywords

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.

Examples

To create a four-element by four-element byte array, and store the result in the variable A, enter:

A = BINDGEN(4,4)

Each element in A holds the value of its one-dimensional subscript. That is, if you enter the command:

PRINT, A

IDL prints the result:

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

Version History

See Also

CINDGEN, DCINDGEN, DINDGEN, FINDGEN, INDGEN, LINDGEN, SINDGEN, UINDGEN, UL64INDGEN, ULINDGEN