Identifiers and descriptive data of an object available in an ephemeris file. More...

#include <EphemerisFile.h>

Public Member Functions
	EphemerisObject (const EphemerisObject &)=default

	EphemerisObject (const IsoString &a_objectId, const IsoString &a_originId, const String &a_objectName=String(), const String &a_objectDescription=String(), Optional< double > a_H=Optional< double >(), Optional< double > a_G=Optional< double >(), Optional< double > a_M1=Optional< double >(), Optional< double > a_K1=Optional< double >(), Optional< double > a_M2=Optional< double >(), Optional< double > a_K2=Optional< double >(), Optional< double > a_PC=Optional< double >(), Optional< double > a_B_V=Optional< double >(), Optional< double > a_U_B=Optional< double >(), Optional< double > a_I_R=Optional< double >(), Optional< double > a_D=Optional< double >(), Optional< double > a_A1=Optional< double >(), Optional< double > a_A2=Optional< double >(), Optional< double > a_A3=Optional< double >(), Optional< double > a_DT=Optional< double >())

	EphemerisObject (EphemerisObject &&)=default

EphemerisObject &	operator= (const EphemerisObject &)=default

EphemerisObject &	operator= (EphemerisObject &&)=default

Public Attributes
Optional< double >	A1

Optional< double >	A2

Optional< double >	A3

Optional< double >	B_V

Optional< double >	D

Optional< double >	DT

Optional< double >	G

Optional< double >	H

Optional< double >	I_R

Optional< double >	K1

Optional< double >	K2

Optional< double >	M1

Optional< double >	M2

String	objectDescription

IsoString	objectId

String	objectName

IsoString	originId

Optional< double >	PC

Optional< double >	U_B

Detailed Description

This structure associates the unique identifier, origin identifier, name and description of an object or item available for ephemeris calculations. All of the data members in this structure are specific to a particular ephemeris file. A dynamic list of EphemerisObject instances (EphemerisObjectList) is returned by the EphemerisFile::Objects() member function.

See also: EphemerisFile::Objects()

Definition at line 539 of file EphemerisFile.h.

Constructor & Destructor Documentation

◆ EphemerisObject() [1/3]

pcl::EphemerisObject::EphemerisObject	(	const IsoString &	a_objectId,
		const IsoString &	a_originId,
		const String &	a_objectName = `String()`,
		const String &	a_objectDescription = `String()`,
		Optional< double >	a_H = `Optional<double>()`,
		Optional< double >	a_G = `Optional<double>()`,
		Optional< double >	a_M1 = `Optional<double>()`,
		Optional< double >	a_K1 = `Optional<double>()`,
		Optional< double >	a_M2 = `Optional<double>()`,
		Optional< double >	a_K2 = `Optional<double>()`,
		Optional< double >	a_PC = `Optional<double>()`,
		Optional< double >	a_B_V = `Optional<double>()`,
		Optional< double >	a_U_B = `Optional<double>()`,
		Optional< double >	a_I_R = `Optional<double>()`,
		Optional< double >	a_D = `Optional<double>()`,
		Optional< double >	a_A1 = `Optional<double>()`,
		Optional< double >	a_A2 = `Optional<double>()`,
		Optional< double >	a_A3 = `Optional<double>()`,
		Optional< double >	a_DT = `Optional<double>()`
	)

inline

Memberwise constructor.

Definition at line 688 of file EphemerisFile.h.

◆ EphemerisObject() [2/3]

pcl::EphemerisObject::EphemerisObject ( const EphemerisObject & )

default

Copy constructor.

◆ EphemerisObject() [3/3]

pcl::EphemerisObject::EphemerisObject ( EphemerisObject && )

default

Move constructor.

Member Function Documentation

◆ operator=() [1/2]

EphemerisObject& pcl::EphemerisObject::operator= ( const EphemerisObject & )

default

Copy assignment operator. Returns a reference to this object.

◆ operator=() [2/2]

EphemerisObject& pcl::EphemerisObject::operator= ( EphemerisObject && )

default

Move assignment operator. Returns a reference to this object.

Member Data Documentation

◆ A1

Optional<double> pcl::EphemerisObject::A1

Comet non-gravitational acceleration, radial component (au/day^2).

Definition at line 668 of file EphemerisFile.h.

◆ A2

Optional<double> pcl::EphemerisObject::A2

Comet non-gravitational acceleration, transverse component (au/day^2).

Definition at line 673 of file EphemerisFile.h.

◆ A3

Optional<double> pcl::EphemerisObject::A3

Comet non-gravitational acceleration, normal component (au/day^2).

Definition at line 678 of file EphemerisFile.h.

◆ B_V

Optional<double> pcl::EphemerisObject::B_V

Color index B-V in magnitudes.

Definition at line 648 of file EphemerisFile.h.

◆ D

Optional<double> pcl::EphemerisObject::D

Diameter of the object in km.

Definition at line 663 of file EphemerisFile.h.

◆ DT

Optional<double> pcl::EphemerisObject::DT

Comet non-gravitational acceleration, perihelion time offset (days).

Definition at line 683 of file EphemerisFile.h.

◆ G

Optional<double> pcl::EphemerisObject::G

Asteroid magnitude slope parameter. See the H data member for references.

Definition at line 599 of file EphemerisFile.h.

◆ H

Optional<double> pcl::EphemerisObject::H

Absolute asteroid magnitude. H is the visual magnitude of the object as seen at 1 au of the Earth, 1 au from the Sun, and with a phase angle of zero degrees.

References

E. Bowell et al., Asteroids II, R. P. Binzel et al. (eds.), The University of Arizona Press, Tucson, 1989, pp. 549-554.

Urban, Sean E., Kenneth Seidelmann, P., ed. (2013), The Explanatory Supplement to the Astronomical Almanac 3rd Edition, Section 10.4.3.

Definition at line 594 of file EphemerisFile.h.

◆ I_R

Optional<double> pcl::EphemerisObject::I_R

Color index I-R in magnitudes.

Definition at line 658 of file EphemerisFile.h.

◆ K1

Optional<double> pcl::EphemerisObject::K1

Comet total magnitude slope parameter. See the M1 data member for information on the calculation of comet apparent magnitudes.

Definition at line 624 of file EphemerisFile.h.

◆ K2

Optional<double> pcl::EphemerisObject::K2

Comet nuclear magnitude slope parameter. See the M1 data member for information on the calculation of comet apparent magnitudes.

Definition at line 637 of file EphemerisFile.h.

◆ M1

Optional<double> pcl::EphemerisObject::M1

Comet total absolute magnitude. M1 is the visual absolute magnitude of the comet's combined nucleus and coma.

For the calculation of apparent comet magnitudes we apply the following equations:

Tmag = M1 + 5*log(d) + K1*log(r)
Nmag = M2 + 5*log(d) + K2*log(r) + PC*beta

where Tmag and Nmag are, respectively, the total (nucleus+coma) and nuclear apparent magnitudes. In these equations, M1 and M2 are the comet's total and nuclear absolute magnitude paranmeters, K1 and K2 are the total and nuclear magnitude slope parameters, PC is the nuclear magnitude phase coefficient, d is the comet's distance to Earth, r is its distance from the Sun, and beta is the phase angle.

Definition at line 618 of file EphemerisFile.h.

◆ M2

Optional<double> pcl::EphemerisObject::M2

Comet nuclear absolute magnitude. M2 is the visual absolute magnitude of the comet's nucleus. See the M1 data member for information on the calculation of comet apparent magnitudes.

Definition at line 631 of file EphemerisFile.h.

◆ objectDescription

String pcl::EphemerisObject::objectDescription

Optional information about the object and/or the ephemeris data.

Definition at line 579 of file EphemerisFile.h.

◆ objectId

IsoString pcl::EphemerisObject::objectId

Unique identifier of an object or item for which ephemeris data are available. This is a short string that uniquely identifies the object in the context of an ephemeris file.

For example, standard XEPH files serializing JPL DE/LE ephemerides use a two/three letter convention for object identifiers: 'Me', 'Ve', 'EMB', 'Ea', 'Ma', etc, respectively for Mercury, Venus, Earth-Moon barycenter, Earth, Mars, etc. Object identifiers are considered as case-sensitive in XEPH files.

Definition at line 552 of file EphemerisFile.h.

◆ objectName

String pcl::EphemerisObject::objectName

Optional Name of the object or item for which ephemeris data are available. This can be an arbitrary string, such as 'Saturn', 'Iris', or 'C/1996 B2'. Object names are considered as case-insensitive in XEPH files, so all of 'Jupiter', 'jupiter' and 'JUPITER' are equivalent.

Definition at line 574 of file EphemerisFile.h.

◆ originId

IsoString pcl::EphemerisObject::originId

Identifier of the origin of coordinates (case-sensitive). This can be the unique identifier of a solar system object, or the identifier of an arbitrary object or location, specific to a particular ephemeris file.

For example, if the object provides geocentric coordinates, this member should be "Ea", which is the unique identifier of the Earth's center in standard fundamental ephemerides files. Similarly, if the ephemerides are heliocentric, this member should be "Sn". If the ephemeris data are with respect to the solar system barycenter, this member must be "SSB", also for coherence with fundamental ephemerides.

Definition at line 566 of file EphemerisFile.h.

◆ PC

Optional<double> pcl::EphemerisObject::PC

Comet nuclear magnitude phase coefficient. See the M1 data member for information on the calculation of comet apparent magnitudes.

Definition at line 643 of file EphemerisFile.h.

◆ U_B

Optional<double> pcl::EphemerisObject::U_B

Color index U-B in magnitudes.

Definition at line 653 of file EphemerisFile.h.

The documentation for this struct was generated from the following file:

EphemerisFile.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EphemerisObject() [1/3]

◆ EphemerisObject() [2/3]

◆ EphemerisObject() [3/3]

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

Member Data Documentation

◆ A1

◆ A2

◆ A3

◆ B_V

◆ D

◆ DT

◆ G

◆ H

◆ I_R

◆ K1

◆ K2

◆ M1

◆ M2

◆ objectDescription

◆ objectId

◆ objectName

◆ originId

◆ PC

◆ U_B