Ignore:
Timestamp:
07/21/06 14:47:49 (18 years ago)
Author:
navarro
Message:

english and nicer header (2a)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/placedessin.html

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments">  
     699 Putting into place of the drawing/ opening of the window or of the PS 
     700</div> 
    699701 
    700702       
     
    711713        <div class="routine_details" id="_placedessin"> 
    712714 
    713           <h2><a class="top" href="#container">top</a>placedessin </h2> 
     715          <h2><a class="top" href="#container">top</a>placedessin <span class="categories">  
     716 Utilities 
     717</span></h2> 
    714718         
    715719          <p class="header"> 
     
    717721         
    718722          <div class="comments"> 
    719  NAME:placedessin 
    720  
    721  PURPOSE: mise en place du dessin / ouverture de la fenetre ou du PS 
    722  
    723  CATEGORY: pour alleger les programmes plt, pltz, pltt. 
    724  
    725  CALLING SEQUENCE: placedessin, typedessin,posfenetre, posbar 
    726  
    727  INPUTS: 
    728    typedessin: une chaine de charactere specifiant quelle procedure 
    729    appelle placedessin: 'plt', 'pltz', 'pltt' 
    730  
    731  KEYWORD PARAMETERS: pleins (ce de CALIBRE de WINDOW ...) 
    732  
    733        LCT: intier designant le numero de la palette de couleur que 
    734        l''on veut utiliser pour les plot.  
    735          
    736  OUTPUTS: 
    737  
    738        posfenetre: un vecteur de 4 elements contenant la position de 
    739        cadre contenant les legendes + le graphe en coordonnes 
    740        normalises. Rq: pour positionner le dessin il faut apres 
    741        l''appelle de calibre faire !p.position=posfenetre 
    742  
    743        posbar: cf posfentre mais pour la barre de couleur. meme 
    744        remarque pour positionner la barre de couleur, !p.position=posbar 
    745  
    746  
    747  COMMON BLOCKS: 
    748         common.pro 
    749  
    750  SIDE EFFECTS: 
    751  
    752  RESTRICTIONS: 
    753  
    754  EXAMPLE: 
    755723</div> 
    756724 
     
    772740            </h4> 
    773741         
    774           <div class="comments"></div> 
     742          <div class="comments"> 
     743 It is a chain or characteres specifying what procedure is called by PLACEDESSIN: 'plt', 'pltz' or 'pltt' 
     744</div> 
    775745             
    776746            <h4 id="_placedessin_param_posfenetre">posfenetre&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    777747               
    778                
    779                
    780                
    781                
    782                
    783                
    784                
    785             </h4> 
    786          
    787           <div class="comments"></div> 
     748              <span class="attr">out</span> 
     749               
     750               
     751               
     752               
     753               
     754               
     755            </h4> 
     756         
     757          <div class="comments"> 
     758 It is a vector composed by 4 elements containing the position of the frame  
     759 containing captions and the graph in normalized coorinates.  
     760 Comment: To position the drawing; we have to do !p.position=posfenetre  
     761 after the call of the caliber 
     762</div> 
    788763             
    789764            <h4 id="_placedessin_param_posbar">posbar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    790765               
    791                
    792                
    793                
    794                
    795                
    796                
    797                
    798             </h4> 
    799          
    800           <div class="comments"></div> 
     766              <span class="attr">out</span> 
     767               
     768               
     769               
     770               
     771               
     772               
     773            </h4> 
     774         
     775          <div class="comments"> 
     776 Like POSFENETRE but for the color bar.  
     777 Same comment to position the color bar, !p.position=posbar 
     778</div> 
    801779             
    802780 
     
    831809            </h4> 
    832810         
     811            <div class="comments">  
     812 We active it if we do not want the colorbar. 
     813</div> 
     814             
     815            <h4 id="_placedessin_keyword_NOFILL">NOFILL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     816               
     817               
     818               
     819               
     820               
     821               
     822               
     823               
     824            </h4> 
     825         
     826            <div class="comments">  
     827 We active it if we only want contours in black and white with a white background. 
     828</div> 
     829             
     830            <h4 id="_placedessin_keyword_COLOR_c">COLOR_c&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     831               
     832               
     833               
     834               
     835               
     836               
     837               
     838               
     839            </h4> 
     840         
     841            <div class="comments">  
     842 To draw the contour in color instead of in black 
     843 with filling in color  
     844</div> 
     845             
     846            <h4 id="_placedessin_keyword_CONTOUR">CONTOUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     847               
     848               
     849               
     850               
     851               
     852               
     853               
     854               
     855            </h4> 
     856         
     857            <div class="comments">  
     858 If we want to trace contours of a different field than the one  
     859 whose we have the colored drawing (by examlpe E-P in color and QSR in contours).  
     860 It must be a field respecting same caracteristics than the argument number one of plt. 
     861</div> 
     862             
     863            <h4 id="_placedessin_keyword_VECTEUR">VECTEUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     864               
     865               
     866               
     867               
     868               
     869               
     870               
     871               
     872            </h4> 
     873         
     874            <div class="comments"> is also appropriated. 
     875</div> 
     876             
     877            <h4 id="_placedessin_keyword_PORTRAIT">PORTRAIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     878               
     879               
     880               
     881               
     882               
     883               
     884               
     885               
     886            </h4> 
     887         
     888            <div class="comments">  
     889 Force the page or the window to be in standing position. 
     890</div> 
     891             
     892            <h4 id="_placedessin_keyword_LANDSCAPE">LANDSCAPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     893               
     894               
     895               
     896               
     897               
     898               
     899               
     900               
     901            </h4> 
     902         
     903            <div class="comments">  
     904 Force the page or the window on the screen to be in lenthened position. 
     905</div> 
     906             
     907            <h4 id="_placedessin_keyword_SMALL">SMALL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     908               
     909               
     910               
     911               
     912               
     913               
     914               
     915               
     916            </h4> 
     917         
     918            <div class="comments">  
     919 Vector composed of 3 or 4 elements, applyed to make a drawing on a  
     920 small portion of a page or screen. It delimit the zone where the drawing will be done. 
     921     If there is 4 elements: 
     922 then is constituated of coordinates (expressed in cm located from the up and  
     923 left corner of the page or the window (in portrait like in lanscape)) of the bottom  
     924 and left corner and of the up and right corner of the drawing zone. 
     925     If there is 3 elements: 
     926 in this case, we divide the page or the screen in small[0] columns and in small[1] lines  
     927 the drawing made in the box numbered small[2]. The numerotation starting up and left by  
     928 the number 1 and then, following the writing direction. 
     929 By default, we make the largest drawing we can do, conserving the aspect rapport  
     930 (exept when REMPLI is activated). 
     931 </div> 
     932             
     933            <h4 id="_placedessin_keyword_MARGES">MARGES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     934               
     935               
     936               
     937               
     938               
     939               
     940               
     941               
     942            </h4> 
     943         
    833944            <div class="comments"></div> 
    834945             
    835             <h4 id="_placedessin_keyword_NOFILL">NOFILL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     946            <h4 id="_placedessin_keyword_MAP">MAP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     947               
     948               
     949               
     950               
     951               
     952               
     953               
     954               
     955            </h4> 
     956         
     957            <div class="comments">  
     958 We use it when we want to do a projection. 
     959 This keyword can be of two types: 
     960     MAP=[P0lat,P0lon,Rot]. For the descrption of these 3 values (see the online help of MAP_SET). 
     961     /MAP: In this case, map is automatically caculated have the value:  
     962          map = [0, (lon1+lon2)/2., 0] 
     963 Comment: A good way to choose the type of the projection we want to do is to have a look at IDL demo: 
     964 IDL> demo 
     965 Then choose earth sciences and  mapping. 
     966 Comment2: By default it  is a cindrical projection which is effectuated (with or without the keyword map).  
     967 If we want an other projection, MAP must be activated and we have to add the keyword: /nom_projection. 
     968 For example, for a polar projection centered on the south pole: 
     969 IDL> domdef,-180,180,-90,-45 
     970 IDL> plt, tab, /stereo,map=[-90,0,0] 
     971        </div> 
     972             
     973            <h4 id="_placedessin_keyword_REMPLI">REMPLI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     974               
     975               
     976               
     977               
     978               
     979               
     980               
     981               
     982            </h4> 
     983         
     984            <div class="comments">  
     985 Force the drawing to occupy the whole space defined by small. 
     986</div> 
     987             
     988            <h4 id="_placedessin_keyword_POST">POST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     989               
     990               
     991               
     992               
     993               
     994               
     995               
     996               
     997            </h4> 
     998         
     999            <div class="comments">  
     1000 Make a postscript. Only works if we made one drawing on the page. 
     1001 If we make several drawing, use @ps. 
     1002</div> 
     1003             
     1004            <h4 id="_placedessin_keyword_WINDOW">WINDOW&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1005               
     1006               
     1007               
     1008               
     1009               
     1010               
     1011               
     1012               
     1013            </h4> 
     1014         
     1015            <div class="comments"> 
     1016 Number of the window on which we want to do the graph (Allow to open several windows).  
     1017 By default, we open 'IDL0' 
     1018</div> 
     1019             
     1020            <h4 id="_placedessin_keyword_ENDPOINTS">ENDPOINTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1021               
     1022               
     1023               
     1024               
     1025               
     1026               
     1027               
     1028               
     1029            </h4> 
     1030         
     1031            <div class="comments">  
     1032 keyword specifing that we want to make a vertical cut in diagonal. Then coorinated of extremities  
     1033 of these one are difined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are  
     1034 coordinates.  
     1035</div> 
     1036             
     1037            <h4 id="_placedessin_keyword_TYPE">TYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    8361038               
    8371039               
     
    8461048            <div class="comments"></div> 
    8471049             
    848             <h4 id="_placedessin_keyword_COLOR_c">COLOR_c&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1050            <h4 id="_placedessin_keyword_BASICMARGES">BASICMARGES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    8491051               
    8501052               
     
    8591061            <div class="comments"></div> 
    8601062             
    861             <h4 id="_placedessin_keyword_CONTOUR">CONTOUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    862                
    863                
    864                
    865                
    866                
    867                
    868                
    869                
    870             </h4> 
    871          
    872             <div class="comments"></div> 
    873              
    874             <h4 id="_placedessin_keyword_VECTEUR">VECTEUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    875                
    876                
    877                
    878                
    879                
    880                
    881                
    882                
    883             </h4> 
    884          
    885             <div class="comments"></div> 
    886              
    887             <h4 id="_placedessin_keyword_PORTRAIT">PORTRAIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    888                
    889                
    890                
    891                
    892                
    893                
    894                
    895                
    896             </h4> 
    897          
    898             <div class="comments"></div> 
    899              
    900             <h4 id="_placedessin_keyword_LANDSCAPE">LANDSCAPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    901                
    902                
    903                
    904                
    905                
    906                
    907                
    908                
    909             </h4> 
    910          
    911             <div class="comments"></div> 
    912              
    913             <h4 id="_placedessin_keyword_SMALL">SMALL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    914                
    915                
    916                
    917                
    918                
    919                
    920                
    921                
    922             </h4> 
    923          
    924             <div class="comments"></div> 
    925              
    926             <h4 id="_placedessin_keyword_MARGES">MARGES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    927                
    928                
    929                
    930                
    931                
    932                
    933                
    934                
    935             </h4> 
    936          
    937             <div class="comments"></div> 
    938              
    939             <h4 id="_placedessin_keyword_MAP">MAP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    940                
    941                
    942                
    943                
    944                
    945                
    946                
    947                
    948             </h4> 
    949          
    950             <div class="comments"></div> 
    951              
    952             <h4 id="_placedessin_keyword_REMPLI">REMPLI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    953                
    954                
    955                
    956                
    957                
    958                
    959                
    960                
    961             </h4> 
    962          
    963             <div class="comments"></div> 
    964              
    965             <h4 id="_placedessin_keyword_POST">POST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    966                
    967                
    968                
    969                
    970                
    971                
    972                
    973                
    974             </h4> 
    975          
    976             <div class="comments"></div> 
    977              
    978             <h4 id="_placedessin_keyword_WINDOW">WINDOW&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    979                
    980                
    981                
    982                
    983                
    984                
    985                
    986                
    987             </h4> 
    988          
    989             <div class="comments"></div> 
    990              
    991             <h4 id="_placedessin_keyword_ENDPOINTS">ENDPOINTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    992                
    993                
    994                
    995                
    996                
    997                
    998                
    999                
    1000             </h4> 
    1001          
    1002             <div class="comments"></div> 
    1003              
    1004             <h4 id="_placedessin_keyword_TYPE">TYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1005                
    1006                
    1007                
    1008                
    1009                
    1010                
    1011                
    1012                
    1013             </h4> 
    1014          
    1015             <div class="comments"></div> 
    1016              
    1017             <h4 id="_placedessin_keyword_BASICMARGES">BASICMARGES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1018                
    1019                
    1020                
    1021                
    1022                
    1023                
    1024                
    1025                
    1026             </h4> 
    1027          
    1028             <div class="comments"></div> 
    1029              
    10301063            <h4 id="_placedessin_keyword_NOERASE">NOERASE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    10311064               
     
    10391072            </h4> 
    10401073         
    1041             <div class="comments"></div> 
     1074            <div class="comments">  
     1075 We active it to make a drawing without creating a new frame. 
     1076</div> 
    10421077             
    10431078            <h4 id="_placedessin_keyword_LCT">LCT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    10521087            </h4> 
    10531088         
    1054             <div class="comments"></div> 
     1089            <div class="comments">  
     1090 Is an integer designating the number of the palette of color we want to use for the plot.  
     1091        </div> 
    10551092             
    10561093            <h4 id="_placedessin_keyword_DIREC">DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    10651102            </h4> 
    10661103         
    1067             <div class="comments"></div> 
     1104            <div class="comments"> 
     1105 't' 'x' 'y' 'z' 'xys' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt' 
     1106       'xzt' 'yzt' 'xyzt' Direction on which do averages  
     1107</div> 
    10681108             
    10691109            <h4 id="_placedessin_keyword_CB_TITLE">CB_TITLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    10781118            </h4> 
    10791119         
    1080             <div class="comments"></div> 
     1120            <div class="comments">  
     1121 The colorbar's title 
     1122</div> 
    10811123             
    10821124            <h4 id="_placedessin_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    10911133            </h4> 
    10921134         
    1093             <div class="comments"></div> 
    1094              
    1095            
    1096  
    1097            
    1098            
    1099            
    1100            
    1101            
    1102            
    1103            
    1104            
    1105            
    1106            
    1107            
    1108            
    1109          
    1110            
    1111            
    1112            
    1113            
     1135            <div class="comments"> 
     1136 Used to pass your keywords. 
     1137</div> 
     1138             
     1139           
     1140 
     1141           
     1142          <h3>Version history</h3> 
     1143           
     1144          <h4>Version</h4><div class="preformat"> 
     1145 $Id$ 
     1146</div> 
     1147          <h4>History</h4><div class="preformat"></div> 
     1148           
     1149           
     1150           
     1151           
     1152           
     1153           
     1154           
     1155         
     1156          <h3>Other attributes</h3> 
     1157           
     1158           
     1159          <h4>Uses routines</h4><div class="preformat"> 
     1160 common.pro 
     1161</div> 
    11141162           
    11151163           
Note: See TracChangeset for help on using the changeset viewer.