1 throw new Error("Description for built in functions. Must not be included!");
  2 /**
  3  * @fileOverview
  4  *    Documentation of Local class built into dimctrl.
  5  */
  6 
  7 /**
  8  * @class
  9  *
 10  * A set of coordinates on the celestial sphere.
 11  *
 12  * The class stores a set of coordinates on the celestial, i.e. local,
 13  * sky. If the data was the result of a coordinate transformation, the
 14  * corresponding time is stored in addition. Functions to convert to sky
 15  * coordinates and to measure distances on th sky are included.
 16  *
 17  * @param {Number} zenithDistance
 18  *     Zenith angle in degree (Zenith=0deg)
 19  *
 20  * @param {Number} azimuth
 21  *     Azimuth angle in degree (North=0deg, East=90deg)
 22  *
 23  * @example
 24  *     var local = new Local(12, 45);
 25  *     var sky   = local.toSky();
 26  *
 27  * @author <a href="mailto:thomas.bretz@epfl.ch">Thomas Bretz</a>
 28  *
 29  */
 30 function Local(zenithDistance, azimuth)
 31 {
 32     /**
 33      * Zenith distance in degree (Zenith=0deg)
 34      *
 35      * @constant
 36      *
 37      * @type Number
 38      */
 39     this.zd = zenithDistance;
 40 
 41     /**
 42      * Azimuth in degree (North=0deg, East=90deg)
 43      *
 44      * @constant
 45      *
 46      * @type Number
 47      */
 48     this.az = azimuth;
 49 
 50     /**
 51      * Time corresponding to ra and dec if they are the result of
 52      * a conversion.
 53      *
 54      * @constant
 55      * @default undefined
 56      *
 57      * @type Date
 58      */
 59     this.time = undefined;
 60 
 61 
 62     /**
 63      * Convert celestial coordinats to sky coordinates.
 64      * As observatory location the FACT telescope is assumed.
 65      * The conversion is done using libnova's ln_get_equ_from_hrz.
 66      *
 67      * @constant
 68      *
 69      * @param {Date} [time=new Date()]
 70      *     Reference time for the conversion
 71      *
 72      * @returns {Sky}
 73      *     A Sky object with the converted coordinates and
 74      *     the corresponding time.
 75      */
 76     this.toSky = function() { /* [native code] */ }
 77 }
 78 
 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.
100      */
101 Local.dist = function() { /* [native code] */}
102