- 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/moyenne.html
r138 r142 696 696 </div> 697 697 698 <div id="file_comments"></div> 698 <div id="file_comments"> 699 averages a 2- or 3-d field over a selected 700 geographical area and along one ore more 701 selected axes (x, y or z) 702 </div> 699 703 700 704 … … 711 715 <div class="routine_details" id="_moyenne"> 712 716 713 <h2><a class="top" href="#container">top</a>moyenne </h2> 717 <h2><a class="top" href="#container">top</a>moyenne <span class="categories"> 718 </span></h2> 714 719 715 720 <p class="header"> … … 717 722 718 723 <div class="comments"> 719 NAME: moyenne 720 721 PURPOSE: averages a 2- or 3-d field over a selected 722 geographical area and along one ore more 723 selected axes (x, y or z) 724 725 CATEGORY: 726 727 CALLING SEQUENCE: result = moyenne(tab,'direc',BOXZOOM=boxzoom) 728 729 INPUTS: tab = 2 or 3d field 730 direc = 'x' 'y' 'z' 'xy' 'xz' 'yz' or 'xyz' 731 732 KEYWORD PARAMETERS: 733 734 BOXZOOM = [xmin,xmax,ymin,ymax (,(zmin,)zmax)] pour plus 735 de detail cf domdef. 736 boxzoom peut prendre 5 formes: 737 [vert2], [vert1, vert2],[lon1, lon2, lat1, lat2], 738 [lon1, lon2, lat1, lat2, vert2],[lon1, lon2, lat1, 739 lat2, vert1,vert2] 740 741 NAN: not a number, a activer si l''on peut faire veut 742 faire une moyenne sans tenir compte de certaines 743 valeurs masques de tab. 744 si les valeurs masques de tab sont la valeur consacree 745 par IDL (!values.f_nan), il suffit de mettre /NAN. 746 si les valeurs masques de tab on pour valeur a (a doit 747 etre differente de 1 (correspond a nan = 748 !values.f_nan) et de 0 (qui desactive nan) 749 il faut mettre NAN=a. 750 Rq: en sorties les points de result qui sont NAN 751 auront pour valeur a ou !values.f_nan. 752 753 NODOMDEF: activer si l''on ne veut pas passer ds 754 domdef bien que le mot cle boxzoom soit present (comme 755 c''est le cas qd moyenne est appelee via checkfield) 756 757 INTEGRATION: pour faire une integrale plutot qu''une moyenne 758 759 /WDEPTH: to specify that the field is at W depth instad of T 760 depth (automatically activated if vargrid eq 'W') 761 762 OUTPUTS: result:un tableau 763 764 COMMON BLOCKS: 765 common domdef 766 767 SIDE EFFECTS:met les valeurs correspondants a la terre a 1e20 768 769 RESTRICTIONS: 770 771 EXAMPLE: 772 </div> 773 774 724 </div> 725 726 <h3>Return value</h3><div class="preformat"> 727 An array 728 </div> 775 729 776 730 … … 779 733 780 734 <h4 id="_moyenne_param_tab">tab 781 782 783 784 735 <span class="attr">in</span> 736 737 738 <span class="attr">required</span> 785 739 786 740 … … 789 743 </h4> 790 744 791 <div class="comments"></div> 745 <div class="comments"> 746 2 or 3d field 747 </div> 792 748 793 749 <h4 id="_moyenne_param_direc">direc 794 795 796 797 750 <span class="attr">in</span> 751 752 753 <span class="attr">required</span> 798 754 799 755 … … 802 758 </h4> 803 759 804 <div class="comments"></div> 760 <div class="comments"> 761 'x' 'y' 'z' 'xy' 'xz' 'yz' or 'xyz' 762 </div> 805 763 806 764 … … 822 780 </h4> 823 781 782 <div class="comments"> 783 [xmin,xmax,ymin,ymax (,(zmin,)zmax)] to more details, see domdef 784 boxzoom can have 5 forms: 785 [vert2], [vert1, vert2],[lon1, lon2, lat1, lat2], 786 [lon1, lon2, lat1, lat2, vert2],[lon1, lon2, lat1, lat2, vert1,vert2] 787 </div> 788 789 <h4 id="_moyenne_keyword_INTEGRATION">INTEGRATION 790 791 792 793 794 795 796 797 798 </h4> 799 800 <div class="comments"> 801 To make an integral rather than an average 802 </div> 803 804 <h4 id="_moyenne_keyword_NAN">NAN 805 806 807 808 809 810 811 812 813 </h4> 814 815 <div class="comments"> 816 not a number, we activate it if we want to average without considerate some masked values of TAB. 817 If masked values of TAB are values consecrated by IDL(!values.f_nan), wr just have to put NAN. 818 If masked values of TAB are valued a (a must be different of 1, corresponding to nan = 819 !values.f_nan and of 0, which desactivate nan). We have to put NAN=a. 820 Comment: In output, rsult points which are NAN will be valued a or !values.f_nan. 821 </div> 822 823 <h4 id="_moyenne_keyword_NODOMDEF">NODOMDEF 824 825 826 827 828 829 830 831 832 </h4> 833 834 <div class="comments"> 835 We activate it if we do not want to pass in domdef even if the keyword boxzoom 836 is present (like when grossemoyenne is called via checkfield) 837 </div> 838 839 <h4 id="_moyenne_keyword_WDEPTH">WDEPTH 840 841 842 843 844 845 846 847 848 </h4> 849 850 <div class="comments"> 851 to specify that the field is at W depth instad of T 852 depth (automatically activated if vargrid eq 'W') 853 </div> 854 855 <h4 id="_moyenne_keyword__extra">_extra 856 857 858 859 860 861 862 863 864 </h4> 865 824 866 <div class="comments"></div> 825 867 826 <h4 id="_moyenne_keyword_INTEGRATION">INTEGRATION 827 828 829 830 831 832 833 834 835 </h4> 836 837 <div class="comments"></div> 838 839 <h4 id="_moyenne_keyword_NAN">NAN 840 841 842 843 844 845 846 847 848 </h4> 849 850 <div class="comments"></div> 851 852 <h4 id="_moyenne_keyword_NODOMDEF">NODOMDEF 853 854 855 856 857 858 859 860 861 </h4> 862 863 <div class="comments"></div> 864 865 <h4 id="_moyenne_keyword_WDEPTH">WDEPTH 866 867 868 869 870 871 872 873 874 </h4> 875 876 <div class="comments"></div> 877 878 <h4 id="_moyenne_keyword__extra">_extra 879 880 881 882 883 884 885 886 887 </h4> 888 889 <div class="comments"></div> 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 868 869 870 871 <h3>Version history</h3> 872 873 <h4>Version</h4><div class="preformat"> 874 $Id$ 875 </div> 876 <h4>History</h4><div class="preformat"></div> 877 878 879 <h3>Known issues</h3> 880 881 882 883 <h4>Restrictions</h4><div class="preformat"> Put values corresponding to land at 1.e20 884 </div> 885 886 <h3>Other attributes</h3> 887 888 889 <h4>Uses routines</h4><div class="preformat"> 890 common 891 domdef 892 </div> 910 893 911 894
Note: See TracChangeset
for help on using the changeset viewer.
