KSComet Class Reference

#include <kscomet.h>

Inheritance diagram for KSComet:

Public Member Functions
	KSComet (const QString &s, const QString &image_file, long double JD, double q, double e, dms i, dms w, dms N, double Tp, float M1, float M2, float K1, float K2)
virtual	~KSComet ()
virtual KSComet *	clone () const
float	getAlbedo ()
float	getDiameter ()
QString	getDimensions ()
double	getEarthMOID ()
float	getNuclearMagnitudeParameter ()
float	getNuclearSize ()
float	getNuclearSlopeParameter ()
QString	getOrbitClass ()
QString	getOrbitID ()
double	getPerihelion ()
long double	getPerihelionJD ()
float	getPeriod ()
float	getRotationPeriod ()
dms	getTailAngSize ()
float	getTailSize ()
float	getTotalMagnitudeParameter ()
float	getTotalSlopeParameter ()
virtual SkyObject::UID	getUID () const
bool	isNEO ()
virtual bool	loadData ()
void	setAlbedo (float albedo)
void	setDiameter (float diam)
void	setDimensions (QString dim)
void	setEarthMOID (double earth_moid)
void	setNEO (bool neo)
void	setOrbitClass (QString orbit_class)
void	setOrbitID (QString orbit_id)
void	setPeriod (float per)
void	setRotationPeriod (float rot_per)
void	setTailAngSize (double tailangsize)
void	setTailSize (double tailsize)
Public Member Functions inherited from KSPlanetBase
	KSPlanetBase (const QString &s=i18n("unnamed"), const QString &image_file=QString(), const QColor &c=Qt::white, double pSize=0)
virtual	~KSPlanetBase ()
double	angSize () const
QColor &	color ()
const dms &	ecLat () const
void	EclipticToEquatorial (const dms *Obliquity)
const dms &	ecLong () const
void	EquatorialToEcliptic (const dms *Obliquity)
void	findPosition (const KSNumbers *num, const dms *lat=0, const dms *LST=0, const KSPlanetBase *Earth=0)
const dms &	helEcLat () const
const dms &	helEcLong () const
const QImage &	image ()
void	init (const QString &s, const QString &image_file, const QColor &c, double pSize)
bool	isMajorPlanet () const
virtual double	labelOffset () const
virtual double	pa () const
dms	phase ()
double	physicalSize () const
double	rearth () const
double	rsun () const
void	setAngularSize (double size)
void	setColor (const QColor &c)
void	setEcLat (dms elat)
void	setEcLong (dms elong)
void	setPA (double p)
void	setPhysicalSize (double size)
void	setRearth (double r)
void	setRearth (const KSPlanetBase *Earth)
void	setRsun (double r)
virtual void	updateCoords (KSNumbers *num, bool includePlanets=true, const dms *lat=0, const dms *LST=0, bool forceRecompute=false)
Public Member Functions inherited from TrailObject
	TrailObject (int t=TYPE_UNKNOWN, dms r=dms(0.0), dms d=dms(0.0), float m=0.0, const QString &n=QString())
	TrailObject (int t, double r, double d, float m=0.0, const QString &n=QString())
virtual	~TrailObject ()
void	addToTrail ()
void	clearTrail ()
void	clipTrail ()
void	drawTrail (SkyPainter *skyp) const
bool	hasTrail () const
const QList< SkyPoint > &	trail () const
void	updateTrail (dms *LST, const dms *lat)
Public Member Functions inherited from SkyObject
	SkyObject (int t=TYPE_UNKNOWN, dms r=dms(0.0), dms d=dms(0.0), float m=0.0, const QString &n=QString(), const QString &n2=QString(), const QString &lname=QString())
	SkyObject (int t, double r, double d, float m=0.0, const QString &n=QString(), const QString &n2=QString(), const QString &lname=QString())
virtual	~SkyObject ()
bool	hasAuxInfo ()
bool	hasLongName () const
bool	hasName () const
bool	hasName2 () const
QStringList &	ImageList ()
QStringList &	ImageTitle ()
QStringList &	InfoList ()
QStringList &	InfoTitle ()
bool	isSolarSystem () const
virtual QString	labelString () const
virtual QString	longname (void) const
float	mag (void) const
float	mag (const QString &band) const
QString	messageFromTitle (const QString &imageTitle)
virtual QString	name (void) const
QString	name2 (void) const
QString &	notes ()
SkyPoint	recomputeCoords (const KStarsDateTime &dt, const GeoLocation *geo=0)
QTime	riseSetTime (const KStarsDateTime &dt, const GeoLocation *geo, bool rst, bool exact=true)
dms	riseSetTimeAz (const KStarsDateTime &dt, const GeoLocation *geo, bool rst)
QTime	riseSetTimeUT (const KStarsDateTime &dt, const GeoLocation *geo, bool rst, bool exact=true)
void	saveUserLog (const QString &newLog)
void	setLongName (const QString &longname=QString())
void	setNotes (QString _notes)
void	setType (int t)
void	showPopupMenu (KSPopupMenu *pmenu, const QPoint &pos)
dms	transitAltitude (const KStarsDateTime &dt, const GeoLocation *geo)
QTime	transitTime (const KStarsDateTime &dt, const GeoLocation *geo)
QTime	transitTimeUT (const KStarsDateTime &dt, const GeoLocation *geo)
QString	translatedLongName () const
QString	translatedName () const
QString	translatedName2 () const
int	type (void) const
QString	typeName () const
QString &	userLog ()
Public Member Functions inherited from SkyPoint
	SkyPoint (const dms &r, const dms &d)
	SkyPoint (double r, double d)
	SkyPoint ()
virtual	~SkyPoint ()
void	aberrate (const KSNumbers *num)
void	addEterms (void)
const dms &	alt () const
dms	altRefracted () const
dms	angularDistanceTo (const SkyPoint *sp, double *const positionAngle=0) const
void	apparentCoord (long double jd0, long double jdf)
const dms &	az () const
void	B1950ToJ2000 (void)
bool	bendlight ()
bool	checkBendLight ()
bool	checkCircumpolar (const dms *gLat)
const dms &	dec () const
const dms &	dec0 () const
SkyPoint	deprecess (const KSNumbers *num, long double epoch=J2000)
void	Equatorial1950ToGalactic (dms &galLong, dms &galLat)
void	EquatorialToHorizontal (const dms *LST, const dms *lat)
SkyPoint	Eterms (void)
void	findEcliptic (const dms *Obliquity, dms &EcLong, dms &EcLat)
void	GalacticToEquatorial1950 (const dms *galLong, const dms *galLat)
void	HorizontalToEquatorial (const dms *LST, const dms *lat)
void	J2000ToB1950 (void)
SkyPoint	moveAway (const SkyPoint &from, double dist)
void	nutate (const KSNumbers *num)
bool	operator== (SkyPoint &p)
void	precessFromAnyEpoch (long double jd0, long double jdf)
const dms &	ra () const
const dms &	ra0 () const
void	set (const dms &r, const dms &d)
void	setAlt (dms alt)
void	setAlt (double alt)
void	setAz (dms az)
void	setAz (double az)
void	setDec (dms d)
void	setDec (double d)
void	setDec0 (dms d)
void	setDec0 (double d)
void	setFromEcliptic (const dms *Obliquity, const dms &EcLong, const dms &EcLat)
void	setRA (dms r)
void	setRA (double r)
void	setRA0 (dms r)
void	setRA0 (double r)
void	subtractEterms (void)
double	vGeocentric (double vhelio, long double jd)
double	vGeoToVHelio (double vgeo, long double jd)
double	vHeliocentric (double vlsr, long double jd)
double	vHelioToVlsr (double vhelio, long double jd)
double	vREarth (long double jd0)
double	vRSite (double vsite[3])
double	vRSun (long double jd)
double	vTopocentric (double vgeo, double vsite[3])
double	vTopoToVGeo (double vtopo, double vsite[3])

Protected Member Functions
virtual bool	findGeocentricPosition (const KSNumbers *num, const KSPlanetBase *Earth=NULL)
void	findPhysicalParameters ()
Protected Member Functions inherited from KSPlanetBase
void	findPA (const KSNumbers *num)
virtual void	findPhase ()
UID	solarsysUID (UID type) const
Protected Member Functions inherited from SkyObject
void	setMag (float m)
void	setMag (const QString &band, const double mag)
void	setName (const QString &name)
void	setName2 (const QString &name2=QString())
Protected Member Functions inherited from SkyPoint
void	precess (const KSNumbers *num)

Additional Inherited Members
Public Types inherited from KSPlanetBase
enum	Planets {   MERCURY =0, VENUS =1, MARS =2, JUPITER =3,   SATURN =4, URANUS =5, NEPTUNE =6, PLUTO =7,   SUN =8, MOON =9, UNKNOWN_PLANET }
Public Types inherited from SkyObject
enum	TYPE {   STAR =0, CATALOG_STAR =1, PLANET =2, OPEN_CLUSTER =3,   GLOBULAR_CLUSTER =4, GASEOUS_NEBULA =5, PLANETARY_NEBULA =6, SUPERNOVA_REMNANT =7,   GALAXY =8, COMET =9, ASTEROID =10, CONSTELLATION =11,   MOON =12, ASTERISM =13, GALAXY_CLUSTER =14, DARK_NEBULA =15,   QUASAR =16, MULT_STAR =17, RADIO_SOURCE =18, SATELLITE =19,   SUPERNOVA =20, TYPE_UNKNOWN }
typedef qint64	UID
Static Public Member Functions inherited from KSPlanetBase
static KSPlanetBase *	createPlanet (int n)
Static Public Member Functions inherited from TrailObject
static void	clearTrailsExcept (SkyObject *o)
Static Public Member Functions inherited from SkyObject
static QString	typeName (const int t)
Static Public Member Functions inherited from SkyPoint
static double	refract (const double alt)
static dms	refract (const dms alt)
static double	refractionCorr (double alt)
static double	unrefract (const double alt)
static dms	unrefract (const dms alt)
Static Public Attributes inherited from KSPlanetBase
static QVector< QColor >	planetColor
Static Public Attributes inherited from TrailObject
static const int	MaxTrail = 400
Static Public Attributes inherited from SkyObject
static const UID	invalidUID = ~0
static const UID	UID_DEEPSKY = 2
static const UID	UID_GALAXY = 1
static const UID	UID_SOLARSYS = 3
static const UID	UID_STAR = 0
Static Public Attributes inherited from SkyPoint
static const double	altCrit = -1.0
Protected Attributes inherited from KSPlanetBase
EclipticPosition	ep
EclipticPosition	helEcPos
QImage	m_image
double	Phase
double	Rearth
Protected Attributes inherited from TrailObject
QList< SkyPoint >	Trail
Protected Attributes inherited from SkyObject
QSharedDataPointer< AuxInfo >	info
QString	LongName
QString	Name
QString	Name2
Protected Attributes inherited from SkyPoint
long double	lastPrecessJD
Static Protected Attributes inherited from KSPlanetBase
static const UID	UID_SOL_ASTEROID = 1
static const UID	UID_SOL_BIGOBJ = 0
static const UID	UID_SOL_COMET = 2
Static Protected Attributes inherited from TrailObject
static QSet< TrailObject * >	trailObjects
Static Protected Attributes inherited from SkyObject
static QString	emptyString
static QString	starString = QString("star")
static QString	unnamedObjectString = QString(I18N_NOOP("unnamed object"))
static QString	unnamedString = QString(I18N_NOOP("unnamed"))

Detailed Description

A subclass of KSPlanetBase that implements comets.

The orbital elements are stored as private member variables, and it provides methods to compute the ecliptic coordinates for any time from the orbital elements.

The orbital elements are:

• JD Epoch of element values
• q perihelion distance (AU)
• e eccentricity of orbit
• i inclination angle (with respect to J2000.0 ecliptic plane)
• w argument of perihelion (w.r.t. J2000.0 ecliptic plane)
• N longitude of ascending node (J2000.0 ecliptic)
• Tp time of perihelion passage (YYYYMMDD.DDD)
• M1 comet total magnitude parameter
• M2 comet nuclear magnitude parameter
• K1 total magnitude slope parameter
• K2 nuclear magnitude slope parameter

Author

Jason Harris

Version

1.1

Definition at line 50 of file kscomet.h.

Constructor & Destructor Documentation

KSComet::KSComet	(	const QString &	s,
		const QString &	image_file,
		long double	JD,
		double	q,
		double	e,
		dms	i,
		dms	w,
		dms	N,
		double	Tp,
		float	M1,
		float	M2,
		float	K1,
		float	K2
	)

Constructor.

Parameters

s	the name of the comet
image_file	the filename for an image of the comet
JD	the Julian Day for the orbital elements
q	the perihelion distance of the comet's orbit (AU)
e	the eccentricity of the comet's orbit
i	the inclination angle of the comet's orbit
w	the argument of the orbit's perihelion
N	the longitude of the orbit's ascending node
Tp	The date of the most proximate perihelion passage (YYYYMMDD.DDD)
M1	the comet total magnitude parameter
M2	the comet nuclear magnitude parameter
K1	the comet total magnitude slope parameter
K2	the comet nuclear magnitude slope parameter

Definition at line 54 of file kscomet.cpp.

virtual KSComet::~KSComet ( )

inlinevirtual

Destructor (empty)

Definition at line 76 of file kscomet.h.

Member Function Documentation

KSComet * KSComet::clone ( ) const

virtual

Create copy of object.

This method is virtual copy constructor. It allows for safe copying of objects. In other words, KSPlanet object stored in SkyObject pointer will be copied as KSPlanet. Each subclass of SkyObject MUST implement clone method.

Returns

pointer to newly allocated object. Caller takes full responsibility for deallocating it.

Reimplemented from TrailObject.

Definition at line 134 of file kscomet.cpp.

bool KSComet::findGeocentricPosition ( const KSNumbers *  num, const KSPlanetBase *  Earth = NULL  )

protectedvirtual

Calculate the geocentric RA, Dec coordinates of the Comet.

Note

reimplemented from KSPlanetBase

Parameters

num	time-dependent values for the desired date
Earth	planet Earth (needed to calculate geocentric coords)

Returns

true if position was successfully calculated.

Implements KSPlanetBase.

Definition at line 156 of file kscomet.cpp.

void KSComet::findPhysicalParameters ( )

protected

Estimate physical parameters of the comet such as coma size, tail length and size of the nucleus.

Note

invoked from findGeocentricPosition in order

Definition at line 139 of file kscomet.cpp.

float KSComet::getAlbedo ( )

inline

Returns

the comet's albedo

Definition at line 188 of file kscomet.h.

float KSComet::getDiameter ( )

inline

Returns

the comet's diameter

Definition at line 198 of file kscomet.h.

QString KSComet::getDimensions ( )

inline

Returns

the comet's dimensions

Definition at line 208 of file kscomet.h.

double KSComet::getEarthMOID ( )

inline

Returns

the comet's earth minimum orbit intersection distance in km

Definition at line 148 of file kscomet.h.

float KSComet::getNuclearMagnitudeParameter ( )

inline

Returns

the comet nuclear magnitude parameter

Definition at line 103 of file kscomet.h.

float KSComet::getNuclearSize ( )

inline

Returns

the estimated diameter of the nucleus in km

Definition at line 138 of file kscomet.h.

float KSComet::getNuclearSlopeParameter ( )

inline

Returns

the nuclear magnitude slope parameter

Definition at line 113 of file kscomet.h.

QString KSComet::getOrbitClass ( )

inline

Returns

the comet's orbit class

Definition at line 168 of file kscomet.h.

QString KSComet::getOrbitID ( )

inline

Returns

the comet's orbit solution ID

Definition at line 158 of file kscomet.h.

double KSComet::getPerihelion ( )

inline

Returns Perihelion distance.

Returns

Perihelion distance

Definition at line 93 of file kscomet.h.

long double KSComet::getPerihelionJD ( )

inline

Returns the Julian Day of Perihelion passage.

Returns

Julian Day of Perihelion Passage

Definition at line 87 of file kscomet.h.

float KSComet::getPeriod ( )

inline

Returns

the comet's period

Definition at line 228 of file kscomet.h.

float KSComet::getRotationPeriod ( )

inline

Returns

the comet's rotation period

Definition at line 218 of file kscomet.h.

dms KSComet::getTailAngSize ( )

inline

Returns

the estimated angular size of the tail as a dms

Definition at line 133 of file kscomet.h.

float KSComet::getTailSize ( )

inline

Returns

the estimated tail length in km

Definition at line 123 of file kscomet.h.

float KSComet::getTotalMagnitudeParameter ( )

inline

Returns

the comet total magnitude parameter

Definition at line 98 of file kscomet.h.

float KSComet::getTotalSlopeParameter ( )

inline

Returns

the total magnitude slope parameter

Definition at line 108 of file kscomet.h.

SkyObject::UID KSComet::getUID ( ) const

virtual

Return UID for object.

This method should be reimplemented in all concrete subclasses. Implementation for SkyObject just returns invalidUID. It's required SkyObject is not an abstract class.

Reimplemented from SkyObject.

Definition at line 318 of file kscomet.cpp.

bool KSComet::isNEO ( )

inline

Returns

true if the comet is a near earth object

Definition at line 178 of file kscomet.h.

bool KSComet::loadData ( )

virtual

Unused virtual function inherited from KSPlanetBase, so it's simply empty here.

Implements KSPlanetBase.

Definition at line 316 of file kscomet.cpp.

void KSComet::setAlbedo

(

float

albedo

)

Sets the comet's albedo.

Definition at line 275 of file kscomet.cpp.

void KSComet::setDiameter

(

float

diam

)

Sets the comet's diameter.

Definition at line 280 of file kscomet.cpp.

void KSComet::setDimensions

(

QString

dim

)

Sets the comet's dimensions.

Definition at line 285 of file kscomet.cpp.

void KSComet::setEarthMOID

(

double

earth_moid

)

Sets the comet's earth minimum orbit intersection distance.

Definition at line 270 of file kscomet.cpp.

void KSComet::setNEO

(

bool

neo

)

Sets if the comet is a near earth object.

Definition at line 290 of file kscomet.cpp.

void KSComet::setOrbitClass

(

QString

orbit_class

)

Sets the comet's orbit class.

Definition at line 295 of file kscomet.cpp.

void KSComet::setOrbitID

(

QString

orbit_id

)

Sets the comet's orbit solution ID.

Definition at line 300 of file kscomet.cpp.

void KSComet::setPeriod

(

float

per

)

Sets the comet's period.

Definition at line 305 of file kscomet.cpp.

void KSComet::setRotationPeriod

(

float

rot_per

)

Sets the comet's rotation period.

Definition at line 310 of file kscomet.cpp.

void KSComet::setTailAngSize ( double  tailangsize )

inline

Sets the comet's apparent tail length in degrees.

Definition at line 128 of file kscomet.h.

void KSComet::setTailSize ( double  tailsize )

inline

Sets the comet's tail length in km.

Definition at line 118 of file kscomet.h.

---

The documentation for this class was generated from the following files:

• kscomet.h
• kscomet.cpp