Previous IDL Reference Guide: Procedures and Functions Next

BYTE

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

The BYTE function returns a result equal to Expression converted to byte type. If Expression is a string, each string is converted to a byte vector of the same length as the string. Each element of the vector is the character code of the corresponding character in the string. The BYTE function can also be used to extract data from Expression and place it in a byte scalar or array without modification, if more than one parameter is present. See Type Conversion Functions for details.

Syntax

Result = BYTE( Expression[Offset [D1[, ..., D8]]] )

Return Value

Returns a byte value or array of the same dimensions as the Expression. If Expression is a complex number, BYTE returns the real part.

Arguments

Expression

The expression to be converted to type byte.

Offset

The byte offset from the beginning of Expression. Specifying this argument allows fields of data extracted from Expression to be treated as byte data without conversion.

Di

When extracting fields of data, the Di arguments specify the dimensions of the result. If no dimension arguments are given, the result is taken to be scalar.

The Di arguments can be either an array or a series of scalar expressions. 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.

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.

Example

If the variable A contains the floating-point value 10.0, it can be converted to byte type and saved in the variable B by entering:

B = BYTE(A)  

Version History

Original
Introduced

See Also

COMPLEX, DCOMPLEX, DOUBLE, FIX, FLOAT, LONG, LONG64, STRING, UINT, ULONG, ULONG64

  IDL Online Help (March 06, 2007)