Changeset 18829 for trunk/FACT++


Ignore:
Timestamp:
04/14/17 17:21:13 (8 years ago)
Author:
tbretz
Message:
Updated with the latest changes in the astromtry interface of the JavaScript interpreter.
Location:
trunk/FACT++/scripts/doc
Files:
4 edited

Legend:

Unmodified
Added
Removed

  • trunk/FACT++/scripts/doc/Local.js

    r14704 r18829  
    1818 *     Zenith angle in degree (Zenith=0deg)
    1919 *
     20 * @param {Date} [time]
     21 *    Time for which the coordinates are valid.
     22 *    The order of time and observatory is arbitrary.
     23 *
     24 * @param {String} [observatory]
     25 *    Observatory location for which the coordinates are valid.
     26 *    The order of time and observatory is arbitrary.
     27 *
     28 *
    2029 * @param {Number} azimuth
    2130 *     Azimuth angle in degree (North=0deg, East=90deg)
    2231 *
    2332 * @example
     33 *     var date = new Date("2012-10-25 16:30 GMT"); // Date in UTC
    2434 *     var local = new Local(12, 45);
    25  *     var sky   = local.toSky();
     35 *     var local = new Local(12, 45, date);
     36 *     var local = new Local(12, 45, "ORM");
     37 *     var local = new Local(12, 45, "SPM", date);
     38 *     var local = new Local(12, 45, date, "HAWC");
     39 *     var sky = local.toSky();
     40 *     var sky = local.toSky(date);
     41 *     var sky = local.toSky("ORM");
     42 *     var sky = local.toSky("HAWC", date);
     43 *     var sky = local.toSky(date, "SPM");
    2644 *
    27  * @author <a href="mailto:thomas.bretz@epfl.ch">Thomas Bretz</a>
     45 * @author <a href="mailto:tbretz@physik.rwth-aachen.de">Thomas Bretz</a>
    2846 *
    2947 */
    … …  
    6886     *
    6987     * @param {Date} [time=new Date()]
    70      *     Reference time for the conversion
     88     *    Time for which the coordinates will be tranfromed.
     89     *    The order of time and observatory is arbitrary.
     90     *    If none is given, the value given in the constructor is used.
     91     *    If none was given there, the default is used.
     92     *
     93     * @param {String} [observatory='ORM']
     94     *    Observatory location as defined in nova.h as a string for which
     95     *    the coordinate conversion is done.
     96     *    The order of time and observatory is arbitrary.
     97     *    If none is given, the value given in the constructor is used.
     98     *    If none was given there, the default is used.
    7199     *
    72100     * @returns {Sky}
    73      *     A Sky object with the converted coordinates and
    74      *     the corresponding time.
     101     *     A Sky object with the converted coordinates plus a
     102     *     a correspnding object local of type {Local}.
    75103     */
    76104    this.toSky = function() { /* [native code] */ }

  • trunk/FACT++/scripts/doc/Moon.js

    r14696 r18829  
    2222 *
    2323 * @example
     24 *    var date = new Date("2012-10-25 16:30 GMT"); // Date in UTC
     25 *    var moon = new Moon(date);
    2426 *    var moon = new Moon();
    2527 *    var local = moon.toLocal();
     28 *    var local = moon.toLocal("HAWC");
    2629 *
    27  * @author <a href="mailto:thomas.bretz@epfl.ch">Thomas Bretz</a>
     30 * @author <a href="mailto:tbretz@physik.rwth-aachen.de">Thomas Bretz</a>
    2831 */
    2932function Moon(time)
    … …  
    6164     * The conversion is done using libnova's ln_get_hrz_from_equ.
    6265     *
     66     * @param {String} [observatory='ORM']
     67     *    Observatory location as defined in nova.h as a string. The default
     68     *    is the FACT site ('ORM').
     69     *
    6370     * @returns {Local}
    6471     *     A Local object with the converted coordinates and
    65      *     the corresponding time.
     72     *     the corresponding time and observatory.
    6673     */
    6774    this.toLocal = function() { /* [native code] */  }
    … …  
    100107 *    is converted to UTC and the times are calculated such that the
    101108 *    Date (yy/mm/dd) is identical for all returned values.
     109 *    The order of time and observatory is arbitrary.
     110 *
     111 * @param {String} [observatory='ORM']
     112 *    Observatory location as defined in nova.h as a string. The default
     113 *    is the FACT site ('ORM'). The order of time and observatory is
     114 *    arbitrary.
    102115 *
    103116 * @type {Object}
    … …  
    105118 * @returns
    106119 *    An object with the following properties is returned: time {Date}
    107  *    the provided time; rise, transit, set {Date} times of rise, set and
    108  *    transit; isUp {Boolean} whether the moon is above or below horizon
     120 *    the provided time; observatory {Date} the provided observatory location;
     121 *    rise, transit, set {Date} times of rise, set and transit;
     122 *    isUp {Boolean} whether the moon is above or below horizon
    109123 *    at the provided time. If the moon does not rise or set, the properties
    110124 *    rise, transit and set will be undefined.
    … …  
    112126 * @example
    113127 *    var date = new Date("2012-10-25 16:30 GMT"); // Date in UTC
     128 *    console.out(JSON.stringify(Moon.horizon());
    114129 *    console.out(JSON.stringify(Moon.horizon(date));
     130 *    console.out(JSON.stringify(Moon.horizon(date, "SPM"));
     131 *    console.out(JSON.stringify(Moon.horizon("ORM, date);
    115132 */
    116133Moon.horizon = function() { /* [native code] */ }

  • trunk/FACT++/scripts/doc/Sky.js

    r14704 r18829  
    2424 *     var sky   = new Sky(12, 45);
    2525 *     var local = sky.toLocal();
     26 *     var date = new Date("2012-10-25 16:30 GMT"); // Date in UTC
     27 *     var local = sky.toLocal(date);
     28 *     var local = sky.toLocal("ORM");
     29 *     var local = sky.toLocal(date, "HAWC");
     30 *     var local = sky.toLocal("SPM", date);
    2631 *
    27  * @author <a href="mailto:thomas.bretz@epfl.ch">Thomas Bretz</a>
     32 * @author <a href="mailto:tbretz@physik.rwth-aachen.de">Thomas Bretz</a>
    2833 *
    2934 */
    … …  
    6267     *
    6368     * @param {Date} [time=new Date()]
    64      *     Reference time for the converstion.
     69     *    Time for which the coordinates will be tranfromed.
     70     *    The order of time and observatory is arbitrary.
     71     *
     72     * @param {String} [observatory='ORM']
     73     *    Observatory location as defined in nova.h as a string for which
     74     *    the coordinate conversion is done The default is the
     75     *    FACT site ('ORM'). The order of time and observatory is arbitrary.
    6576     *
    6677     * @type Local
    6778     *
    6879     * @returns
    69      *     A Local object with the converted coordinates and
    70      *     the conversion time.
     80     *     A Local object with the converted coordinates,
     81     *     the conversion time and the observatory location.
    7182     */
    7283    this.toLocal = function() { /* [native code] */  }

  • trunk/FACT++/scripts/doc/Sun.js

    r15358 r18829  
    1010 * Namespace for functions returning astrometry information about the Sun.
    1111 *
    12  * @author <a href="mailto:thomas.bretz@epfl.ch">Thomas Bretz</a>
     12 * @author <a href="mailto:tbretz@physik.rwth-aachen.de">Thomas Bretz</a>
    1313 */
    1414var Sun = { };
    … …  
    3333 *    the Sun's disk at horizon is chosen (~-0.8deg).
    3434 *
    35  * @param {Date} [time=new Date()]
     35* @param {Date} [time=new Date()]
    3636 *    Date for which the times should be calculated. Note that the date
    3737 *    is converted to UTC and the times are calculated such that the
    3838 *    Date (yy/mm/dd) is identical for all returned values.
     39 *    The order of time and observatory is arbitrary.
     40 *
     41 * @param {String} [observatory='ORM']
     42 *    Observatory location as defined in nova.h as a string. The default
     43 *    is the FACT site ('ORM'). The order of time and observatory is
     44 *    arbitrary.
    3945 *
    4046 * @type {Object}
    … …  
    5561 *    console.out(JSON.stringify(Sun.horizon("astro"));
    5662 *    console.out(JSON.stringify(Sun.horizon(-12, date); // nautical
     63 *    console.out(JSON.stringify(Sun.horizon(-12, "SPM");
     64 *    console.out(JSON.stringify(Sun.horizon(-12, "HAWC", date);
     65 *    console.out(JSON.stringify(Sun.horizon(-12, date, "ORM");
    5766 */
    5867Sun.horizon = function() { /* [native code] */ }
Note: See TracChangeset for help on using the changeset viewer.