apidoc/html/group__source.html

const char *planet_names[] = NOVAS_PLANET_NAMES_INIT;

NOVAS_PLANET_NAMES_INIT
#define NOVAS_PLANET_NAMES_INIT
String array initializer for Major planet names, matching the enum novas_planet.
Definition solarsystem.h:79
Data Structures
struct	cat_entry
	Basic astrometric data for any sidereal object located outside the solar system. More...

struct	novas_orbital
	Keplerian orbital elements for `NOVAS_ORBITAL_OBJECT` type. More...

struct	novas_orbital_system
	Specification of an orbital system, in which orbital elements are defined. More...

struct	object
	Celestial object of interest. More...
Macros
#define	CAT_ENTRY_INIT
	Initializer for a NOVAS cat_entry structure.

#define	NOVAS_AU 1.495978707e+11
	[m] Astronomical unit (AU).

#define	NOVAS_DEFAULT_DISTANCE (1e9 * NOVAS_PARSEC)
	[m] Default distance at which sidereal sources are assumed when not specified otherwise Historically NOVAS placed sources with no parallax at 1 Gpc distance, and so we follow.

#define	NOVAS_EARTH_INIT
	`object` initializer for the planet Earth

#define	NOVAS_EMB_INIT
	`object` initializer for the the Earth-Moon Barycenter (EMB)

#define	NOVAS_ID_TYPES
	Number of different Solar-system body ID types enumerated.

#define	NOVAS_JUPITER_INIT
	`object` initializer for the planet Jupiter

#define	NOVAS_KMS (NOVAS_KM)
	[m] One km/s in m/s.

#define	NOVAS_LIGHT_YEAR ( NOVAS_C * NOVAS_TROPICAL_YEAR_DAYS * NOVAS_DAY )
	[m] A light-year in meters.

#define	NOVAS_MARS_INIT
	`object` initializer for the planet Mars

#define	NOVAS_MERCURY_INIT
	`object` initializer for the planet Venus

#define	NOVAS_MOON_INIT
	`object` initializer for the Moon

#define	NOVAS_NEPTUNE_INIT
	`object` initializer for the planet Neptune

#define	NOVAS_OBJECT_INIT
	Empty object initializer.

#define	NOVAS_ORBIT_INIT
	Initializer for novas_orbital for heliocentric orbits using GCRS ecliptic pqrametrization.

#define	NOVAS_ORBITAL_SYSTEM_INIT
	Default orbital system initializer for heliocentric GCRS ecliptic orbits.

#define	NOVAS_PARSEC ( NOVAS_AU / NOVAS_ARCSEC )
	[m] A parsec in meters.

#define	NOVAS_PLANET_NAMES_INIT
	String array initializer for Major planet names, matching the enum novas_planet.

#define	NOVAS_PLUTO_BARYCENTER_INIT
	`object` initializer for the Pluto system barycenter

#define	NOVAS_PLUTO_INIT
	`object` initializer for the minor planet Pluto

#define	NOVAS_SATURN_INIT
	`object` initializer for the planet Saturn

#define	NOVAS_SSB_INIT
	`object` initializer for the Solar System Barycenter (SSB)

#define	NOVAS_SUN_INIT
	`object` initializer for the Sun

#define	NOVAS_SYSTEM_B1950 "B1950"
	The B1950 coordiante system as a string.

#define	NOVAS_SYSTEM_FK4 "FK4"
	The 4th catalog (FK4) coordinate system as a string.

#define	NOVAS_SYSTEM_FK5 "FK5"
	The 5th catalog (FK5) coordinate system as a string.

#define	NOVAS_SYSTEM_HIP "HIP"
	The Hipparcos dataset coordinate system as a string.

#define	NOVAS_SYSTEM_ICRS "ICRS"
	The ICRS system as a string.

#define	NOVAS_SYSTEM_J2000 "J2000"
	The J2000 coordinate syste, as a string.

#define	NOVAS_URANUS_INIT
	`object` initializer for the planet Uranus

#define	NOVAS_VENUS_INIT
	`object` initializer for the planet Mercury

#define	SIZE_OF_CAT_NAME 6
	Maximum bytes in catalog IDs including string termination.

#define	SIZE_OF_OBJ_NAME 50
	Maximum bytes in object names including string termination.
Enumerations
enum	novas_id_type { NOVAS_ID_NAIF = 0 , NOVAS_ID_CALCEPH }
	Solar-system body IDs to use as object.number with NOVAS_EPHEM_OBJECT types. More...

enum	novas_object_type { NOVAS_PLANET = 0 , NOVAS_EPHEM_OBJECT , NOVAS_CATALOG_OBJECT , NOVAS_ORBITAL_OBJECT }
	The type of astronomical objects distinguied by the NOVAS library. More...

enum	novas_planet { NOVAS_SSB = 0 , NOVAS_MERCURY , NOVAS_VENUS , NOVAS_EARTH , NOVAS_MARS , NOVAS_JUPITER , NOVAS_SATURN , NOVAS_URANUS , NOVAS_NEPTUNE , NOVAS_PLUTO , NOVAS_SUN , NOVAS_MOON , NOVAS_EMB , NOVAS_PLUTO_BARYCENTER }
	Enumeration for the 'major planet' numbers in NOVAS to use as the solar-system body number whenever the object type is NOVAS_PLANET. More...

enum	novas_transform_type { PROPER_MOTION = 1 , PRECESSION , CHANGE_EPOCH , CHANGE_J2000_TO_ICRS , CHANGE_ICRS_TO_J2000 }
	The types of coordinate transformations available for tranform_cat(). More...
Functions
short	make_cat_entry (const char restrict name, const char restrict catalog, long cat_num, double ra, double dec, double pm_ra, double pm_dec, double parallax, double rad_vel, cat_entry *source)
	Fully populates the data structure for a catalog source, such as a star, with all parameters provided at once.

int	make_cat_object (const cat_entry star, object source)
	Populates and object data structure with the data for a catalog source.

int	make_cat_object_sys (const cat_entry star, const char restrict system, object *source)
	Populates and object data structure with the data for a catalog source for a given system of catalog coordinates.

int	make_ephem_object (const char name, long num, object body)
	Sets a celestial object to be a Solar-system ephemeris body.

int	make_orbital_object (const char name, long num, const novas_orbital orbit, object *body)
	Sets a celestial object to be a Solar-system orbital body.

int	make_planet (enum novas_planet num, object *restrict planet)
	Sets a celestial object to be a major planet, or the Sun, Moon, Solar-system Barycenter, etc.

int	make_redshifted_cat_entry (const char name, double ra, double dec, double z, cat_entry source)
	Populates a celestial object data structure with the parameters for a redhifted catalog source, such as a distant quasar or galaxy.

int	make_redshifted_object (const char name, double ra, double dec, double z, object source)
	Populates a celestial object data structure with the ICRS astrometric parameters for a redhifted catalog source, such as a distant quasar or galaxy.

int	make_redshifted_object_sys (const char name, double ra, double dec, const char restrict system, double z, object *source)
	Populates a celestial object data structure with the parameters for a redhifted catalog source, such as a distant quasar or galaxy, for a given system of catalog coordinates.

enum novas_planet	naif_to_novas_planet (long id)
	Converts a NAIF ID to a NOVAS major planet ID.

void	novas_case_sensitive (int value)
	Enables or disables case-sensitive processing of the object name.

int	novas_init_cat_entry (cat_entry restrict source, const char restrict name, double ra, double dec)
	Initializes a catalog entry, such as a star or a distant galaxy, with a name and coordinates.

int	novas_make_moon_orbit (double jd_tdb, novas_orbital *restrict orbit)
	Gets the current orbital elements for the Moon relative to the geocenter for the specified epoch of observation.

int	novas_make_planet_orbit (enum novas_planet id, double jd_tdb, novas_orbital *restrict orbit)
	Get approximate current heliocentric orbital elements for the major planets.

int	novas_orbit_posvel (double jd_tdb, const novas_orbital restrict orbit, enum novas_accuracy accuracy, double restrict pos, double *restrict vel)
	Calculates a rectangular equatorial position and velocity vector for the given orbital elements for the specified time of observation.

enum novas_planet	novas_planet_for_name (const char *restrict name)
	Returns the NOVAS planet ID for a given name (case insensitive), or -1 if no match is found.

int	novas_set_catalog (cat_entry restrict source, const char restrict catalog, long num)
	Sets the optional catalog information for a sidereal source.

int	novas_set_distance (cat_entry *source, double parsecs)
	Sets the distance for a catalog source.

int	novas_set_lsr_vel (cat_entry *source, double epoch, double v_kms)
	Sets a radial velocity for a catalog source, defined w.r.t.

int	novas_set_orbsys_pole (enum novas_reference_system type, double ra, double dec, novas_orbital_system *restrict sys)
	Sets the orientation of an orbital system using the RA and DEC coordinates of the pole of the Laplace (or else equatorial) plane relative to which the orbital elements are defined.

int	novas_set_parallax (cat_entry *source, double mas)
	Sets the parallax (a measure of distance) for a catalog source.

int	novas_set_proper_motion (cat_entry *source, double pm_ra, double pm_dec)
	Sets the proper-motion for a (Galactic) catalog source.

int	novas_set_redshift (cat_entry *source, double z)
	Sets a redhift for a catalog source, as a relativistic measure of velocity.

int	novas_set_ssb_vel (cat_entry *source, double v_kms)
	Sets a radial velocity for a catalog source, defined w.r.t.

long	novas_to_dexxx_planet (enum novas_planet id)
	Converts a NOVAS Solar-system body ID to a NAIF Solar-system body ID for DExxx ephemeris files.

long	novas_to_naif_planet (enum novas_planet id)
	Converts a NOVAS Solar-system body ID to a NAIF Solar-system body ID.

int	proper_motion (double jd_tdb_in, const double pos, const double restrict vel, double jd_tdb_out, double *out)
	Applies proper motion, including foreshortening effects, to a star's position.

int	starvectors (const cat_entry restrict star, double restrict pos, double *restrict motion)
	Converts angular quantities for stars to vectors.

short	transform_cat (enum novas_transform_type, double jd_tt_in, const cat_entry in, double jd_tt_out, const char out_id, cat_entry *out)
	Transform a star's catalog quantities for a change the coordinate system and/or the date for which the positions are calculated.

int	transform_hip (const cat_entry hipparcos, cat_entry hip_2000)
	Convert Hipparcos catalog data at epoch J1991.25 to epoch J2000.0, for use within NOVAS.
Enumerator
NOVAS_ID_NAIF	If the ephemeris provider should use NAIF IDs.
NOVAS_ID_CALCEPH	If the ephemeris provider should use CALCEPH IDs.
Enumerator
NOVAS_PLANET	A major planet, or else the Sun, the Moon, or the Solar-System Barycenter (SSB). See also make_planet(), enum novas_planet, novas_planet_provider, novas_planet_provider_hp
NOVAS_EPHEM_OBJECT	A Solar-system body that does not fit the major planet type, and requires specific user-provided novas_ephem_provider implementation. See also make_ephem_object(), novas_ephem_provider
NOVAS_CATALOG_OBJECT	Any non-solar system object that may be handled via 'catalog' coordinates, such as a star or a quasar. See also make_cat_object_sys(), make_redshifted_object_sys(), cat_entry
NOVAS_ORBITAL_OBJECT	Any Solar-system body, whose position is determined by a set of orbital elements. Since 1.2 See also make_orbital_object(), novas_orbital
Enumerator
NOVAS_SSB	Solar-system barycenter position ID.
NOVAS_MERCURY	Major planet number for Mercury in NOVAS.
NOVAS_VENUS	Major planet number for Venus in NOVAS.
NOVAS_EARTH	Major planet number for Earth in NOVAS.
NOVAS_MARS	Major planet number for Mars in NOVAS.
NOVAS_JUPITER	Major planet number for Jupiter in NOVAS.
NOVAS_SATURN	Major planet number for Saturn in NOVAS.
NOVAS_URANUS	Major planet number for Uranus in NOVAS.
NOVAS_NEPTUNE	Major planet number for Neptune in NOVAS.
NOVAS_PLUTO	Major planet number for Pluto in NOVAS.
NOVAS_SUN	Numerical ID for the Sun in NOVAS.
NOVAS_MOON	Numerical ID for the Moon in NOVAS.
NOVAS_EMB	NOVAS ID for the Earth-Moon Barycenter (EMB). Since 1.2
NOVAS_PLUTO_BARYCENTER	NOVAS ID for the barycenter of the Pluto System. Since 1.2
Enumerator
PROPER_MOTION	Updates the star's data to account for the star's space motion between the first and second dates, within a fixed reference frame.
PRECESSION	applies a rotation of the reference frame corresponding to precession between the first and second dates, but leaves the star fixed in space.
CHANGE_EPOCH	The combined equivalent of PROPER_MOTION and PRECESSION together.
CHANGE_J2000_TO_ICRS	A fixed rotation about very small angles (<0.1 arcsecond) to take data from the dynamical system of J2000.0 to the ICRS.
CHANGE_ICRS_TO_J2000	The inverse transformation of J2000_TO_ICRS.
short make_cat_entry	(	const char *restrict	name,
		const char *restrict	catalog,
		long	cat_num,
		double	ra,
		double	dec,
		double	pm_ra,
		double	pm_dec,
		double	parallax,
		double	rad_vel,
		cat_entry *	source )
	name	Object name (less than SIZE_OF_OBJ_NAME in length). It may be NULL if not relevant.
	catalog	Catalog identifier or epoch (less than SIZE_OF_CAT_NAME in length). E.g. 'HIP' for Hipparcos, 'TY2' for Tycho-2; or 'ICRS', 'B1950', 'J2000'. It may be NULL if not relevant.
	cat_num	Object number in the catalog. It is not used internally, so you may set it to anything that is meaningful to you, or set it to 0 as a default.
	ra	[h] Right ascension of the object.
	dec	[deg] Declination of the object.
	pm_ra	[mas/yr] Proper motion in right ascension.
	pm_dec	[mas/yr] Proper motion in declination.
	parallax	[mas] Parallax.
	rad_vel	[km/s] Radial velocity relative to the Solar-System Barycenter (SSB). To convert velocities defined against the Local Standard of Rest (LSR), you may use `novas_lsr_to_ssb_vel()` to convert appropriately. Or, to convert from a redshift value, you might use `novas_z2v()`.
[out]	source	Pointer to data structure to populate.