Changeset 14704


Ignore:
Timestamp:
11/26/12 18:47:14 (12 years ago)
Author:
tbretz
Message:
Updated.
Location:
trunk/FACT++/scripts/doc
Files:
2 edited

Legend:

Unmodified
Added
Removed

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

    r14675 r14704  
    7575     */
    7676    this.toSky = function() { /* [native code] */ }
     77}
    7778
    78     /**
    79      * Calculate the distance between two celestial sky positions.
    80      *
    81      * The distance between this object and the provided celestial
    82      * position on the sky is calculated. The returned value
    83      * is an absolute distance (angle) between the two positions.
    84      *
    85      * @constant
    86      *
    87      * @param {Local} local
    88      *     Celestial coordinates to which the distance on the sky
    89      *     should be calculated. In principle every object with
    90      *     the properties 'zd' and 'az' can be provided.
    91      * @param {Number} local.zd Zenith distance of the object
    92      * @param {Number} local.az Azimuth of the object
    93      *
    94      * @returns {Number}
    95      *     Absolute distance between both positions on the sky in degrees.
     79/**
     80 * Calculate the distance between two celestial sky positions.
     81 *
     82 * The distance between the two provided objects is calculated.
     83 * The returned value is an absolute distance (angle) between
     84 * the two positions.
     85 *
     86 * @constant
     87 *
     88 * @param {Local} local1
     89 *     Celestial coordinates for one of the two objects for which
     90 *     the distance on the sky should be calculated. In principle
     91 *     every object with the properties 'zd' and 'az' can be provided.
     92 *
     93 * @param {Local} local2
     94 *     Celestial coordinates for one of the two objects for which
     95 *     the distance on the sky should be calculated. In principle
     96 *     every object with the properties 'zd' and 'az' can be provided.
     97 *
     98 * @returns {Number}
     99 *     Absolute distance between both positions on the sky in degrees.
    96100     */
    97     this.dist = function() { /* [native code] */}
    98 }
     101Local.dist = function() { /* [native code] */}

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

    r14675 r14704  
    7373}
    7474
     75/**
     76 * Calculate the distance between two sky positions.
     77 *
     78 * The distance between the two provided objects is calculated.
     79 * The returned value is an absolute distance (angle) between
     80 * the two positions.
     81 *
     82 * @constant
     83 *
     84 * @param {Sky} sky1
     85 *     Celestial coordinates for one of the two objects for which
     86 *     the distance on the sky should be calculated. In principle
     87 *     every object with the properties 'ra' and 'dec' can be provided.
     88 *
     89 * @param {Sky} sky2
     90 *     Celestial coordinates for one of the two objects for which
     91 *     the distance on the sky should be calculated. In principle
     92 *     every object with the properties 'ra' and 'dec' can be provided.
     93 *
     94 * @returns {Number}
     95 *     Absolute distance between both positions on the sky in degrees.
     96 */
     97Sky.dist = function() { /* [native code] */}
Note: See TracChangeset for help on using the changeset viewer.