- Timestamp:
- 07/21/06 14:47:49 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/litchamp.html
r138 r142 696 696 </div> 697 697 698 <div id="file_comments"></div> 698 <div id="file_comments"> 699 Allows to read an array or a sructure cooresponding to a field. 700 If we have in input: 701 -an array, litchamp send back the array. 702 -a structure, litchamp send back the first element of the structure 703 which must be the field in an array. 704 Litchamp profit of this to look other elements of the structure et 705 update if needed global variables which refer to the field: 706 vargrid, varname, varunit, vardate, varexp , valmask et time 707 </div> 699 708 700 709 … … 711 720 <div class="routine_details" id="_litchamp"> 712 721 713 <h2><a class="top" href="#container">top</a>litchamp </h2> 722 <h2><a class="top" href="#container">top</a>litchamp <span class="categories"> 723 graphic 724 </span></h2> 714 725 715 726 <p class="header"> … … 717 728 718 729 <div class="comments"> 719 NAME:litchamp 720 721 PURPOSE:permet de lire un simple tableau ou une structure 722 correspondant a un champ. 723 Si en entree on a : 724 -un simple tableau, litchamp renvoie le tableau 725 -une stucture, litchamp renvoie le premier element de la structure 726 qui doit obligatoirement etre le champ sous forme d''un tableau. 727 Au passage litchamp regarde les autres elements de la structure et 728 met a jour si besoin les variables globales qui se rapportent au 729 champ: vargrid, varname, varunit, vardate, varexp , valmask et time 730 731 CATEGORY:permet d''appeler plt, pltz, pltt ... avec un tableau ou une 732 structure et de mettre a jour les variables globales liees au champ. 733 734 CALLING SEQUENCE:res=litchamp(struct) 735 736 INPUTS: 737 struct: c''est soit un tableau soit une structure. 738 Si struct est une structure, elle doit suivre les regles 739 suivantes: 740 -le premier element est le tableau contenant le champ. 741 -les autres elements sont des strings qui contiennent des 742 informations sur le champ SAUF pour l''element relatif a 743 date. Ce dernier peut etre soit un string pour designer une date 744 particuliere (ex: 'August 1999') ou bien un vecteur de jours 745 juliens (d''IDL) correspondant au calendrier a associer au 746 champ si c'est une serie temporelle. 747 -l''ordre des elements (autre que le premier) n''a pas 748 d''importance. 749 -les autres elements (autre que le premier) sont tous 750 optionnels. 751 -ils sont reconnus par la premiere lettre de leur nom: 752 g pour actualiser vargrid 753 u pour actualiser varunit 754 e pour actualiser varexp 755 d pour actualiser vardate 756 n pour actualiser varname 757 m pour actualiser valmask 758 759 KEYWORD PARAMETERS: 760 761 /GRID: activer ce mot cle si on veut que litchamp renvoie la 762 variable associee a l''element de la structure commencant 763 par 'g' si il existe et '' dans le cas contraire. 764 765 /UNIT: activer ce mot cle si on veut que litchamp renvoie la 766 variable associee a l''element de la structure commencant 767 par 'u' si il existe et '' dans le cas contraire. 768 769 /EXP: activer ce mot cle si on veut que litchamp renvoie la 770 variable associee a l''element de la structure commencant 771 par 'e' si il existe et '' dans le cas contraire. 772 773 /DATE: activer ce mot cle si on veut que litchamp renvoie la 774 variable associee a l''element de la structure commencant 775 par 'd' si il existe et '' dans le cas contraire. 776 777 /NAME: activer ce mot cle si on veut que litchamp renvoie la 778 variable associee a l''element de la structure commencant 779 par 'n' si il existe et '' dans le cas contraire. 780 781 /LEVEL: activer ce mot cle si on veut que litchamp renvoie la 782 variable associee a l''element de la structure commencant 783 par 'l' si il existe et -1 dans le cas contraire. 784 785 /MASK: activer ce mot cle si on veut que litchamp renvoie la 786 variable associee a l''element de la structure commencant 787 par 'm' si il existe et -1 dans le cas contraire. 788 789 OUTPUTS:c''est le tableau qui continent le champ. 790 791 COMMON BLOCKS: 792 common.pro 793 794 SIDE EFFECTS: actualise au besion les variables globales vargrid, 795 varname, varunit, vardate, varexp, valmask et time. 796 797 RESTRICTIONS: 798 799 EXAMPLE: 730 </div> 731 732 <h3>Return value</h3><div class="preformat"> 733 It is the array containing the field. 734 </div> 735 736 737 <h3>Parameters</h3> 738 739 740 <h4 id="_litchamp_param_struct">struct 741 <span class="attr">in</span> 742 743 744 <span class="attr">required</span> 745 746 747 748 749 </h4> 750 751 <div class="comments"> 752 It is either an array or a structure. 753 If STRUCT is a structure, it must follow following rules: 754 -the first element is the array containing the field. 755 -other elements are strings containing informations on the field exept 756 for the one about the date. This one can be either a string to designate 757 a particular date (ex: 'August 1999') or a vector of julian days (of IDL) 758 corresponding to the calendar to be associated with the field if it is a 759 temporal series. 760 -the order of elements (exept the first) has not any importance. 761 -the other elements (exept the first) are optional. 762 -they are recognize by the first letter of their names: 763 g to update vargrid 764 u to update varunit 765 e to update varexp 766 d to update vardate 767 n to update varname 768 m to update valmask 769 </div> 770 771 772 773 774 775 776 <h3>Keywords</h3> 777 778 <h4 id="_litchamp_keyword_GRID">GRID 779 780 781 782 783 784 785 786 787 </h4> 788 789 <div class="comments"> 790 We activate this keyword if we want litchamp to send back the variable 791 associated with the element of the structure starting by 'g' if it exist 792 and '' if it does not. 793 </div> 794 795 <h4 id="_litchamp_keyword_NAME">NAME 796 797 798 799 800 801 802 803 804 </h4> 805 806 <div class="comments"> 807 We activate this keyword if we want litchamp to send back the variable 808 associated with the element of the structure starting by 'n' if it exist 809 and '' if it does not. 810 </div> 811 812 <h4 id="_litchamp_keyword_UNIT">UNIT 813 814 815 816 817 818 819 820 821 </h4> 822 823 <div class="comments"> 824 We activate this keyword if we want litchamp to send back the variable 825 associated with the element of the structure starting by 'u' if it exist 826 and '' if it does not. 827 </div> 828 829 <h4 id="_litchamp_keyword_EXP">EXP 830 831 832 833 834 835 836 837 838 </h4> 839 840 <div class="comments"> 841 We activate this keyword if we want litchamp to send back the variable 842 associated with the element of the structure starting by 'u' if it exist 843 and '' if it does not. 844 </div> 845 846 <h4 id="_litchamp_keyword_DATE">DATE 847 848 849 850 851 852 853 854 855 </h4> 856 857 <div class="comments"> 858 We activate this keyword if we want litchamp to send back the variable 859 associated with the element of the structure starting by 'd' if it exist 860 and '' if it does not. 861 </div> 862 863 <h4 id="_litchamp_keyword_LEVEL">LEVEL 864 865 866 867 868 869 870 871 872 </h4> 873 874 <div class="comments"> 875 We activate this keyword if we want litchamp to send back the variable 876 associated with the element of the structure starting by 'l' if it exist 877 and -1 if it does not. 878 879 </div> 880 881 <h4 id="_litchamp_keyword_MASK">MASK 882 883 884 885 886 887 888 889 890 </h4> 891 892 <div class="comments"> 893 We activate this keyword if we want litchamp to send back the variable 894 associated with the element of the structure starting by 'm' if it exist 895 and -1 if it does not. 896 </div> 897 898 899 900 <h3>Examples</h3><div class="preformat"> 800 901 801 902 IDL> print, vargrid,', ', varname,', ', varunit,', ', vardate,', ', varexp … … 811 912 812 913 </div> 813 814 815 816 817 <h3>Parameters</h3> 818 819 820 <h4 id="_litchamp_param_struct">struct 821 822 823 824 825 826 827 828 829 </h4> 830 831 <div class="comments"></div> 832 833 834 835 836 837 838 <h3>Keywords</h3> 839 840 <h4 id="_litchamp_keyword_GRID">GRID 841 842 843 844 845 846 847 848 849 </h4> 850 851 <div class="comments"></div> 852 853 <h4 id="_litchamp_keyword_NAME">NAME 854 855 856 857 858 859 860 861 862 </h4> 863 864 <div class="comments"></div> 865 866 <h4 id="_litchamp_keyword_UNIT">UNIT 867 868 869 870 871 872 873 874 875 </h4> 876 877 <div class="comments"></div> 878 879 <h4 id="_litchamp_keyword_EXP">EXP 880 881 882 883 884 885 886 887 888 </h4> 889 890 <div class="comments"></div> 891 892 <h4 id="_litchamp_keyword_DATE">DATE 893 894 895 896 897 898 899 900 901 </h4> 902 903 <div class="comments"></div> 904 905 <h4 id="_litchamp_keyword_LEVEL">LEVEL 906 907 908 909 910 911 912 913 914 </h4> 915 916 <div class="comments"></div> 917 918 <h4 id="_litchamp_keyword_MASK">MASK 919 920 921 922 923 924 925 926 927 </h4> 928 929 <div class="comments"></div> 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 914 <h3>Version history</h3> 915 916 <h4>Version</h4><div class="preformat"> 917 $Id$ 918 </div> 919 <h4>History</h4><div class="preformat"></div> 920 921 922 <h3>Known issues</h3> 923 924 925 926 <h4>Restrictions</h4><div class="preformat"> 927 Update if needed global variables vargrid, 928 varname, varunit, vardate, varexp, valmask and time. 929 </div> 930 931 <h3>Other attributes</h3> 932 933 934 <h4>Uses routines</h4><div class="preformat"> 935 common.pro 936 </div> 950 937 951 938
Note: See TracChangeset
for help on using the changeset viewer.
