kstars
#include <obsconditions.h>
Public Types | |
enum | Equipment { Telescope, Binoculars, Both, None } |
enum | TelescopeType { Reflector = 0, Refractor, Invalid } |
Public Member Functions | |
ObsConditions (int bortle, double aperture, Equipment equip, TelescopeType telType) | |
~ObsConditions () | |
double | getOptimumMAG () |
double | getTrueMagLim () |
bool | isVisible (GeoLocation *geo, dms *lst, SkyObject *so) |
void | setEquipment (Equipment equip) |
void | setLimMagnitude () |
void | setObsConditions (int bortle, double aperture, Equipment equip, TelescopeType telType) |
void | setTelescopeType (TelescopeType telType) |
Static Public Member Functions | |
static QMap< int, double > | setLMMap () |
Detailed Description
This class deals with the observing conditions of the night sky.
The limiting magntude is calculated depending on the equipment available to the user and the amount of light-pollution in the user's current observing location.
Definition at line 31 of file obsconditions.h.
Member Enumeration Documentation
Equipment available to the user.
Enumerator | |
---|---|
Telescope | |
Binoculars | |
Both | |
None |
Definition at line 38 of file obsconditions.h.
Telescope Type (Reflector/Refractor)
Enumerator | |
---|---|
Reflector | |
Refractor | |
Invalid |
Definition at line 44 of file obsconditions.h.
Constructor & Destructor Documentation
ObsConditions::ObsConditions | ( | int | bortle, |
double | aperture, | ||
Equipment | equip, | ||
TelescopeType | telType | ||
) |
Constructor.
- Parameters
-
bortle Rating of light pollution based on the bortle dark-sky scale. aperture Aperture of equipment. equip Equipment available to the user. telType Refelctor/Refractor type of telescope (if available)
Definition at line 22 of file obsconditions.cpp.
ObsConditions::~ObsConditions | ( | ) |
Destructor.
Definition at line 43 of file obsconditions.cpp.
Member Function Documentation
double ObsConditions::getOptimumMAG | ( | ) |
Get optimum magnification under current observing conditions.
- Returns
- Get optimum magnification under current observing conditions
Definition at line 68 of file obsconditions.cpp.
double ObsConditions::getTrueMagLim | ( | ) |
Get true limiting magnitude after taking equipment specifications into consideration.
- Returns
- True limiting magnitude after taking equipment specifications into consideration.
If there is no equipment available then return limiting magnitude for naked-eye
This is a more traditional formula which does not take the 't' parameter into account. It also does not take into account the magnification being used. The formula used is:
TLM_trad = LM + 5*log10(aperture/7.5)
The calculation is just based on the calculation of the telescope's aperture to eye's pupil surface ratio.
Definition at line 74 of file obsconditions.cpp.
bool ObsConditions::isVisible | ( | GeoLocation * | geo, |
dms * | lst, | ||
SkyObject * | so | ||
) |
Evaluate visibility of sky-object based on current observing conditions.
- Returns
- Visibility of sky-object based on current observing conditions as a boolean.
- Parameters
-
geo Geographic location of user. lst Local standard time expressed as a dms object. so SkyObject for which visibility is to be evaluated.
Definition at line 96 of file obsconditions.cpp.
|
inline |
Inline method to set available equipment.
Definition at line 63 of file obsconditions.h.
void ObsConditions::setLimMagnitude | ( | ) |
Set limiting magnitude depending on Bortle dark-sky rating.
Definition at line 63 of file obsconditions.cpp.
|
static |
Create QMap<int, double> to be initialised to static member variable m_LMMap.
- Returns
- QMap<int, double> to be initialised to static member variable m_LMMap
Definition at line 45 of file obsconditions.cpp.
void ObsConditions::setObsConditions | ( | int | bortle, |
double | aperture, | ||
ObsConditions::Equipment | equip, | ||
ObsConditions::TelescopeType | telType | ||
) |
Set new observing conditions.
Definition at line 107 of file obsconditions.cpp.
|
inline |
Inline method to set reflector/refractor type for telescope.
Definition at line 68 of file obsconditions.h.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:36:23 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.