- Timestamp:
- 07/21/06 14:47:49 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/norme.html
r138 r142 696 696 </div> 697 697 698 <div id="file_comments"></div> 698 <div id="file_comments"> 699 calculate the norme of a field of vectors, then make a possible average. 700 Comment 1: The field of vector can be, 2d:xy, 3d: xyz or xyt, 701 4d: xyzt 702 Comment 2: 703 The calculation of the norme is made before the possible spatial or 704 temporal average because the average of the norme is not equal to the 705 norme of averages 706 707 </div> 699 708 700 709 … … 711 720 <div class="routine_details" id="_norme"> 712 721 713 <h2><a class="top" href="#container">top</a>norme </h2> 722 <h2><a class="top" href="#container">top</a>norme <span class="categories"> 723 Post traitment calculation 724 </span></h2> 714 725 715 726 <p class="header"> … … 717 728 718 729 <div class="comments"> 719 NAME:norme 720 721 PURPOSE: calcule la norme d''un champ de vecteurs, puis fait une 722 moyenne eventuelle. 723 Rq1: le champ de vecteur peut etre, 2d:xy, 3d: xyz ou xyt, 724 4d: xyzt 725 Rq2: le calcul de la norme est fait avant l''eventuelle 726 moyenne spatiale ou temporelle car la moyenne de la norme 727 n''est pas egale a la norme des moyennes. 728 729 CATEGORY: calcul de post traitement 730 731 CALLING SEQUENCE:res=norme(champ_de_vecteurs) 732 733 INPUTS:un tableau 2d, 3d ou 4d 734 735 KEYWORD PARAMETERS: 736 737 BOXZOOM: boxzoom sur laquelle moyenner (par defaut le domaine 738 selectionner par le dernier domdef effectue) 739 740 DIREC:'t' 'x' 'y' 'z' 'xy' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt' 741 'xzt' 'yzt' 'xyzt' directions selon lesquelles effectuer les 742 moyennes 743 744 OUTPUTS:tableau a tracer avec plt, pltz ou pltt. 745 746 COMMON BLOCKS: 747 common.pro 748 749 SIDE EFFECTS: 750 751 La norme est calculee aux points T. Pour faire ce calcul, on 752 moyenne les champs U et V aux points T avant de calculer la norme. 753 Au bord des cotes et du domaine, on ne peut pas calculer les 754 champs U et V aux points T, ces points sont donc a la valeur 755 !values.f_nan. 756 757 lorsqu''on fait le calcul sur un domaine geographique reduit, 758 les champs U et V ne comprennent pas forcement le meme nombre 759 de points. Dans ce cas on redecoupe U et V pour ne garder que 760 les points en commun. Au passage on refait un domdef qui 761 redefinit un domaine geographique sur lequel les champs U et V 762 sont extraits sur les meme points. 763 764 RESTRICTIONS: 765 766 pour savoir a quel type de tableau on a a faire, on teste la 767 taille de celui-ci et les dates donnees par time[0] et 768 time[jpt-1] pour savoir si il y a une dimension 769 temporelle. Avant de lancer norme s''assurer que time et jpt 770 sont bien definis comme il faut! 771 772 EXAMPLE: 773 774 pour calculer la moyenne de la norme des courants sur tout le 775 dommaine entre 0 et 50: 776 IDL> res=norme(un,vn,boxzoom=[0,50],dir='xyz') 777 </div> 778 779 730 </div> 731 732 <h3>Return value</h3><div class="preformat"> 733 Array to trace with plt, pltz or pltt. 734 </div> 780 735 781 736 … … 784 739 785 740 <h4 id="_norme_param_composanteu">composanteu 786 787 788 789 741 <span class="attr">in</span> 742 743 744 <span class="attr">required</span> 790 745 791 746 … … 794 749 </h4> 795 750 796 <div class="comments"></div> 751 <div class="comments"> 752 an 2d, 3d or 4d array 753 </div> 797 754 798 755 <h4 id="_norme_param_composantev">composantev 799 800 801 802 756 <span class="attr">in</span> 757 758 759 <span class="attr">required</span> 803 760 804 761 … … 807 764 </h4> 808 765 809 <div class="comments"></div> 766 <div class="comments"> 767 an 2d, 3d or 4d array 768 </div> 810 769 811 770 … … 827 786 </h4> 828 787 788 <div class="comments"> 789 boxzoom on which do the average (by default the domain selected 790 by the last domdef done) 791 </div> 792 793 <h4 id="_norme_keyword_DIREC">DIREC 794 795 796 797 798 799 800 801 802 </h4> 803 804 <div class="comments"> 805 't' 'x' 'y' 'z' 'xys' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt' 806 'xzt' 'yzt' 'xyzt' Direction on which do averages 807 </div> 808 809 <h4 id="_norme_keyword__extra">_extra 810 811 812 813 814 815 816 817 818 </h4> 819 829 820 <div class="comments"></div> 830 821 831 <h4 id="_norme_keyword_DIREC">DIREC 832 833 834 835 836 837 838 839 840 </h4> 841 842 <div class="comments"></div> 843 844 <h4 id="_norme_keyword__extra">_extra 845 846 847 848 849 850 851 852 853 </h4> 854 855 <div class="comments"></div> 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 822 823 824 <h3>Examples</h3><div class="preformat"> 825 To calculate the average of the norme of streams on all the domain 826 between 0 et 50: 827 IDL> res=norme(un,vn,boxzoom=[0,50],dir='xyz') 828 </div> 829 <h3>Version history</h3> 830 831 <h4>Version</h4><div class="preformat"> 832 $Id$ 833 </div> 834 <h4>History</h4><div class="preformat"></div> 835 836 837 <h3>Known issues</h3> 838 839 840 841 <h4>Restrictions</h4><div class="preformat"> 842 The norme is calculated on points TTo do this calculation, we average 843 field U and Von points T before calculate the norme. At the edge of 844 coast and of domain, we can not calculate fields U and V at points T, 845 that is why these points are at value !values.f_nan. 846 847 When we calculate on a reduce geographic domain, field U and V have not 848 necessarily the same number of point. In this case, we recut U and V to 849 keep only common points. We profit of this to redo a domdef which redefine 850 a geographic domain on which fields U and V are extracted on same points 851 852 853 To know what type of array we work with, we test its size and dates 854 gave by time[0] and time[jpt-1] to know if thee is a temporal dimension. 855 Before to start norme, make sure that time and jpt are defined how 856 they have to! 857 </div> 858 859 <h3>Other attributes</h3> 860 861 862 <h4>Uses routines</h4><div class="preformat"> 863 common.pro 864 </div> 876 865 877 866
Note: See TracChangeset
for help on using the changeset viewer.
