Defines the astrometric parameters of a sidereal source, such as a star, a Galactic cloud, a distant galaxy, or a quasar. More...

#include <supernovas.h>

Inheritance diagram for supernovas::CatalogEntry:

Public Member Functions
	CatalogEntry (cat_entry e, const Equinox &system=Equinox::icrs())
	Instantiates a new catalog entry with a NOVAS C cat_entry data structure and the equatorial coordinate system in which it is defined.
	CatalogEntry (const std::string &name, const Ecliptic &coords)
	Instantiates a new catalog entry with a given name and ecliptic catalog coordinates.
	CatalogEntry (const std::string &name, const Equatorial &coords)
	Instantiates a new catalog entry with a given name and catalog coordinates.
	CatalogEntry (const std::string &name, const Galactic &coords)
	Instantiates a new catalog entry with a given name and galactic catalog coordinates.
const cat_entry *	_cat_entry () const
	Returns a pointer to the underlying NOVAS C cat_entry data structure, for use with the standard C API.
Angle	dec () const
	Returns the catalog declination coordinate as a angle.
Coordinate	distance () const
	Returns the catalog (light-time) distance of the source.
CatalogEntry &	distance (const Coordinate &dist)
	Sets the distance of this source, defined at the same epoch as the catalog coordinates, returning itself to enable builder pattern.
CatalogEntry &	distance (double meters)
	Sets the distance of this source, defined at the same epoch as the catalog coordinates, returning itself to enable builder pattern.
Equatorial	equatorial () const
	Returns the equatorial catalog coordinates of this source.
std::string	name () const
	Returns the catalog name that was defined.
Angle	parallax () const
	Returns the parallax of the source.
CatalogEntry &	parallax (const Angle &angle)
	Sets the parallax this source, defined at the same epoch as the catalog coordinates, returning itself to enable builder pattern.
CatalogEntry &	parallax (double radians)
	Sets the parallax of this source, defined at the same epoch as the catalog coordinates, returning itself to enable builder pattern.
CatalogEntry &	proper_motion (double ra, double dec)
	Sets the proper motion of this source, defined at the same epoch as the catalog coordinates, returning itself to enable builder pattern.
TimeAngle	ra () const
	Returns the catalog right ascention (R.A.) coordinate as a time-angle.
ScalarVelocity	radial_velocity () const
	Returns the barycentric radial velocity of the source, that is the radial velocity with respect to the Solar System Barycenter (SSB).
CatalogEntry &	radial_velocity (const ScalarVelocity &v)
	Sets the radial velocity of this source relative to the Solar System Barycenter (SSB), defined at the same epoch as the catalog coordinates, and returning itself to enable builder pattern.
CatalogEntry &	radial_velocity (double v_ms)
	Sets the radial velocity of this source relative to the Solar System Barycenter (SSB), defined at the same epoch as the catalog coordinates, and returning itself to enable builder pattern.
double	redshift () const
	Returns the barycentric redshift of the source, that is the redshift measure with respect to the Solar System Barycenter (SSB).
CatalogEntry &	redshift (double z)
	Sets the redshift of this source relative to the Solar System Barycenter (SSB), defined at the same epoch as the catalog coordinates, and returning itself to enable builder pattern.
const Equinox &	system () const
	Returns the equatorial coordinate system in which this catalog entry is defined.
CatalogSource	to_source () const
	Returns a new catalog source based created from this catalog entry.
std::string	to_string (int decimals=3) const
	Returns a human-readable string representation of this catalog entry, showing only the most basic data.
ScalarVelocity	v_lsr () const
	Returns the scalar source velocity with respect to the Local Standard of Rest (LSR).
CatalogEntry &	v_lsr (const ScalarVelocity &v)
	Sets the motion of this source relative to the Local Standard of Rest (LSR), defined at the same epoch as the catalog coordinates, and returning itself to enable builder pattern.
CatalogEntry &	v_lsr (double v_ms)
	Sets the motion of this source relative to the Local Standard of Rest (LSR), defined at the same epoch as the catalog coordinates, and returning itself to enable builder pattern.
Public Member Functions inherited from supernovas::Validating
bool	is_valid () const
	Returns the previously set 'valid' stae of the implementing instance.
	operator bool () const
	Objects that implement Validating can be used in conditionals directly, without explicitly calling is_valid().

Additional Inherited Members
Protected Member Functions inherited from supernovas::Validating
	Validating ()
	dummy constructor;
Protected Attributes inherited from supernovas::Validating
bool	_valid = false
	the state variable.

Detailed Description

Defines the astrometric parameters of a sidereal source, such as a star, a Galactic cloud, a distant galaxy, or a quasar.

NOTES:

This class uses a builder pattern to populate the astrometric parameters, bit-by-bit, as needed. As such, this class is mutable, unlike most SuperNOVAS classes. You should avoid using the builder functions in a multi-threaded environment. The best practice is to build the catalog entry first, before using in parallel threads unmodified.

See also: CatalogSource

Constructor & Destructor Documentation

◆ CatalogEntry() [1/4]

supernovas::CatalogEntry::CatalogEntry	(	const std::string &	name,
		const Equatorial &	coords )

Instantiates a new catalog entry with a given name and catalog coordinates.

After instantiation, one may populate additional data using the builder functions of this class, such as:

radial or LSR velocity, or redshift
proper motion (if any)
parallax or distance, if known (by default 1 Gpc is assumed)
catalog name, and catalog ID number

For example:

CatalogEntry star =
   CatalogEntry("Antares", Equatorial("16h26m20.1918s", "-26d19m23.138s", Equinox::b1950()))
   .proper_motion( -12.11 * Unit::mas / Unit::year, -23.30 * Unit::mas / Unit::year)
   .parallax(5.89 * Unit::arcsec)
   .radial_velocity(-3.4 * Unit::km / Unit::s);

Parameters

name	source name. It is treated case insensitively, unless the user calls novas_case_sensitive(true) prior to instantiation. The user may chose any name that is appropriate for their application.
coords	Catalog coordinates (equatorial)

See also: proper_motion(), parallax(), distance(), radial_velocity(), v_lsr(), redshift(), catalog()

References supernovas::Validating::_valid, supernovas::Equatorial::dec(), supernovas::Angle::deg(), supernovas::TimeAngle::hours(), supernovas::Validating::is_valid(), name(), novas_init_cat_entry(), supernovas::Equatorial::ra(), and system().

Referenced by CatalogEntry(), CatalogEntry(), distance(), distance(), parallax(), parallax(), proper_motion(), radial_velocity(), radial_velocity(), redshift(), v_lsr(), and v_lsr().

◆ CatalogEntry() [2/4]

supernovas::CatalogEntry::CatalogEntry	(	const std::string &	name,
		const Ecliptic &	coords )

Instantiates a new catalog entry with a given name and ecliptic catalog coordinates.

After instantiation, one may populate additional data using the builder functions of this class, such as:

radial or LSR velocity, or redshift
proper motion (if any)
parallax or distance, if known (by default 1 Gpc is assumed)
catalog name, and catalog ID number

See CatalogEntry(strd::string&, Equatorial&) for more information on using builder patterns.

Parameters

name	Source name. It is treated case insensitively, unless the user calls novas_case_sensitive(true) prior to instantiation. The user may chose any name that is appropriate for their application.
coords	Catalog coordinates (ecliptic)

See also: proper_motion(), parallax(), distance(), radial_velocity(), v_lsr(), redshift(), catalog()

References CatalogEntry(), and name().

◆ CatalogEntry() [3/4]

supernovas::CatalogEntry::CatalogEntry	(	const std::string &	name,
		const Galactic &	coords )

Instantiates a new catalog entry with a given name and galactic catalog coordinates.

After instantiation, one may populate additional data using the builder functions of this class, such as:

radial or LSR velocity, or redshift
proper motion (if any)
parallax or distance, if known (by default 1 Gpc is assumed)
catalog name, and catalog ID number

See CatalogEntry(strd::string&, Equatorial&) for more information on using builder patterns.

NOTES:

The Galactic coordinate system is somewhat ambigiously defined (see Liu+2011). As a result one should probably avoid using it when high precision is required.

Parameters

name	Source name. It is treated case insensitively, unless the user calls novas_case_sensitive(true) prior to instantiation. The user may chose any name that is appropriate for their application.
coords	Catalog coordinates (galactic)

See also: proper_motion(), parallax(), distance(), radial_velocity(), v_lsr(), redshift(), catalog()

References CatalogEntry(), and name().

◆ CatalogEntry() [4/4]

supernovas::CatalogEntry::CatalogEntry	(	cat_entry	e,
		const Equinox &	system = Equinox::icrs() )

explicit

Instantiates a new catalog entry with a NOVAS C cat_entry data structure and the equatorial coordinate system in which it is defined.

radial or LSR velocity, or redshift
proper motion (if any)
parallax or distance, if known (by default 1 Gpc is assumed)
catalog name, and catalog ID number

See CatalogEntry(strd::string&, Equatorial&) for more information on using builder patterns.

Parameters

e	NOVAS C cat_entry data structure (it is not referenced)
system	the equatorial coordinate system in which the cat_entry data was defined.

References system().

Member Function Documentation

◆ _cat_entry()

const cat_entry * supernovas::CatalogEntry::_cat_entry ( ) const

Returns a pointer to the underlying NOVAS C cat_entry data structure, for use with the standard C API.

Returns: a pointer to the underlying NOVAS C cat_entry data structure.

Referenced by supernovas::CatalogSource::CatalogSource().

◆ dec()

Angle supernovas::CatalogEntry::dec ( ) const

Returns the catalog declination coordinate as a angle.

Returns: the catalog declination angle as defined in the catalog system.

See also: system(), equatorial(); ra(), distance(), parallax(), radial_velocity(), v_lsr(), redshift()

References supernovas::Unit::deg, and supernovas::Validating::is_valid().

Referenced by equatorial(), and proper_motion().

◆ distance() [1/3]

Coordinate supernovas::CatalogEntry::distance ( ) const

Returns the catalog (light-time) distance of the source.

Returns: the distance of the source, or 1 Gpc if it was not explicitly defined.

See also: system(), parallax(); ra(), dec(), radial_velocity(), v_lsr(), redshift()

References supernovas::Validating::is_valid(), and supernovas::Unit::kpc.

Referenced by distance(), and to_string().

◆ distance() [2/3]

CatalogEntry & supernovas::CatalogEntry::distance ( const Coordinate & dist )

Sets the distance of this source, defined at the same epoch as the catalog coordinates, returning itself to enable builder pattern.

Parameters

dist	source (light-time) distance

Returns: itself

See also: parallax(); system(), radial_velocity(), v_lsr(), redshift(), proper_motion(), catalog()

References CatalogEntry(), distance(), and supernovas::Coordinate::m().

◆ distance() [3/3]

CatalogEntry & supernovas::CatalogEntry::distance ( double meters )

Sets the distance of this source, defined at the same epoch as the catalog coordinates, returning itself to enable builder pattern.

Parameters

meters [m] source (light-time) distance

Returns: itself

See also: parallax(); system(), radial_velocity(), v_lsr(), redshift(), proper_motion(), catalog()

References CatalogEntry(), supernovas::Validating::_valid, novas_set_distance(), and supernovas::Unit::pc.

◆ equatorial()

Equatorial supernovas::CatalogEntry::equatorial ( ) const

Returns the equatorial catalog coordinates of this source.

Returns: the equatorial coordinates of the source in the catalog system

See also: system(), ra(), dec(), distance()

References dec(), supernovas::Validating::is_valid(), ra(), and system().

Referenced by to_string().

◆ name()

std::string supernovas::CatalogEntry::name ( ) const

Returns the catalog name that was defined.

Returns: the given catalog name.

See also: number()

Referenced by CatalogEntry(), CatalogEntry(), CatalogEntry(), and to_string().

◆ parallax() [1/3]

Angle supernovas::CatalogEntry::parallax ( ) const

Returns the parallax of the source.

Returns: the parallax of the source, or 1 μas if not explicitly defined.

See also: system(), distance(); ra(), dec(), radial_velocity(), v_lsr(), redshift()

References supernovas::Validating::is_valid(), and supernovas::Unit::mas.

Referenced by parallax().

◆ parallax() [2/3]

CatalogEntry & supernovas::CatalogEntry::parallax ( const Angle & angle )

Sets the parallax this source, defined at the same epoch as the catalog coordinates, returning itself to enable builder pattern.

Parameters

angle Parallax angle

Returns: itself

See also: distance(); system(), radial_velocity(), v_lsr(), redshift(), proper_motion(), catalog()

References CatalogEntry(), parallax(), and supernovas::Angle::rad().

◆ parallax() [3/3]

CatalogEntry & supernovas::CatalogEntry::parallax ( double radians )

Sets the parallax of this source, defined at the same epoch as the catalog coordinates, returning itself to enable builder pattern.

Parameters

radians [rad] Parallax angle

Returns: itself

See also: distance(); system(), radial_velocity(), v_lsr(), redshift(), proper_motion(), catalog()

References CatalogEntry(), supernovas::Validating::_valid, supernovas::Unit::mas, and novas_set_parallax().

◆ proper_motion()

CatalogEntry & supernovas::CatalogEntry::proper_motion	(	double	ra,
		double	dec )

Sets the proper motion of this source, defined at the same epoch as the catalog coordinates, returning itself to enable builder pattern.

Parameters

ra	[rad/s] Proper motion in the R.A. direction
dec	[rad/s] Proper motion in the declination direction

Returns: itself

See also: parallax(), distance(), radial_velocity(), v_lsr(), redshift(), catalog(); system()

References CatalogEntry(), supernovas::Validating::_valid, dec(), supernovas::Unit::mas, novas_set_proper_motion(), ra(), and supernovas::Unit::yr.

◆ ra()

TimeAngle supernovas::CatalogEntry::ra ( ) const

Returns the catalog right ascention (R.A.) coordinate as a time-angle.

Returns: the catalog right-ascention angle as defined in the catalog system.

See also: system(), equatorial(); dec(), distance(), parallax(), radial_velocity(), v_lsr(), redshift()

References supernovas::Unit::hour_angle, and supernovas::Validating::is_valid().

Referenced by equatorial(), and proper_motion().

◆ radial_velocity() [1/3]

ScalarVelocity supernovas::CatalogEntry::radial_velocity ( ) const

Returns the barycentric radial velocity of the source, that is the radial velocity with respect to the Solar System Barycenter (SSB).

Returns: the barycentric radial velocity (relative the SSB), or 0.0 if the source motion was not explicitly defined.

See also: system(), v_lsr(), redshift(); ra(), dec(), distance(), parallax()

References supernovas::Validating::is_valid(), supernovas::Unit::km, and supernovas::Unit::sec.

Referenced by radial_velocity(), and to_string().

◆ radial_velocity() [2/3]

CatalogEntry & supernovas::CatalogEntry::radial_velocity ( const ScalarVelocity & v )

Sets the radial velocity of this source relative to the Solar System Barycenter (SSB), defined at the same epoch as the catalog coordinates, and returning itself to enable builder pattern.

Parameters

v	radial velocity with respect to the Solar System Barycenter (SSB)

Returns: itself

See also: v_lsr(), redshift(); system(), distance(), parallax(), proper_motion(), catalog()

References CatalogEntry(), supernovas::ScalarVelocity::m_per_s(), and radial_velocity().

◆ radial_velocity() [3/3]

CatalogEntry & supernovas::CatalogEntry::radial_velocity ( double v_ms )

Sets the radial velocity of this source relative to the Solar System Barycenter (SSB), defined at the same epoch as the catalog coordinates, and returning itself to enable builder pattern.

Parameters

v_ms	[m/s] radial velocity with respect to the Solar System Barycenter (SSB)

Returns: itself

See also: v_lsr(), redshift(); system(), distance(), parallax(), proper_motion(), catalog()

References CatalogEntry(), supernovas::Validating::_valid, supernovas::Constant::c, supernovas::Unit::km, novas_set_ssb_vel(), and supernovas::Unit::sec.

◆ redshift() [1/2]

double supernovas::CatalogEntry::redshift ( ) const

Returns the barycentric redshift of the source, that is the redshift measure with respect to the Solar System Barycenter (SSB).

Returns: the nominal redshift (rel. to the SSB) of the source, or 0.0 if the source motion was not explicitly defined.

See also: system(), radial_velocity(), v_lsr(); ra(), dec(), distance(), parallax()

References supernovas::Unit::km, novas_v2z(), and supernovas::Unit::sec.

◆ redshift() [2/2]

CatalogEntry & supernovas::CatalogEntry::redshift ( double z )

Sets the redshift of this source relative to the Solar System Barycenter (SSB), defined at the same epoch as the catalog coordinates, and returning itself to enable builder pattern.

Parameters

z	barycentric redshift measure.

Returns: itself

See also: radial_velocity(), v_lsr(); system(), distance(), parallax(), proper_motion(), catalog()

References CatalogEntry(), supernovas::Validating::_valid, and novas_set_redshift().

◆ system()

const Equinox & supernovas::CatalogEntry::system ( ) const

Returns the equatorial coordinate system in which this catalog entry is defined.

Returns: the equatorial coordinate system of this catalog entry

See also: ra(), dec(), distance(), parallax(), radial_velocity(), v_lsr(), redshift()

Referenced by CatalogEntry(), CatalogEntry(), supernovas::CatalogSource::CatalogSource(), and equatorial().

◆ to_string()

std::string supernovas::CatalogEntry::to_string ( int decimals = 3 ) const

Returns a human-readable string representation of this catalog entry, showing only the most basic data.

Parameters

decimals [0:16] number of decimal places to print for coordinates.

Returns: a string describing this catalog entry.

References distance(), equatorial(), name(), NOVAS_SEP_UNITS_AND_SPACES, radial_velocity(), supernovas::Coordinate::to_string(), supernovas::Equatorial::to_string(), and supernovas::ScalarVelocity::to_string().

◆ v_lsr() [1/3]

ScalarVelocity supernovas::CatalogEntry::v_lsr ( ) const

Returns the scalar source velocity with respect to the Local Standard of Rest (LSR).

Returns: the LSR velocity of the source (or the LSR velocity of the SSB if the source motion was not explicitly defined).

See also: system(), radial_velocity(), redshift(); ra(), dec(), distance(), parallax()

References supernovas::Validating::is_valid(), supernovas::Unit::km, novas_ssb_to_lsr_vel(), and supernovas::Unit::sec.

Referenced by v_lsr().

◆ v_lsr() [2/3]

CatalogEntry & supernovas::CatalogEntry::v_lsr ( const ScalarVelocity & v )

Sets the motion of this source relative to the Local Standard of Rest (LSR), defined at the same epoch as the catalog coordinates, and returning itself to enable builder pattern.

Parameters

v	LSR velocity

Returns: itself

See also: radial_velocity(), redshift(); system(), distance(), parallax(), proper_motion(), catalog()

References CatalogEntry(), supernovas::ScalarVelocity::m_per_s(), and v_lsr().

◆ v_lsr() [3/3]

CatalogEntry & supernovas::CatalogEntry::v_lsr ( double v_ms )

Sets the motion of this source relative to the Local Standard of Rest (LSR), defined at the same epoch as the catalog coordinates, and returning itself to enable builder pattern.

Parameters

v_ms	[m/s] LSR velocity

Returns: itself

See also: radial_velocity(), redshift(); system(), distance(), parallax(), proper_motion(), catalog()

References CatalogEntry(), supernovas::Validating::_valid, supernovas::Constant::c, supernovas::Unit::km, novas_set_lsr_vel(), and supernovas::Unit::sec.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CatalogEntry() [1/4]

◆ CatalogEntry() [2/4]

◆ CatalogEntry() [3/4]

◆ CatalogEntry() [4/4]

Member Function Documentation

◆ _cat_entry()

◆ dec()

◆ distance() [1/3]

◆ distance() [2/3]

◆ distance() [3/3]

◆ equatorial()

◆ name()

◆ parallax() [1/3]

◆ parallax() [2/3]

◆ parallax() [3/3]

◆ proper_motion()

◆ ra()

◆ radial_velocity() [1/3]

◆ radial_velocity() [2/3]

◆ radial_velocity() [3/3]

◆ redshift() [1/2]

◆ redshift() [2/2]

◆ system()

◆ to_string()

◆ v_lsr() [1/3]

◆ v_lsr() [2/3]

◆ v_lsr() [3/3]