Ignore:
Timestamp:
09/21/07 10:14:31 (17 years ago)
Author:
smasson
Message:

update documentation

Location:
trunk/SRC/Documentation/idldoc_assistant_output/Calendar
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_assistant_output/Calendar/caldat.html

    r249 r290  
    6464 Return the calendar date and time given julian date. 
    6565 This is the inverse of the function 
    66  <a href=".//julday.html">julday</a>. 
     66 <a href="..//Calendar/julday.html">julday</a>. 
    6767 3 calendars are available according to the value of key_caltype 
    6868 (variable of the common file cm_4cal): 'greg', '360d', 'noleap' 
     
    7474      <a name="#_caldat"></a> 
    7575 
    76       <h2>caldat  <font size="-1" color="#006633"> Calendar 
     76      <h2>caldat  <font size="-1" color="#006633">  
     77 Calendar 
    7778</font></h2> 
    7879 
     
    236237     
    237238    <h4>Version</h4> 
    238  $Id: caldat.pro 242 2007-04-06 08:35:17Z pinsard $ 
     239 $Id: caldat.pro 261 2007-08-20 16:08:13Z pinsard $ 
    239240 
    240241    <h4>History</h4> 
  • trunk/SRC/Documentation/idldoc_assistant_output/Calendar/date2jul.html

    r249 r290  
    7474</font></h2> 
    7575 
    76       <p><font face="Courier"><i>result = </i>date2jul(<i><a href="#_date2jul_keyword_date">date</a></i>, <a href="#_date2jul_keyword_GRADS">GRADS</a>=<i>GRADS</i>)</font></p> 
     76      <p><font face="Courier"><i>result = </i>date2jul(<i><a href="#_date2jul_keyword_date">date</a></i>, <a href="#_date2jul_keyword_GRADS">GRADS</a>=<i>GRADS</i>, <a href="#_date2jul_keyword_MONTH">MONTH</a>=<i>MONTH</i>, <a href="#_date2jul_keyword_DAY">DAY</a>=<i>DAY</i>, <a href="#_date2jul_keyword_YEAR">YEAR</a>=<i>YEAR</i>, <a href="#_date2jul_keyword_HOUR">HOUR</a>=<i>HOUR</i>, <a href="#_date2jul_keyword_MINUTE">MINUTE</a>=<i>MINUTE</i>, <a href="#_date2jul_keyword_SECOND">SECOND</a>=<i>SECOND</i>)</font></p> 
    7777 
    7878     
     
    8080 
    8181    <h3>Return value</h3> 
    82  date in Julian day 
     82 Julian day with the same format (long or double) as the input parameter 
    8383 
    8484 
     
    9494      <font size="-1" color="#006633">required</font> 
    9595       
    96       <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font> 
    97        
    98        
    99     </h4> 
    100  
    101      
    102  date in yyyymmdd format 
     96      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>long or double, sacalr or array</i></font> 
     97       
     98       
     99    </h4> 
     100 
     101     
     102 longword integer with yyyymmdd format or double-precision 
     103 floating-point with yyyymmdd.xx where xx is the fraction of the day 
     104 (xx=0 at 0am and 5 at 12am)  
    103105 
    104106     
     
    126128 
    127129     
     130    <a name="#_date2jul_keyword_MONTH"></a> 
     131    <h4>MONTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     132       
     133       
     134       
     135       
     136       
     137       
     138       
     139       
     140    </h4> 
     141 
     142     
     143 Set this keyword equal to a named variable that will receive a 
     144 longword integer or longword integer array representing the number of 
     145 the desired month (1 = January, ..., 12 = December).  
     146 
     147     
     148    <a name="#_date2jul_keyword_DAY"></a> 
     149    <h4>DAY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     150       
     151       
     152       
     153       
     154       
     155       
     156       
     157       
     158    </h4> 
     159 
     160     
     161 Set this keyword equal to a named variable that will receive a 
     162 longword integer or longword integer array representing the number of 
     163 the day of the month (1-31).   
     164 
     165     
     166    <a name="#_date2jul_keyword_YEAR"></a> 
     167    <h4>YEAR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     168       
     169       
     170       
     171       
     172       
     173       
     174       
     175       
     176    </h4> 
     177 
     178     
     179 Set this keyword equal to a named variable that will receive a 
     180 longword integer or longword integer array representing the number of 
     181 the desired year (e.g., 1994).   
     182 
     183     
     184    <a name="#_date2jul_keyword_HOUR"></a> 
     185    <h4>HOUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     186       
     187       
     188       
     189       
     190       
     191       
     192       
     193       
     194    </h4> 
     195 
     196     
     197 Set this keyword equal to a named variable that will receive a 
     198 longword integer or longword integer array representing the number of 
     199 the hour of the day (0-23).   
     200  
     201     
     202    <a name="#_date2jul_keyword_MINUTE"></a> 
     203    <h4>MINUTE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     204       
     205       
     206       
     207       
     208       
     209       
     210       
     211       
     212    </h4> 
     213 
     214     
     215 Set this keyword equal to a named variable that will receive a 
     216 longword integer or longword integer array representing the number of 
     217 the minute of the hour (0-59).   
     218   
     219     
     220    <a name="#_date2jul_keyword_SECOND"></a> 
     221    <h4>SECOND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     222       
     223       
     224       
     225       
     226       
     227       
     228       
     229       
     230    </h4> 
     231 
     232     
     233 Set this keyword equal to a named variable that will receive a 
     234 double-precision floating-point value or a double-precision 
     235 floating-point array representing the number of the second of the 
     236 minute (0-59). 
     237 
     238     
    128239     
    129240 
     
    135246 IDL> print, date2jul(931205,/grads) EQ julday(12,5,1993) 
    136247       1 
     248 IDL> print, date2jul(19931205.5d) EQ julday(12,5,1993,12,0,0) 
     249       1 
     250 IDL> print, date2jul(19931205.0d) EQ julday(12,5,1993,0,0,0) 
     251       1 
    137252 
    138253    </pre><h3>Version history</h3> 
    139254     
    140255    <h4>Version</h4> 
    141  $Id: date2jul.pro 238 2007-03-27 13:43:18Z pinsard $ 
     256 $Id: date2jul.pro 279 2007-09-07 13:40:51Z smasson $ 
    142257 
    143258    <h4>History</h4> 
     
    146261     
    147262 
    148      
    149      
    150      
    151      
    152      
     263    <h3>Known issues</h3> 
     264     
     265     
     266     
     267    <h4>Restrictions</h4> 
     268 Input param must be longword integer or double-precision floating-point 
     269  
    153270 
    154271     
  • trunk/SRC/Documentation/idldoc_assistant_output/Calendar/jul2date.html

    r249 r290  
    7474</font></h2> 
    7575 
    76       <p><font face="Courier"><i>result = </i>jul2date(<i><a href="#_jul2date_keyword_jday">jday</a></i>)</font></p> 
     76      <p><font face="Courier"><i>result = </i>jul2date(<i><a href="#_jul2date_keyword_jday">jday</a></i>, <a href="#_jul2date_keyword_MONTH">MONTH</a>=<i>MONTH</i>, <a href="#_jul2date_keyword_DAY">DAY</a>=<i>DAY</i>, <a href="#_jul2date_keyword_YEAR">YEAR</a>=<i>YEAR</i>, <a href="#_jul2date_keyword_HOUR">HOUR</a>=<i>HOUR</i>, <a href="#_jul2date_keyword_MINUTE">MINUTE</a>=<i>MINUTE</i>, <a href="#_jul2date_keyword_SECOND">SECOND</a>=<i>SECOND</i>)</font></p> 
    7777 
    7878     
     
    8080 
    8181    <h3>Return value</h3> 
    82  date in yyyymmdd format 
     82 the date: longword integer with yyyymmdd format or double-precision 
     83 floating-point with yyyymmdd.xx where xx is the fraction of the day 
     84 (xx=0 at 0am and 5 at 12am)  
    8385 
    8486 
     
    9496      <font size="-1" color="#006633">required</font> 
    9597       
    96       <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>double</i></font> 
     98      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>long or double, sacalr or array</i></font> 
    9799       
    98100       
     
    106108 
    107109     
     110    <h3>Keywords</h3> 
     111 
     112     
     113    <a name="#_jul2date_keyword_MONTH"></a> 
     114    <h4>MONTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     115       
     116       
     117       
     118       
     119       
     120       
     121       
     122       
     123    </h4> 
     124 
     125     
     126 Set this keyword equal to a named variable that will receive a 
     127 longword integer or longword integer array representing the number of 
     128 the desired month (1 = January, ..., 12 = December).  
     129 
     130     
     131    <a name="#_jul2date_keyword_DAY"></a> 
     132    <h4>DAY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     133       
     134       
     135       
     136       
     137       
     138       
     139       
     140       
     141    </h4> 
     142 
     143     
     144 Set this keyword equal to a named variable that will receive a 
     145 longword integer or longword integer array representing the number of 
     146 the day of the month (1-31).   
     147 
     148     
     149    <a name="#_jul2date_keyword_YEAR"></a> 
     150    <h4>YEAR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     151       
     152       
     153       
     154       
     155       
     156       
     157       
     158       
     159    </h4> 
     160 
     161     
     162 Set this keyword equal to a named variable that will receive a 
     163 longword integer or longword integer array representing the number of 
     164 the desired year (e.g., 1994).   
     165 
     166     
     167    <a name="#_jul2date_keyword_HOUR"></a> 
     168    <h4>HOUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     169       
     170       
     171       
     172       
     173       
     174       
     175       
     176       
     177    </h4> 
     178 
     179     
     180 Set this keyword equal to a named variable that will receive a 
     181 longword integer or longword integer array representing the number of 
     182 the hour of the day (0-23).   
     183  
     184     
     185    <a name="#_jul2date_keyword_MINUTE"></a> 
     186    <h4>MINUTE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     187       
     188       
     189       
     190       
     191       
     192       
     193       
     194       
     195    </h4> 
     196 
     197     
     198 Set this keyword equal to a named variable that will receive a 
     199 longword integer or longword integer array representing the number of 
     200 the minute of the hour (0-59).   
     201   
     202     
     203    <a name="#_jul2date_keyword_SECOND"></a> 
     204    <h4>SECOND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     205       
     206       
     207       
     208       
     209       
     210       
     211       
     212       
     213    </h4> 
     214 
     215     
     216 Set this keyword equal to a named variable that will receive a 
     217 double-precision floating-point value or a double-precision 
     218 floating-point array representing the number of the second of the 
     219 minute (0-59). 
     220 
     221     
     222     
    108223 
    109224    <h3>Examples</h3><pre> 
    110225 
    111226 IDL> print, jul2date(julday(12,23,1999)) 
    112         19991223 
     227     19991223 
     228 IDL> print, jul2date(julday(12,23,1999,12,0,0)) 
     229        19991224. 
     230 IDL> print, jul2date(julday(12,23,1999,12,0,0)), format='(f11.2)' 
     231 19991223.50 
     232 IDL> print, jul2date(julday(12,23,1999,0,0,0)), format='(f11.2)' 
     233 19991223.00 
    113234 
    114235    </pre><h3>Version history</h3> 
    115236     
    116237    <h4>Version</h4> 
    117  $Id: jul2date.pro 231 2007-03-19 17:15:51Z pinsard $ 
     238 $Id: jul2date.pro 279 2007-09-07 13:40:51Z smasson $ 
    118239 
    119240    <h4>History</h4> 
     
    123244     
    124245 
    125      
    126      
    127      
    128      
    129      
     246    <h3>Known issues</h3> 
     247     
     248     
     249     
     250    <h4>Restrictions</h4> 
     251 Input param must be longword integer or double-precision floating-point 
     252  
    130253 
    131254     
  • trunk/SRC/Documentation/idldoc_assistant_output/Calendar/julday.html

    r249 r290  
    6464 Calculate the Julian Day Number for a given month, day, and year. 
    6565 This is the inverse of the library function 
    66  <a href=".//CALDAT.html">CALDAT</a>. 
     66 <a href="..//Calendar/caldat.html">caldat</a>. 
    6767 3 calendars are available according to the value of key_caltype 
    6868 (variable of the common file cm_4cal): 'greg', '360d', 'noleap' 
     
    7878</font></h2> 
    7979 
    80       <p><font face="Courier"><i>result = </i>julday(<i><a href="#_julday_keyword_MONTH">MONTH</a>, <a href="#_julday_keyword_DAY">DAY</a>, <a href="#_julday_keyword_YEARin">YEARin</a>[, <a href="#_julday_keyword_Hour">Hour</a>][, <a href="#_julday_keyword_Minute">Minute</a>][, <a href="#_julday_keyword_Second">Second</a>]</i>, <a href="#_julday_keyword_NDAYSPM">NDAYSPM</a>=<i>integer</i>)</font></p> 
     80      <p><font face="Courier"><i>result = </i>julday(<i><a href="#_julday_keyword_month">month</a>, <a href="#_julday_keyword_day">day</a>, <a href="#_julday_keyword_yearin">yearin</a>[, <a href="#_julday_keyword_hour">hour</a>][, <a href="#_julday_keyword_minute">minute</a>][, <a href="#_julday_keyword_second">second</a>]</i>, <a href="#_julday_keyword_NDAYSPM">NDAYSPM</a>=<i>integer</i>)</font></p> 
    8181 
    8282     
     
    9494     
    9595 
    96     <a name="#_julday_keyword_MONTH"></a> 
    97     <h4>MONTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     96    <a name="#_julday_keyword_month"></a> 
     97    <h4>month&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    9898      <font size="-1" color="#006633">in</font> 
    9999       
     
    111111     
    112112 
    113     <a name="#_julday_keyword_DAY"></a> 
    114     <h4>DAY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     113    <a name="#_julday_keyword_day"></a> 
     114    <h4>day&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    115115      <font size="-1" color="#006633">in</font> 
    116116       
     
    128128     
    129129 
    130     <a name="#_julday_keyword_YEARin"></a> 
    131     <h4>YEARin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     130    <a name="#_julday_keyword_yearin"></a> 
     131    <h4>yearin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    132132      <font size="-1" color="#006633">in</font> 
    133133       
     
    148148 1 C.E. (1). 
    149149 Change: However for climatological year, we do accept the year 
    150  O but we change it for year 654321L (the same trick is done in 
    151  caldat so caldat, julday(1,1,0) gives you back Jan 1st of year 0) 
    152  
    153      
    154  
    155     <a name="#_julday_keyword_Hour"></a> 
    156     <h4>Hour&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     150 0 but we change it for year 654321L (the same trick is done in 
     151 <a href="..//Calendar/caldat.html">caldat</a> so caldat, julday(1,1,0) gives you back Jan 1st of year 0) 
     152 
     153     
     154 
     155    <a name="#_julday_keyword_hour"></a> 
     156    <h4>hour&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    157157      <font size="-1" color="#006633">in</font> 
    158158       
     
    170170     
    171171 
    172     <a name="#_julday_keyword_Minute"></a> 
    173     <h4>Minute&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     172    <a name="#_julday_keyword_minute"></a> 
     173    <h4>minute&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    174174      <font size="-1" color="#006633">in</font> 
    175175       
     
    187187     
    188188 
    189     <a name="#_julday_keyword_Second"></a> 
    190     <h4>Second&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     189    <a name="#_julday_keyword_second"></a> 
     190    <h4>second&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    191191      <font size="-1" color="#006633">in</font> 
    192192       
     
    232232     
    233233    <h4>Version</h4> 
    234  $Id: julday.pro 242 2007-04-06 08:35:17Z pinsard $ 
     234 $Id: julday.pro 279 2007-09-07 13:40:51Z smasson $ 
    235235    <h4>History</h4> 
    236236 Translated from "Numerical Recipies in C", by William H. Press, 
Note: See TracChangeset for help on using the changeset viewer.