Siddhanta Parity API Documentation - v1.3.0
    Preparing search index...
    • Assign equatorial coordinates to a user-defined star.

      Some Astronomy Engine functions allow their body parameter to be a user-defined fixed point in the sky, loosely called a "star". This function assigns a right ascension, declination, and distance to one of the eight user-defined stars Star1..Star8.

      Stars are not valid until defined. Once defined, they retain their definition until re-defined by another call to DefineStar.

      Parameters

      • body: Body

        One of the eight user-defined star identifiers: Star1, Star2, Star3, Star4, Star5, Star6, Star7, or Star8.

      • ra: number

        The right ascension to be assigned to the star, expressed in J2000 equatorial coordinates (EQJ). The value is in units of sidereal hours, and must be within the half-open range [0, 24).

      • dec: number

        The declination to be assigned to the star, expressed in J2000 equatorial coordinates (EQJ). The value is in units of degrees north (positive) or south (negative) of the J2000 equator, and must be within the closed range [-90, +90].

      • distanceLightYears: number

        The distance between the star and the Sun, expressed in light-years. This value is used to calculate the tiny parallax shift as seen by an observer on Earth. If you don't know the distance to the star, using a large value like 1000 will generally work well. The minimum allowed distance is 1 light-year, which is required to provide certain internal optimizations.

      Returns void