NCL Home > Documentation > Functions > General applied math

cfftf_frq_reorder

Reorders the data returned by cfftf.

Prototype

	function cfftf_frq_reorder (
		cf  : numeric   
	)

	return_val  :   typeof(x)

Arguments

The array as returned by cfftf.

Return value

A double array is returned if cf is double, otherwise a float array is returned.

Description

Reorder the array returned by cfftf so that the data span -0.5 to 0.5.

Caveat: The reordered data can not be input to cfftb.

Background from Paul Swarztrauber:

Historically, the continuous complex transform is defined on the interval -pi to pi with wave numbers -infinity to infinity. In its discrete form it is defined on the points x sub j = j2pi/N where

 
if N is  odd then j = -(N-1)/2,...,(N-1)/2
 
if N is even then j = N/2,...,N/2-1

These integer values also correspond to wave numbers k.

The confusion arises because the description of the transform is often defined with indices j=0,..,N-1 which is true but corresponds to an aliased transform and chosen simply because one does not have to separate the description into parts corresponding to even and odd integers. That is, it is chosen to simplify math presentation but confuses the heck out of individuals that actually have to use the transform.

Examples

Example 1

Reorder the complex frequency spectrum of Example 1 presented for cfftf. The issue is that the returned frq attribute is not monotonically increasing.

The simplest approach would be to replace the returned frequency attribute with values in the range 0 to 1 or create a new array containing the new values. Either is readily accomplished via
```
             cf@frq = (ispan(0,N-1,1)*1.0)/N
                    ; ============= or ========================
                  f = (ispan(0,N-1,1)*1.0)/N
```
The cf@frq or f could be used for the plot abscissa.

The convention is to use a frequency scale that spans -0.5 to 0.5. To accomplish this the returned values must be reordered.

             xf = cfftf_frq_reorder( cf )
             print(sprintf("%9.5f", xf@frq) +"    "+sprintf("%9.3f", xf(0,:))+"    "+sprintf("%9.3f", xf(1,:)) )