Kstars
guide.h
43 * @short Performs calibration and autoguiding using an ST4 port or directly via the INDI driver. Can be used with the following external guiding applications:
79 * Ekos::Guide interface provides advanced scripting capabilities to calibrate and guide a mount via a CCD camera.
106 * @brief connectGuider Establish connection to guider application. For internal guider, this always returns true.
112 * @brief disconnectGuider Disconnect from guider application. For internal guider, this always returns true.
137 * Set calibration Use Two Axis option. The options must be set before starting the calibration operation. If no options are set, the options loaded from the user configuration are used.
138 * @param enable if true, calibration will be performed in both RA and DEC axis. Otherwise, only RA axis will be calibrated.
143 * Set auto star calibration option. The options must be set before starting the calibration operation. If no options are set, the options loaded from the user configuration are used.
144 * @param enable if true, Ekos will attempt to automatically select the best guide star and proceed with the calibration procedure.
149 * In case of automatic star selection, calculate the appropriate square size given the selected star width. The options must be set before starting the calibration operation. If no options are set, the options loaded from the user configuration are used.
150 * @param enable if true, Ekos will attempt to automatically select the best square size for calibration and guiding phases.
155 * Set calibration dark frame option. The options must be set before starting the calibration operation. If no options are set, the options loaded from the user configuration are used.
167 * Set guiding box size. The options must be set before starting the guiding operation. If no options are set, the options loaded from the user configuration are used.
168 * @param index box size index (0 to 4) for box size from 8 to 128 pixels. The box size should be suitable for the size of the guide star selected. The boxSize is also used to select the subframe size around the guide star. Default is 16 pixels
173 * Set guiding algorithm. The options must be set before starting the guiding operation. If no options are set, the options loaded from the user configuration are used.
174 * @param index Select the algorithm used to calculate the centroid of the guide star (0 --> Smart, 1 --> Fast, 2 --> Auto, 3 --> No thresh).
180 * @param enable if true, dithering is enabled and is performed after each exposure is complete. Otherwise, dithering is disabled.
181 * @param value dithering range in pixels. Ekos will move the guide star in a random direction for the specified dithering value in pixels.
249 * @return QVector3D of starCenter. The 3rd parameter is used to store current bin settings and in unrelated to the star position.
291 * Clear calibration data. Next time any guide operation is performed, a calibration is first started.
296 * @brief dither Starts dithering process in a random direction restricted by the number of pixels specified in dither options
325 * Set guiding options. The options must be set before starting the guiding operation. If no options are set, the options loaded from the user configuration are used.
326 * @param enable if true, it will select a subframe around the guide star depending on the boxSize size.
332 * @param type Type of guider process to use. 0 for internal guider, 1 for external PHD2, 2 for external lin_guider. Pass -1 to select default guider in options.
338 * @brief axisDelta returns the last immediate axis delta deviation in arcseconds. This is the deviation of locked star position when guiding started.
344 * @brief axisSigma return axis sigma deviation in arcseconds RMS. This is the RMS deviation of locked star position when guiding started.
350 * @brief checkCamera Check all CCD parameters and ensure all variables are updated to reflect the selected CCD
356 * @brief checkExposureValue This function is called by the INDI framework whenever there is a new exposure value. We use it to know if there is a problem with the exposure
376 * @param primaryFocalLength Primary Telescope Focal Length. Set to 0 to skip setting this value.
381 void setTelescopeInfo(double primaryFocalLength, double primaryAperture, double guideFocalLength, double guideAperture);
408 bool sendMultiPulse(GuideDirection ra_dir, int ra_msecs, GuideDirection dec_dir, int dec_msecs);
412 * @brief setDECSwap Change ST4 declination pulse direction. +DEC pulses increase DEC if swap is OFF. When on +DEC pulses result in decreasing DEC.
436 * @brief processCCDNumber Process number properties arriving from CCD. Currently, binning changes are processed.
463 void calibrationUpdate(GuideInterface::CalibrationUpdateType type, const QString &message = QString(""), double dx = 0,
506 * @brief updateGuideParams Update the guider and frame parameters due to any changes in the mount and/or ccd frame
532 * @brief setBLOBEnabled Enable or disable BLOB reception from current CCD if using external guider
685 // Reset non guided dithering properties and initialize the random generator seed if not already done.
Q_OBJECTQ_OBJECT
Q_PROPERTY(...)
void processData(const QSharedPointer< FITSData > &data)
newFITS is called by the INDI framework whenever there is a new BLOB arriving
Definition: guide.cpp:1126
Q_SCRIPTABLE Q_NOREPLY void setGuideAlgorithmIndex(int index)
DBUS interface function.
Definition: guide.cpp:1635
Q_SCRIPTABLE Q_NOREPLY void setDarkFrameEnabled(bool enable)
DBUS interface function.
Definition: guide.cpp:1890
Ekos is an advanced Astrophotography tool for Linux. It is based on a modular extensible framework to...
Definition: align.cpp:70
Stores dms coordinates for a point in the sky. for converting between coordinate systems.
Definition: skypoint.h:44
Q_CLASSINFO(Name, Value)
virtual bool event(QEvent *event) override
Definition: indicamerachip.h:22
void checkCamera(int ccdNum=-1)
checkCamera Check all CCD parameters and ensure all variables are updated to reflect the selected CCD
Definition: guide.cpp:501
void setTrackingStar(int x, int y)
setTrackingStar Gets called when the user select a star in the guide frame
Definition: guide.cpp:2367
The QProgressIndicator class lets an application display a progress indicator to show that a long tas...
Definition: QProgressIndicator.h:23
void processCCDNumber(INumberVectorProperty *nvp)
processCCDNumber Process number properties arriving from CCD.
Definition: guide.cpp:1831
Q_SCRIPTABLE Q_NOREPLY void setCalibrationAutoStar(bool enable)
DBUS interface function.
Definition: guide.cpp:1615
void checkExposureValue(ISD::CameraChip *targetChip, double exposure, IPState expState)
checkExposureValue This function is called by the INDI framework whenever there is a new exposure val...
Definition: guide.cpp:1854
Definition: indimount.h:26
Performs calibration and autoguiding using an ST4 port or directly via the INDI driver....
Definition: guide.h:50
Primary window to view monochrome and color FITS images. The FITSviewer can open multiple images each...
Definition: fitsviewer.h:48
Q_SCRIPTABLE Q_NOREPLY void setDitherSettings(bool enable, double value)
DBUS interface function.
Definition: guide.cpp:1650
Definition: indicamera.h:47
bool addAdaptiveOptics(ISD::AdaptiveOptics *device)
Add new Adaptive Optics.
Definition: guide.cpp:821
QString join(const QString &separator) const const
Q_SCRIPTABLE Q_NOREPLY void setCalibrationPulseDuration(int pulseDuration)
DBUS interface function.
Definition: guide.cpp:1625
Q_SCRIPTABLE Q_NOREPLY void setCalibrationAutoSquareSize(bool enable)
DBUS interface function.
Definition: guide.cpp:1620
void setDECSwap(bool enable)
setDECSwap Change ST4 declination pulse direction.
Definition: guide.cpp:1282
Q_SCRIPTABLE Q_NOREPLY void setExposure(double value)
DBUS interface function.
Definition: guide.cpp:1605
Definition: indiadaptiveoptics.h:19
Definition: indistd.h:115
The main change relative to fitsview is to add the capability of displaying the 'neighbor guide stars...
Definition: guideview.h:21
Q_SCRIPTABLE Q_NOREPLY void setCalibrationTwoAxis(bool enable)
DBUS interface function.
Definition: guide.cpp:1610
void setTelescopeInfo(double primaryFocalLength, double primaryAperture, double guideFocalLength, double guideAperture)
Set telescope and guide scope info.
Definition: guide.cpp:606
Q_SCRIPTABLE Q_NOREPLY void setGuideBoxSizeIndex(int index)
DBUS interface function.
Definition: guide.cpp:1630
QString message
QVector3D getStarPosition()
getStarPosition Return star center as selected by the user or auto-detected by KStars
Definition: guide.h:251
Q_SCRIPTABLE Q_NOREPLY void setSubFrameEnabled(bool enable)
DBUS interface function.
Definition: guide.cpp:1640
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Fri Aug 12 2022 04:00:54 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2022 The KDE developers.
Generated on Fri Aug 12 2022 04:00:54 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.