Name

---

IMAG

Purpose

---

This function returns the imaginary component of a complex number.

Category

---

Mathematics

Calling Sequence

---

Result = IMAG( Z )

Inputs

---

Z: A scalar or array of type complex.

Outputs

---

Result: The imaginary component(s) of Z.

Procedure

---

This function runs the IDL function IMAGINARY. I just like the
shorter call name.

Example

---

Define a complex number.
z = 1. + 2 * im()
Extract the imaginary component of z.
result = imag( z )

Modification History

---

  Written by: Daithi A. Stone, 2000-06-09.