Changeset 142 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/checkfield.html
- Timestamp:
- 07/21/06 14:47:49 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/checkfield.html
r138 r142 696 696 </div> 697 697 698 <div id="file_comments"></div> 698 <div id="file_comments"> 699 In input of plt, pltz, pltt and plt1d, it check that the field give 700 a size compatible with the domain and, if needed, average to give us 701 a 2d array if we make a plot of the type: 'xy', 'xz', 'xt', 'yz', 'yt' 702 , 'zt' or a 1d array if we make a plot of the type: 'x', 'y', 'z', 't'. 703 </div> 699 704 700 705 … … 711 716 712 717 <dt><p><a href="#_err_1d"><span class="result">result = </span>err_1d(<span class="result">type, n1, name, n2</span>)</a></p><dt> 713 <dd> NAME:checkfield PURPOSE:en entree de plt, pltz, pltt et plt1d, verifie que le champ donne a bien une taille compatible avec le domaine et fait au besoin les moyennes pour ressortir en fin de fonction un tableau 2d si on fait un plot du type: 'xy', 'xz', 'xt', 'yz', 'yt', 'zt' ou un tableau 1d si on fait un plot du type 'x', 'y', 'z', 't'.</dd>718 <dd></dd> 714 719 715 720 <dt><p><a href="#_err_2d"><span class="result">result = </span>err_2d(<span class="result">type, sz, nx, ny, nz</span>)</a></p><dt> … … 720 725 721 726 <dt><p><a href="#_checkfield"><span class="result">result = </span>checkfield(<span class="result">field, procedure</span>, TYPE=<span class="result">TYPE</span>, BOXZOOM=<span class="result">BOXZOOM</span>, DIREC=<span class="result">DIREC</span>, NOQUESTION=<span class="result">NOQUESTION</span>, VECTEUR=<span class="result">VECTEUR</span>, WDEPTH=<span class="result">WDEPTH</span>, _EXTRA=<span class="result">_EXTRA</span>)</a></p><dt> 722 <dd> </dd>727 <dd> </dd> 723 728 724 729 </dl> … … 736 741 <span class="result">result = </span>err_1d(<span class="result"><a href="#_err_1d_param_type">type</a>, <a href="#_err_1d_param_n1">n1</a>, <a href="#_err_1d_param_name">name</a>, <a href="#_err_1d_param_n2">n2</a></span>)</p> 737 742 738 <div class="comments"> 739 NAME:checkfield 740 741 PURPOSE:en entree de plt, pltz, pltt et plt1d, verifie que le 742 champ donne a bien une taille compatible avec le domaine et fait au 743 besoin les moyennes pour ressortir en fin de fonction un tableau 2d 744 si on fait un plot du type: 'xy', 'xz', 'xt', 'yz', 'yt', 'zt' ou un 745 tableau 1d si on fait un plot du type 'x', 'y', 'z', 't'. 746 747 CATEGORY:en entree de plt, pltz, pltt et plt1d 748 749 CALLING SEQUENCE:res=checkfield(field, procedure) 750 751 INPUTS: 752 filed: un champ recomdant aux criteres de litchamp.pro, cf. 753 IDL>xhelp,'litchamp' 754 755 KEYWORD PARAMETERS: 756 757 /WDEPTH: to specify that the field is at W depth instad of T 758 depth (automatically activated if vargrid eq 'W') 759 760 OUTPUTS: 761 762 COMMON BLOCKS:common.pro 763 764 SIDE EFFECTS: 765 766 RESTRICTIONS: 767 768 EXAMPLE: 769 </div> 743 <div class="comments"></div> 770 744 771 745 … … 1082 1056 <div class="routine_details" id="_checkfield"> 1083 1057 1084 <h2><a class="top" href="#container">top</a>checkfield </h2> 1058 <h2><a class="top" href="#container">top</a>checkfield <span class="categories"> 1059 graphic 1060 </span></h2> 1085 1061 1086 1062 <p class="header"> 1087 1063 <span class="result">result = </span>checkfield(<span class="result"><a href="#_checkfield_param_field">field</a>, <a href="#_checkfield_param_procedure">procedure</a></span>, <a href="#_checkfield_keyword_TYPE">TYPE</a>=<span class="result">TYPE</span>, <a href="#_checkfield_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_checkfield_keyword_DIREC">DIREC</a>=<span class="result">DIREC</span>, <a href="#_checkfield_keyword_NOQUESTION">NOQUESTION</a>=<span class="result">NOQUESTION</span>, <a href="#_checkfield_keyword_VECTEUR">VECTEUR</a>=<span class="result">VECTEUR</span>, <a href="#_checkfield_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>, <a href="#_checkfield_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> 1088 1064 1089 <div class="comments"></div> 1065 <div class="comments"> 1066 </div> 1090 1067 1091 1068 … … 1096 1073 1097 1074 <h4 id="_checkfield_param_field">field 1098 1099 1100 1101 1102 1103 1104 1105 1106 </h4> 1107 1108 <div class="comments"></div> 1075 <span class="attr">in</span> 1076 1077 1078 <span class="attr">required</span> 1079 1080 1081 1082 1083 </h4> 1084 1085 <div class="comments"> 1086 A field respecting litchamp.pro's criterions. See IDL>xhelp,'litchamp' 1087 </div> 1109 1088 1110 1089 <h4 id="_checkfield_param_procedure">procedure … … 1152 1131 </h4> 1153 1132 1133 <div class="comments"> 1134 Vector indicating the geographic zone on which we want to cut the map. 1135 If BOXZOOM has : 1136 1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]] 1137 2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]] 1138 4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])] 1139 5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]] 1140 6 elements: The extraction is made on Boxzoom 1141 1142 Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef! 1143 </div> 1144 1145 <h4 id="_checkfield_keyword_DIREC">DIREC 1146 1147 1148 1149 1150 1151 1152 1153 1154 </h4> 1155 1156 <div class="comments"> 1157 </div> 1158 1159 <h4 id="_checkfield_keyword_NOQUESTION">NOQUESTION 1160 1161 1162 1163 1164 1165 1166 1167 1168 </h4> 1169 1154 1170 <div class="comments"></div> 1155 1171 1156 <h4 id="_checkfield_keyword_ DIREC">DIREC 1172 <h4 id="_checkfield_keyword_VECTEUR">VECTEUR 1157 1173 1158 1174 … … 1165 1181 </h4> 1166 1182 1167 <div class="comments"></div> 1168 1169 <h4 id="_checkfield_keyword_NOQUESTION">NOQUESTION 1183 <div class="comments"> is also appropriated. 1184 </div> 1185 1186 <h4 id="_checkfield_keyword_WDEPTH">WDEPTH 1170 1187 1171 1188 … … 1178 1195 </h4> 1179 1196 1180 <div class="comments"></div> 1181 1182 <h4 id="_checkfield_keyword_VECTEUR">VECTEUR 1197 <div class="comments"> 1198 to specify that the field is at W depth instad of T 1199 depth (automatically activated if vargrid eq 'W') 1200 </div> 1201 1202 <h4 id="_checkfield_keyword__EXTRA">_EXTRA 1183 1203 1184 1204 … … 1191 1211 </h4> 1192 1212 1193 <div class="comments"></div> 1194 1195 <h4 id="_checkfield_keyword_WDEPTH">WDEPTH 1196 1197 1198 1199 1200 1201 1202 1203 1204 </h4> 1205 1206 <div class="comments"></div> 1207 1208 <h4 id="_checkfield_keyword__EXTRA">_EXTRA 1209 1210 1211 1212 1213 1214 1215 1216 1217 </h4> 1218 1219 <div class="comments"></div> 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1213 <div class="comments"> 1214 used to pass your keywords 1215 </div> 1216 1217 1218 1219 1220 <h3>Version history</h3> 1221 1222 <h4>Version</h4><div class="preformat"> 1223 $Id$ 1224 </div> 1225 <h4>History</h4><div class="preformat"></div> 1226 1227 1228 <h3>Known issues</h3> 1229 1230 1231 <h4>Todo items</h4><div class="preformat"> seb: mettre les param 1232 </div> 1233 1234 1235 <h3>Other attributes</h3> 1236 1237 1238 <h4>Uses routines</h4><div class="preformat"> 1239 common.pro 1240 </div> 1240 1241 1241 1242
Note: See TracChangeset
for help on using the changeset viewer.
