Stellarium
0.21.3
|
The Pulsars plugin plots the position of various pulsars, with object information about each one. Pulsar data is derived from Catalog of Pulsars (Taylor+ 1995) for 0.1.x series and derived from The ATNF Pulsar Catalogue (Manchester, R. N., Hobbs, G. B., Teoh, A. & Hobbs, M., Astron. J., 129, 1993-2006 (2005) (astro-ph/0412641)) for series 0.2.x. More...
Data Structures | |
class | PulsarsDialog |
class | Pulsar |
class | Pulsars |
Typedefs | |
typedef QSharedPointer< Pulsar > | PulsarP |
Pulsars Catalog
The pulsars catalog is stored on the disk in JSON format, in a file named "pulsars.json". A default copy is embedded in the plug-in at compile time. A working copy is kept in the user data directory.
Configuration
The plug-ins' configuration data is stored in Stellarium's main configuration file (section [Pulsars]).
class PulsarsDialog |
Public Slots | |
void | retranslate () |
void | refreshUpdateValues (void) |
Public Slots inherited from StelDialog | |
virtual void | retranslate ()=0 |
Retranslate the content of the dialog. More... | |
virtual void | setVisible (bool) |
On the first call with "true" populates the window contents. | |
virtual void | close () |
Closes the window (the window widget is not deleted, just not visible). | |
void | handleMovedTo (QPoint newPos) |
Adds dialog location to config.ini; should be connected in createDialogContent() | |
virtual void | handleDialogSizeChanged (QSizeF size) |
Stores dialog sizes into config.ini; should be connected from the proxy. More... | |
QString | getDialogName () const |
Protected Member Functions | |
void | createDialogContent () |
Initialize the dialog widgets and connect the signals/slots. | |
Protected Member Functions inherited from StelDialog | |
void | connectColorButton (QToolButton *button, QString propertyName, QString iniName, QString moduleName="") |
Prepare a QToolButton so that it can receive and handle askColor() connections properly. More... | |
Additional Inherited Members | |
Signals inherited from StelDialog | |
void | visibleChanged (bool) |
Public Member Functions inherited from StelDialog | |
StelDialog (QString dialogName="Default", QObject *parent=Q_NULLPTR) | |
virtual void | styleChanged () |
Notify that the application style changed. | |
bool | visible () const |
Returns true if the dialog contents have been constructed and are currently shown. | |
Protected Slots inherited from StelDialog | |
bool | askConfirmation () |
void | askColor () |
To be called by a connected QToolButton with a color background. More... | |
void | enableKineticScrolling (bool b) |
enable kinetic scrolling. This should be connected to StelApp's StelGui signal flagUseKineticScrollingChanged. | |
void | handleFontChanged () |
connect from StelApp to handle font and font size changes. | |
virtual void | updateNightModeProperty (bool n) |
Static Protected Member Functions inherited from StelDialog | |
static void | connectCheckBox (QAbstractButton *checkBox, const QString &actionName) |
Helper function to connect a checkbox to the StelAction with the specified name. | |
static void | connectCheckBox (QAbstractButton *checkBox, StelAction *action) |
Helper function to connect a checkbox to the given StelAction. | |
static void | connectIntProperty (QLineEdit *lineEdit, const QString &propName) |
Helper function to connect a QLineEdit to an integer StelProperty. More... | |
static void | connectIntProperty (QSpinBox *spinBox, const QString &propName) |
Helper function to connect a QSpinBox to an integer StelProperty. More... | |
static void | connectIntProperty (QComboBox *comboBox, const QString &propName) |
Helper function to connect a QComboBox to an integer StelProperty. More... | |
static void | connectIntProperty (QSlider *slider, const QString &propName, int minValue, int maxValue) |
Helper function to connect a QSlider to an double or float StelProperty. More... | |
static void | connectDoubleProperty (QDoubleSpinBox *spinBox, const QString &propName) |
Helper function to connect a QDoubleSpinBox to an double or float StelProperty. More... | |
static void | connectDoubleProperty (AngleSpinBox *spinBox, const QString &propName) |
Helper function to connect an AngleSpinBox to a double or float StelProperty representing decimal degrees. More... | |
static void | connectDoubleProperty (QSlider *slider, const QString &propName, double minValue, double maxValue) |
Helper function to connect a QSlider to an double or float StelProperty. More... | |
static void | connectStringProperty (QComboBox *comboBox, const QString &propName) |
Helper function to connect a QComboBox to a QString StelProperty. More... | |
static void | connectStringProperty (QLineEdit *lineEdit, const QString &propName) |
Helper function to connect a QLineEdit to a QString StelProperty. More... | |
static void | connectBoolProperty (QAbstractButton *checkBox, const QString &propName) |
Helper function to connect a checkbox to a bool StelProperty. More... | |
static void | connectBoolProperty (QGroupBox *checkBox, const QString &propName) |
Helper function to connect a groupbox to a bool StelProperty. More... | |
Protected Attributes inherited from StelDialog | |
QWidget * | dialog |
The main dialog. | |
class CustomProxy * | proxy |
QString | dialogName |
The name should be set in derived classes' constructors and can be used to store and retrieve the panel locations. | |
QList< QWidget * > | kineticScrollingList |
A list of widgets where kinetic scrolling can be activated or deactivated The list must be filled once, in the constructor or init() of fillDialog() etc. More... | |
Properties inherited from StelDialog | |
bool | visible |
class Pulsar |
A Pulsar object represents one pulsar on the sky. Details about the Pulsars are passed using a QVariant which contains a map of data from the json file.
Public Member Functions | |
Pulsar (const QVariantMap &map) | |
QVariantMap | getMap (void) const |
Get a QVariantMap which describes the pulsar. More... | |
virtual QString | getType (void) const |
Get the type of object. | |
virtual QString | getID (void) const |
Returns a unique identifier for this object. More... | |
virtual float | getSelectPriority (const StelCore *core) const |
Return a priority value which is used to discriminate objects by priority As for magnitudes, the lower is the higher priority. | |
virtual QString | getInfoString (const StelCore *core, const InfoStringGroup &flags) const |
Get an HTML string to describe the object. More... | |
virtual QVariantMap | getInfoMap (const StelCore *core) const |
Return a map like StelObject::getInfoMap(), but with a few extra tags also available in getMap(), except for designation, RA and DE fields. | |
virtual Vec3f | getInfoColor (void) const |
Get a color used to display info about the object. | |
virtual Vec3d | getJ2000EquatorialPos (const StelCore *core) const |
Get observer-centered equatorial coordinates at equinox J2000. | |
virtual float | getVMagnitude (const StelCore *core) const |
Get the visual magnitude of pulsar. | |
virtual float | getVMagnitudeWithExtinction (const StelCore *core) const |
virtual double | getAngularSize (const StelCore *core) const |
Get the angular size of pulsar. | |
virtual QString | getNameI18n (void) const |
Get the localized name of pulsar. | |
virtual QString | getEnglishName (void) const |
Get the english name of pulsar. | |
QString | getDesignation (void) const |
Get the designation of pulsar. | |
void | update (double deltaTime) |
Public Member Functions inherited from StelObject | |
virtual SphericalRegionP | getRegion () const Q_DECL_OVERRIDE |
Default implementation of the getRegion method. More... | |
virtual Vec3d | getPointInRegion () const Q_DECL_OVERRIDE |
Default implementation of the getPointInRegion method. More... | |
Vec3d | getEquinoxEquatorialPos (const StelCore *core) const |
Get observer-centered equatorial coordinate at the current equinox The frame has its Z axis at the planet's current rotation axis At time 2000-01-01 this frame is almost the same as J2000, but ONLY if the observer is on earth. | |
Vec3d | getEquinoxEquatorialPosApparent (const StelCore *core) const |
Like getEquinoxEquatorialPos(core), but always adds refraction correction to the position. | |
Vec3d | getEquinoxEquatorialPosAuto (const StelCore *core) const |
Like getEquinoxEquatorialPos(core), but adds refraction correction to the position if atmosphere is active. | |
Vec3d | getGalacticPos (const StelCore *core) const |
Get observer-centered galactic coordinates. | |
Vec3d | getSupergalacticPos (const StelCore *core) const |
Get observer-centered supergalactic coordinates. | |
Vec3d | getSiderealPosGeometric (const StelCore *core) const |
Get observer-centered hour angle + declination (at current equinox) It is the geometric position, i.e. More... | |
Vec3d | getSiderealPosApparent (const StelCore *core) const |
Get observer-centered hour angle + declination (at current equinox) It is the apparent position, i.e. More... | |
Vec3d | getAltAzPosGeometric (const StelCore *core) const |
Get observer-centered alt/az position It is the geometric position, i.e. More... | |
Vec3d | getAltAzPosApparent (const StelCore *core) const |
Get observer-centered alt/az position It is the apparent position, i.e. More... | |
Vec3d | getAltAzPosAuto (const StelCore *core) const |
Get observer-centered alt/az position It is the automatic position, i.e. More... | |
float | getParallacticAngle (const StelCore *core) const |
Get parallactic angle, which is the deviation between zenith angle and north angle. [radians]. | |
bool | isAboveHorizon (const StelCore *core) const |
Checking position an object above mathematical horizon for current location. More... | |
bool | isAboveRealHorizon (const StelCore *core) const |
Checking position an object above real horizon for current location. More... | |
virtual Vec4d | getRTSTime (const StelCore *core, const double altitude=0.) const |
Compute time of rise, transit and set for celestial object for current location. More... | |
float | getVMagnitudeWithExtinction (const StelCore *core) const |
Return object's apparent V magnitude as seen from observer including extinction. More... | |
virtual double | getCloseViewFov (const StelCore *) const |
Return the best FOV in degree to use for a close view of the object. | |
virtual double | getSatellitesFov (const StelCore *) const |
Return the best FOV in degree to use for a global view of the object satellite system (if there are satellites) | |
virtual double | getParentSatellitesFov (const StelCore *) const |
virtual float | getAirmass (const StelCore *core) const |
Return airmass value for the object (for atmosphere-dependent calculations) More... | |
Static Public Attributes | |
static const QString | PULSAR_TYPE |
Static Public Attributes inherited from StelObject | |
static const InfoStringGroupFlags | AllInfo |
A pre-defined "all available" set of specifiers for the getInfoString flags argument to getInfoString. More... | |
static const InfoStringGroupFlags | DefaultInfo |
A pre-defined "default" set of specifiers for the getInfoString flags argument to getInfoString It appears useful to propose this set as post-install settings and let users configure more on demand. More... | |
static const InfoStringGroupFlags | ShortInfo = static_cast<InfoStringGroupFlags>(Name|CatalogNumber|Magnitude|RaDecJ2000) |
A pre-defined "shortest useful" set of specifiers for the getInfoString flags argument to getInfoString. | |
Friends | |
class | Pulsars |
Additional Inherited Members | |
Public Types inherited from StelObject | |
enum | InfoStringGroupFlags { None = 0x00000000, Name = 0x00000001, CatalogNumber = 0x00000002, Magnitude = 0x00000004, RaDecJ2000 = 0x00000008, RaDecOfDate = 0x00000010, AltAzi = 0x00000020, Distance = 0x00000040, Elongation = 0x00000080, Size = 0x00000100, Velocity = 0x00000200, ProperMotion = 0x00000400, Extra = 0x00000800, HourAngle = 0x00001000, AbsoluteMagnitude = 0x00002000, GalacticCoord = 0x00004000, SupergalacticCoord = 0x00008000, OtherCoord = 0x00010000, ObjectType = 0x00020000, EclipticCoordJ2000 = 0x00040000, EclipticCoordOfDate = 0x00080000, IAUConstellation = 0x00100000, SiderealTime = 0x00200000, RTSTime = 0x00400000, SolarLunarPosition = 0x00800000, Script = 0x01000000, DebugAid = 0x02000000, NoFont = 0x04000000, PlainText = 0x08000000 } |
Used as named bitfield flags as specifiers to filter results of getInfoString. More... | |
Public Slots inherited from StelObject | |
virtual void | setExtraInfoString (const InfoStringGroup &flags, const QString &str) |
Allow additions to the Info String. More... | |
virtual void | addToExtraInfoString (const StelObject::InfoStringGroup &flags, const QString &str) |
Add str to the extra string. More... | |
QStringList | getExtraInfoStrings (const InfoStringGroup &flags) const |
Retrieve an (unsorted) QStringList of all extra info strings that match flags. More... | |
void | removeExtraInfoStrings (const InfoStringGroup &flags) |
Remove the extraInfoStrings with the given flags. More... | |
Protected Member Functions inherited from StelObject | |
QString | getCommonInfoString (const StelCore *core, const InfoStringGroup &flags) const |
Format the positional info string containing J2000/of date/altaz/hour angle positions and constellation, sidereal time, etc. More... | |
virtual QString | getMagnitudeInfoString (const StelCore *core, const InfoStringGroup &flags, const int decimals=1) const |
Format the magnitude info string for the object. More... | |
QString | getSolarLunarInfoString (const StelCore *core, const InfoStringGroup &flags) const |
Add a section to the InfoString with just horizontal data for the Sun and Moon, when observed from Earth. More... | |
void | postProcessInfoString (QString &str, const InfoStringGroup &flags) const |
Apply post processing on the info string. More... | |
Pulsar::Pulsar | ( | const QVariantMap & | map | ) |
id | The official designation for a pulsar, e.g. "PSR J1919+21" |
|
inlinevirtual |
The ID should be unique for all objects of the same type, but may freely conflict with IDs of other types, so getType() must also be tested.
With this it should be possible to at least identify the same object in a different instance of Stellarium running the same version, but it would even be better if the ID provides some degree of forward-compatibility. For some object types (e.g. planets) this may simply return getEnglishName(), but better candidates may be official designations or at least (stable) internal IDs.
An object may have multiple IDs (different catalog numbers, etc). StelObjectMgr::searchByID() should search through all ID variants, but this method only returns one of them.
Implements StelObject.
|
virtual |
core | A pointer to the core @flags a set of flags with information types to include. |
Implements StelObject.
QVariantMap Pulsar::getMap | ( | void | ) | const |
Could be used to create a duplicate.
class Pulsars |
Main class of the Pulsars plugin.
Public Types | |
enum | UpdateState { Updating, CompleteNoUpdates, CompleteUpdates, DownloadError, OtherError } |
Public Types inherited from StelModule | |
enum | StelModuleSelectAction { AddToSelection, ReplaceSelection, RemoveFromSelection } |
Enum used when selecting objects to define whether to add to, replace, or remove from the existing selection list. More... | |
enum | StelModuleActionName { ActionDraw, ActionUpdate, ActionHandleMouseClicks, ActionHandleMouseMoves, ActionHandleKeys } |
Define the possible action for which an order is defined. More... | |
Public Slots | |
void | setFlagShowPulsarsButton (bool b) |
Define whether the button toggling pulsars should be visible. | |
bool | getFlagShowPulsarsButton (void) |
void | setFlagShowPulsars (bool b) |
Enable/disable display of markers of pulsars. More... | |
bool | getFlagShowPulsars (void) |
Get status to display of markers of pulsars. More... | |
void | setFilteredMode (bool b) |
Enable/disable display filter of pulsars. More... | |
bool | getFilteredMode (void) const |
Get status to usage display filter of pulsars. More... | |
void | setFilterValue (float v) |
Set value for filter. More... | |
float | getFilterValue (void) const |
Get value for filter. More... | |
bool | getDisplayMode (void) const |
Get status to display of distribution of pulsars. More... | |
void | setDisplayMode (bool b) |
Enable/disable display of distribution of pulsars. More... | |
bool | getGlitchFlag (void) const |
Get status for usage of separate color for pulsars with glitches. More... | |
void | setGlitchFlag (bool b) |
Enable/disable the use of a separate color for pulsars with glitches. More... | |
Vec3f | getMarkerColor () const |
Get color for pulsars markers. More... | |
void | setMarkerColor (const Vec3f &c) |
Set color for pulsars markers. More... | |
Vec3f | getGlitchColor () const |
Get marker color for pulsars with glitches. More... | |
void | setGlitchColor (const Vec3f &c) |
Set markers color for pulsars with glitches. More... | |
int | getCountPulsars (void) const |
Get count of pulsars from catalog. More... | |
void | updateJSON (void) |
Download JSON from web recources described in the module section of the module.ini file and update the local JSON file. | |
void | setFontSize (int s) |
Connect this to StelApp font size. | |
Signals | |
void | updateStateChanged (Pulsars::UpdateState state) |
void | jsonUpdateComplete (void) |
emitted after a JSON update has run. | |
void | flagPulsarsVisibilityChanged (bool b) |
void | flagUsingFilterChanged (bool b) |
void | markerColorChanged (Vec3f) |
void | glitchColorChanged (Vec3f) |
Public Member Functions | |
virtual void | init () Q_DECL_OVERRIDE |
Initialize itself. More... | |
virtual void | deinit () Q_DECL_OVERRIDE |
Called before the module will be delete, and before the openGL context is suppressed. More... | |
virtual void | update (double) Q_DECL_OVERRIDE |
Update the module with respect to the time. More... | |
virtual void | draw (StelCore *core) Q_DECL_OVERRIDE |
Execute all the drawing functions for this module. More... | |
virtual void | drawPointer (StelCore *core, StelPainter &painter) |
virtual double | getCallOrder (StelModuleActionName actionName) const Q_DECL_OVERRIDE |
Return the value defining the order of call for the given action For example if stars.callOrder[ActionDraw] == 10 and constellation.callOrder[ActionDraw] == 11, the stars module will be drawn before the constellations. More... | |
virtual QList< StelObjectP > | searchAround (const Vec3d &v, double limitFov, const StelCore *core) const Q_DECL_OVERRIDE |
Used to get a list of objects which are near to some position. More... | |
virtual StelObjectP | searchByNameI18n (const QString &nameI18n) const Q_DECL_OVERRIDE |
Return the matching Pulsar object's pointer if exists or Q_NULLPTR. More... | |
virtual StelObjectP | searchByName (const QString &name) const Q_DECL_OVERRIDE |
Return the matching Pulsar if exists or Q_NULLPTR. More... | |
virtual StelObjectP | searchByID (const QString &id) const Q_DECL_OVERRIDE |
Return the matching Pulsar if exists or Q_NULLPTR. More... | |
virtual QStringList | listMatchingObjects (const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=false) const Q_DECL_OVERRIDE |
Find and return the list of at most maxNbItem objects auto-completing the passed object name. More... | |
virtual QStringList | listAllObjects (bool inEnglish) const Q_DECL_OVERRIDE |
List all StelObjects. More... | |
virtual QString | getName () const Q_DECL_OVERRIDE |
Gets a user-displayable name of the object category. | |
virtual QString | getStelObjectType () const Q_DECL_OVERRIDE |
Returns the name that will be returned by StelObject::getType() for the objects this module manages. | |
PulsarP | getByID (const QString &id) const |
get a Pulsar object by identifier | |
virtual bool | configureGui (bool show=true) Q_DECL_OVERRIDE |
Implement this to tell the main Stellarium GUI that there is a GUI element to configure this plugin. | |
void | restoreDefaults (void) |
Set up the plugin with default values. More... | |
void | readSettingsFromConfig (void) |
Read (or re-read) settings from the main config file. More... | |
void | saveSettingsToConfig (void) |
Save the settings to the main configuration file. | |
bool | getUpdatesEnabled (void) |
get whether or not the plugin will try to update catalog data from the internet More... | |
void | setUpdatesEnabled (bool b) |
set whether or not the plugin will try to update catalog data from the internet More... | |
void | setEnableAtStartup (bool b) |
bool | getEnableAtStartup (void) |
QDateTime | getLastUpdate (void) |
get the date and time the pulsars were updated | |
int | getUpdateFrequencyDays (void) |
get the update frequency in days | |
void | setUpdateFrequencyDays (int days) |
int | getSecondsToUpdate (void) |
get the number of seconds till the next update | |
UpdateState | getUpdateState (void) |
Get the current updateState. | |
const QList< PulsarP > & | getAllPulsars () const |
Get the list of all pulsars. | |
Public Member Functions inherited from StelObjectModule | |
virtual QStringList | listAllObjectsByType (const QString &objType, bool inEnglish) const |
List all StelObjects by type. More... | |
bool | matchObjectName (const QString &objName, const QString &objPrefix, bool useStartOfWords) const |
Auxiliary method of listMatchingObjects() More... | |
Public Member Functions inherited from StelModule | |
virtual QSettings * | getSettings () |
Return module-specific settings. More... | |
virtual QString | getModuleVersion () const |
Get the version of the module, default is stellarium main version. | |
virtual QString | getAuthorName () const |
Get the name of the module author. | |
virtual QString | getAuthorEmail () const |
Get the email adress of the module author. | |
virtual void | handleMouseClicks (class QMouseEvent *) |
Handle mouse clicks. More... | |
virtual void | handleMouseWheel (class QWheelEvent *) |
Handle mouse wheel. More... | |
virtual bool | handleMouseMoves (int x, int y, Qt::MouseButtons b) |
Handle mouse moves. More... | |
virtual void | handleKeys (class QKeyEvent *e) |
Handle key events. More... | |
virtual bool | handlePinch (qreal scale, bool started) |
Handle pinch gesture events. More... | |
Properties | |
bool | pulsarsVisible |
Vec3f | markerColor |
Vec3f | glitchColor |
Additional Inherited Members | |
Protected Member Functions inherited from StelModule | |
class StelAction * | addAction (const QString &id, const QString &groupId, const QString &text, QObject *target, const char *slot, const QString &shortcut="", const QString &altShortcut="") |
convenience methods to add an action (call to slot) to the StelActionMgr object. More... | |
class StelAction * | addAction (const QString &id, const QString &groupId, const QString &text, const char *slot, const QString &shortcut="", const QString &altShortcut="") |
convenience methods to add an action (call to own slot) to the StelActionMgr object. More... | |
StelAction * | addAction (const QString &id, const QString &groupId, const QString &text, QObject *contextObject, std::function< void()> lambda, const QString &shortcut="", const QString &altShortcut="") |
convenience methods to add an action (call to Lambda functor) to the StelActionMgr object. More... | |
enum Pulsars::UpdateState |
|
virtual |
Deinitialize all openGL texture in this method.
Reimplemented from StelModule.
|
virtual |
core | the core to use for the drawing |
Reimplemented from StelModule.
|
virtual |
actionName | the name of the action for which we want the call order |
Reimplemented from StelModule.
|
inlineslot |
|
slot |
|
slot |
|
slot |
|
inlineslot |
|
slot |
mtype | set false if you want get color of pulsars with glitches |
|
slot |
|
slot |
mtype | set false if you want get color of pulsars with glitches |
|
inline |
|
virtual |
If the initialization takes significant time, the progress should be displayed on the loading bar.
Implements StelModule.
|
virtual |
inEnglish | list names in English (true) or translated (false) |
Implements StelObjectModule.
|
virtual |
objPrefix | the case insensitive first letters of the searched object |
maxNbItem | the maximum number of returned object names |
useStartOfWords | the autofill mode for returned objects names |
Reimplemented from StelObjectModule.
void Pulsars::readSettingsFromConfig | ( | void | ) |
This will be called from init and also when restoring defaults (i.e. from the configuration dialog / restore defaults button).
void Pulsars::restoreDefaults | ( | void | ) |
This means clearing out the Pulsars section in the main config.ini (if one already exists), and populating it with default values. It also creates the default pulsars.json file from the resource embedded in the plugin lib/dll file.
|
virtual |
v | a vector representing the position in th sky around which to search for pulsars. |
limitFov | the field of view around the position v in which to search for pulsars. |
core | the StelCore to use for computations. |
Implements StelObjectModule.
|
inlinevirtual |
id | The Pulsar id |
Implements StelObjectModule.
|
virtual |
name | The case in-sensitive english Pulsar name |
Implements StelObjectModule.
|
virtual |
nameI18n | The case in-sensitive localized Pulsar name |
Implements StelObjectModule.
|
slot |
b |
|
slot |
b | boolean flag |
|
slot |
v | float value |
|
slot |
b | boolean flag |
|
slot |
c | color // example of usage in scripts
|
|
slot |
boolean | flag |
|
slot |
c | color |
mtype | set false if you want set color for pulsars with glitches // example of usage in scripts
|
|
inline |
b | if true, updates will be enabled, else they will be disabled |
|
inlinevirtual |
deltaTime | the time increment in second since last call. |
Implements StelModule.
|
signal |
state | the new update state. |