<<prev file | next file >>    view single page | view frames    summary: fields | routine    details: routine

ToBeReviewed/CALCULS/

norme.pro

calculate the norme of a field of vectors, then make a possible average. Comment 1: The field of vector can be, 2d:xy, 3d: xyz or xyt, 4d: xyzt Comment 2: The calculation of the norme is made before the possible spatial or temporal average because the average of the norme is not equal to the norme of averages

topnorme Post traitment calculation

result = norme(composanteu, composantev, BOXZOOM=BOXZOOM, DIREC=DIREC, _extra=_extra)

Return value

Array to trace with plt, pltz or pltt.

Parameters

composanteu        in required

an 2d, 3d or 4d array

composantev        in required

an 2d, 3d or 4d array

Keywords

BOXZOOM       

boxzoom on which do the average (by default the domain selected by the last domdef done)

DIREC       

't' 'x' 'y' 'z' 'xys' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt' 'xzt' 'yzt' 'xyzt' Direction on which do averages

_extra       

Examples

To calculate the average of the norme of streams on all the domain between 0 et 50: IDL> res=norme(un,vn,boxzoom=[0,50],dir='xyz')

Version history

Version

$Id: norme.pro 142 2006-07-21 12:47:49Z navarro $

History

Known issues

Restrictions

The norme is calculated on points TTo do this calculation, we average field U and Von points T before calculate the norme. At the edge of coast and of domain, we can not calculate fields U and V at points T, that is why these points are at value !values.f_nan. When we calculate on a reduce geographic domain, field U and V have not necessarily the same number of point. In this case, we recut U and V to keep only common points. We profit of this to redo a domdef which redefine a geographic domain on which fields U and V are extracted on same points To know what type of array we work with, we test its size and dates gave by time[0] and time[jpt-1] to know if thee is a temporal dimension. Before to start norme, make sure that time and jpt are defined how they have to!

Other attributes

Uses routines

common.pro
Produced by IDLdoc 2.0.