ObsConditions

Search for usage in LXR

#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)
 
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 magnitude is calculated depending on the equipment available to the user and the amount of light-pollution in the user's current observing location.

Author
Samikshan Bairagya

Definition at line 21 of file obsconditions.h.

Member Enumeration Documentation

◆ Equipment

Equipment available to the user.

Definition at line 29 of file obsconditions.h.

◆ TelescopeType

Telescope Type (Reflector/Refractor)

Definition at line 42 of file obsconditions.h.

Constructor & Destructor Documentation

◆ ObsConditions()

ObsConditions::ObsConditions ( int  bortle,
double  aperture,
Equipment  equip,
TelescopeType  telType 
)

Constructor.

Parameters
bortleRating of light pollution based on the bortle dark-sky scale.
apertureAperture of equipment.
equipEquipment available to the user.
telTypeReflector/Refractor type of telescope (if available)

Definition at line 13 of file obsconditions.cpp.

Member Function Documentation

◆ getOptimumMAG()

double ObsConditions::getOptimumMAG ( )

Get optimum magnification under current observing conditions.

Returns
Get optimum magnification under current observing conditions

Definition at line 57 of file obsconditions.cpp.

◆ getTrueMagLim()

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 63 of file obsconditions.cpp.

◆ isVisible()

bool ObsConditions::isVisible ( GeoLocation geo,
dms lst,
SkyObject so 
)

Evaluate visibility of sky-object based on current observing conditions.

Parameters
geoGeographic location of user.
lstLocal standard time expressed as a dms object.
soSkyObject for which visibility is to be evaluated.
Returns
Visibility of sky-object based on current observing conditions as a boolean.

Definition at line 86 of file obsconditions.cpp.

◆ setEquipment()

void ObsConditions::setEquipment ( Equipment  equip)
inline

Inline method to set available equipment.

Definition at line 62 of file obsconditions.h.

◆ setLimMagnitude()

void ObsConditions::setLimMagnitude ( )

Set limiting magnitude depending on Bortle dark-sky rating.

Definition at line 52 of file obsconditions.cpp.

◆ setLMMap()

QMap< int, double > ObsConditions::setLMMap ( )
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 34 of file obsconditions.cpp.

◆ setObsConditions()

void ObsConditions::setObsConditions ( int  bortle,
double  aperture,
ObsConditions::Equipment  equip,
ObsConditions::TelescopeType  telType 
)

Set new observing conditions.

Definition at line 101 of file obsconditions.cpp.

◆ setTelescopeType()

void ObsConditions::setTelescopeType ( TelescopeType  telType)
inline

Inline method to set reflector/refractor type for telescope.

Definition at line 65 of file obsconditions.h.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Aug 18 2022 03:56:47 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.