Ekos::Guide

#include <guide.h>

Inheritance diagram for Ekos::Guide:

[legend]

Public Types
enum	GuiderStage { CALIBRATION_STAGE , GUIDE_STAGE }

enum	GuiderType { GUIDE_INTERNAL , GUIDE_PHD2 , GUIDE_LINGUIDER }

Public Types inherited from QWidget
enum	RenderFlag

typedef	RenderFlags

Public Types inherited from QObject
typedef	QObjectList

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric

Properties
QList< double >	axisDelta

QList< double >	axisSigma

QString	camera

double	exposure

QString	guider

QStringList	logText

QString	opticalTrain

Ekos::GuideState	status

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	tabletTracking

	toolTip

	toolTipDuration

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Signals
void	driverTimedout (const QString &deviceName)

void	guideChipUpdated (ISD::CameraChip *)

void	guideStats (double raError, double decError, int raPulse, int decPulse, double snr, double skyBg, int numStars)

void	newAxisDelta (double ra, double de)

void	newAxisSigma (double ra, double de)

void	newImage (const QSharedPointer< FITSView > &view)

void	newLog (const QString &text)

void	newStarPixmap (QPixmap &)

void	newStatus (Ekos::GuideState status)

void	settingsUpdated (const QVariantMap &settings)

void	trainChanged ()

Public Slots
Q_SCRIPTABLE bool	abort ()

void	abortExposure ()

void	appendLogText (const QString &)

Q_SCRIPTABLE QList< double >	axisDelta ()

Q_SCRIPTABLE QList< double >	axisSigma ()

void	buildTarget ()

Q_SCRIPTABLE bool	calibrate ()

Q_SCRIPTABLE bool	capture ()

void	checkCamera ()

void	checkExposureValue (ISD::CameraChip *targetChip, double exposure, IPState expState)

Q_SCRIPTABLE Q_NOREPLY void	clearCalibration ()

void	clearCalibrationGraphs ()

void	clearGuideGraphs ()

Q_SCRIPTABLE bool	dither ()

Q_SCRIPTABLE bool	guide ()

void	guideAfterMeridianFlip ()

void	guideHistory ()

void	handleHorizontalPlotSizeChange ()

void	handleVerticalPlotSizeChange ()

Q_SCRIPTABLE Q_NOREPLY void	loop ()

QString	opticalTrain () const

void	processData (const QSharedPointer< FITSData > &data)

void	resetNonGuidedDither ()

Q_SCRIPTABLE bool	resume ()

bool	sendMultiPulse (GuideDirection ra_dir, int ra_msecs, GuideDirection dec_dir, int dec_msecs, CaptureAfterPulses followWithCapture)

bool	sendSinglePulse (GuideDirection dir, int msecs, CaptureAfterPulses followWithCapture)

Q_SCRIPTABLE Q_NOREPLY void	setAutoStarEnabled (bool enable)

void	setCaptureComplete ()

void	setCaptureStatus (Ekos::CaptureState newState)

void	setDECSwap (bool enable)

Q_SCRIPTABLE bool	setGuiderType (int type)

void	setLatestGuidePoint (bool isChecked)

void	setMountCoords (const SkyPoint &position, ISD::Mount::PierSide pierSide, const dms &ha)

void	setMountStatus (ISD::Mount::Status newState)

void	setOpticalTrain (const QString &value)

void	setPierSide (ISD::Mount::PierSide newSide)

QString	setRecommendedExposureValues (QList< double > values)

void	setStarPosition (const QVector3D &newCenter, bool updateNow)

void	setStatus (Ekos::GuideState newState)

Q_SCRIPTABLE Q_NOREPLY void	setSubFrameEnabled (bool enable)

void	slotAutoScaleGraphs ()

Q_SCRIPTABLE bool	suspend ()

void	updateDirectionsFromPHD2 (const QString &mode)

void	updateSetting (const QString &key, const QVariant &value)

Public Member Functions
Q_SCRIPTABLE QString	camera ()

Q_SCRIPTABLE void	clearLog ()

void	configurePHD2Camera ()

Q_SCRIPTABLE bool	connectGuider ()

Q_SCRIPTABLE bool	disconnectGuider ()

double	exposure ()

QVariantMap	getAllSettings () const

GuideInterface *	getGuiderInstance ()

QString	getLogText ()

QVector3D	getStarPosition ()

int	getTrackingBoxSize ()

Q_SCRIPTABLE QString	guider ()

bool	isDithering ()

QStringList	logText ()

void	removeDevice (const QSharedPointer< ISD::GenericDevice > &device)

bool	setAdaptiveOptics (ISD::AdaptiveOptics *device)

void	setAllSettings (const QVariantMap &settings)

bool	setCamera (ISD::Camera *device)

Q_SCRIPTABLE Q_NOREPLY void	setDarkFrameEnabled (bool enable)

Q_SCRIPTABLE Q_NOREPLY void	setExposure (double value)

bool	setGuider (ISD::Guider *device)

bool	setMount (ISD::Mount *device)

Q_SCRIPTABLE Ekos::GuideState	status ()

void	syncCameraInfo ()

void	syncTelescopeInfo ()

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, Qt::WindowFlags f)

bool	acceptDrops () const const

QString	accessibleDescription () const const

QString	accessibleName () const const

QList< QAction * >	actions () const const

void	activateWindow ()

QAction *	addAction (const QIcon &icon, const QString &text)

QAction *	addAction (const QIcon &icon, const QString &text, Args &&... args)

QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut)

QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, Args &&... args)

QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, const QObject receiver, const char member, Qt::ConnectionType type)

QAction *	addAction (const QIcon &icon, const QString &text, const QObject receiver, const char member, Qt::ConnectionType type)

QAction *	addAction (const QString &text)

QAction *	addAction (const QString &text, Args &&... args)

QAction *	addAction (const QString &text, const QKeySequence &shortcut)

QAction *	addAction (const QString &text, const QKeySequence &shortcut, Args &&... args)

QAction *	addAction (const QString &text, const QKeySequence &shortcut, const QObject receiver, const char member, Qt::ConnectionType type)

QAction *	addAction (const QString &text, const QObject receiver, const char member, Qt::ConnectionType type)

void	addAction (QAction *action)

void	addActions (const QList< QAction * > &actions)

void	adjustSize ()

bool	autoFillBackground () const const

QPalette::ColorRole	backgroundRole () const const

QBackingStore *	backingStore () const const

QSize	baseSize () const const

QWidget *	childAt (const QPoint &p) const const

QWidget *	childAt (int x, int y) const const

QRect	childrenRect () const const

QRegion	childrenRegion () const const

void	clearFocus ()

void	clearMask ()

bool	close ()

QMargins	contentsMargins () const const

QRect	contentsRect () const const

Qt::ContextMenuPolicy	contextMenuPolicy () const const

QCursor	cursor () const const

void	customContextMenuRequested (const QPoint &pos)

WId	effectiveWinId () const const

void	ensurePolished () const const

Qt::FocusPolicy	focusPolicy () const const

QWidget *	focusProxy () const const

QWidget *	focusWidget () const const

const QFont &	font () const const

QFontInfo	fontInfo () const const

QFontMetrics	fontMetrics () const const

QPalette::ColorRole	foregroundRole () const const

QRect	frameGeometry () const const

QSize	frameSize () const const

const QRect &	geometry () const const

QPixmap	grab (const QRect &rectangle)

void	grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const const

QGraphicsProxyWidget *	graphicsProxyWidget () const const

bool	hasEditFocus () const const

bool	hasFocus () const const

virtual bool	hasHeightForWidth () const const

bool	hasMouseTracking () const const

bool	hasTabletTracking () const const

int	height () const const

virtual int	heightForWidth (int w) const const

void	hide ()

Qt::InputMethodHints	inputMethodHints () const const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, const QList< QAction > &actions)

bool	isActiveWindow () const const

bool	isAncestorOf (const QWidget *child) const const

bool	isEnabled () const const

bool	isEnabledTo (const QWidget *ancestor) const const

bool	isFullScreen () const const

bool	isHidden () const const

bool	isMaximized () const const

bool	isMinimized () const const

bool	isModal () const const

bool	isTopLevel () const const

bool	isVisible () const const

bool	isVisibleTo (const QWidget *ancestor) const const

bool	isWindow () const const

bool	isWindowModified () const const

QLayout *	layout () const const

Qt::LayoutDirection	layoutDirection () const const

QLocale	locale () const const

void	lower ()

QPoint	mapFrom (const QWidget *parent, const QPoint &pos) const const

QPointF	mapFrom (const QWidget *parent, const QPointF &pos) const const

QPoint	mapFromGlobal (const QPoint &pos) const const

QPointF	mapFromGlobal (const QPointF &pos) const const

QPoint	mapFromParent (const QPoint &pos) const const

QPointF	mapFromParent (const QPointF &pos) const const

QPoint	mapTo (const QWidget *parent, const QPoint &pos) const const

QPointF	mapTo (const QWidget *parent, const QPointF &pos) const const

QPoint	mapToGlobal (const QPoint &pos) const const

QPointF	mapToGlobal (const QPointF &pos) const const

QPoint	mapToParent (const QPoint &pos) const const

QPointF	mapToParent (const QPointF &pos) const const

QRegion	mask () const const

int	maximumHeight () const const

QSize	maximumSize () const const

int	maximumWidth () const const

int	minimumHeight () const const

QSize	minimumSize () const const

virtual QSize	minimumSizeHint () const const

int	minimumWidth () const const

void	move (const QPoint &)

void	move (int x, int y)

QWidget *	nativeParentWidget () const const

QWidget *	nextInFocusChain () const const

QRect	normalGeometry () const const

void	overrideWindowFlags (Qt::WindowFlags flags)

virtual QPaintEngine *	paintEngine () const const override

const QPalette &	palette () const const

QWidget *	parentWidget () const const

QPoint	pos () const const

QWidget *	previousInFocusChain () const const

	QWIDGETSIZE_MAX QWIDGETSIZE_MAX

void	raise ()

QRect	rect () const const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, RenderFlags renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, RenderFlags renderFlags)

void	repaint ()

void	repaint (const QRect &rect)

void	repaint (const QRegion &rgn)

void	repaint (int x, int y, int w, int h)

void	resize (const QSize &)

void	resize (int w, int h)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const const

QScreen *	screen () const const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setContentsMargins (const QMargins &margins)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus ()

void	setFocus (Qt::FocusReason reason)

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (const QRect &)

void	setGeometry (int x, int y, int w, int h)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setInputMethodHints (Qt::InputMethodHints hints)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (const QSize &)

void	setMinimumSize (int minw, int minh)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, Qt::WindowFlags f)

void	setScreen (QScreen *screen)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

void	setStyleSheet (const QString &styleSheet)

void	setTabletTracking (bool enable)

void	setToolTip (const QString &)

void	setToolTipDuration (int msec)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

virtual void	setVisible (bool visible)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlag (Qt::WindowType flag, bool on)

void	setWindowFlags (Qt::WindowFlags type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (Qt::WindowStates windowState)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const const

virtual QSize	sizeHint () const const

QSize	sizeIncrement () const const

QSizePolicy	sizePolicy () const const

void	stackUnder (QWidget *w)

QString	statusTip () const const

QStyle *	style () const const

QString	styleSheet () const const

bool	testAttribute (Qt::WidgetAttribute attribute) const const

QString	toolTip () const const

int	toolTipDuration () const const

QWidget *	topLevelWidget () const const

bool	underMouse () const const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	update ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	updateGeometry ()

bool	updatesEnabled () const const

QRegion	visibleRegion () const const

QString	whatsThis () const const

int	width () const const

QWidget *	window () const const

QString	windowFilePath () const const

Qt::WindowFlags	windowFlags () const const

QWindow *	windowHandle () const const

QIcon	windowIcon () const const

void	windowIconChanged (const QIcon &icon)

QString	windowIconText () const const

void	windowIconTextChanged (const QString &iconText)

Qt::WindowModality	windowModality () const const

qreal	windowOpacity () const const

QString	windowRole () const const

Qt::WindowStates	windowState () const const

QString	windowTitle () const const

void	windowTitleChanged (const QString &title)

Qt::WindowType	windowType () const const

WId	winId () const const

int	x () const const

int	y () const const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Public Member Functions inherited from QPaintDevice
int	colorCount () const const

int	depth () const const

qreal	devicePixelRatio () const const

qreal	devicePixelRatioF () const const

int	height () const const

int	heightMM () const const

int	logicalDpiX () const const

int	logicalDpiY () const const

bool	paintingActive () const const

int	physicalDpiX () const const

int	physicalDpiY () const const

int	width () const const

int	widthMM () const const

Protected Slots
void	calibrationUpdate (GuideInterface::CalibrationUpdateType type, const QString &message=QString(""), double dx=0, double dy=0)

void	configSEPMultistarOptions ()

void	guideInfo (const QString &info)

void	nonGuidedDither ()

void	onControlDirectionChanged ()

void	onEnableDirDEC ()

void	onEnableDirRA ()

void	onThresholdChanged (int i)

void	processCaptureTimeout ()

void	processGuideOptions ()

void	saveDefaultGuideExposure ()

void	setAxisDelta (double ra, double de)

void	setAxisPulse (double ra, double de)

void	setAxisSigma (double ra, double de)

void	setSNR (double snr)

void	setTrackingStar (int x, int y)

void	showFITSViewer ()

void	updateCCDBin (int index)

void	updateProperty (INDI::Property prop)

void	updateTrackingBoxSize (int currentIndex)

Additional Inherited Members
Static Public Member Functions inherited from QWidget
QWidget *	createWindowContainer (QWindow window, QWidget parent, Qt::WindowFlags flags)

QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

void	setTabOrder (std::initializer_list< QWidget * > widgets)

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QWidget
	DrawChildren

	DrawWindowBackground

	IgnoreMask

Public Attributes inherited from QPaintDevice
	PdmDepth

	PdmDevicePixelRatio

	PdmDevicePixelRatioScaled

	PdmDpiX

	PdmDpiY

	PdmHeight

	PdmHeightMM

	PdmNumColors

	PdmPhysicalDpiX

	PdmPhysicalDpiY

	PdmWidth

	PdmWidthMM

Protected Member Functions inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

virtual void	changeEvent (QEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	enterEvent (QEnterEvent *event)

virtual bool	event (QEvent *event) override

virtual void	focusInEvent (QFocusEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	initPainter (QPainter *painter) const const override

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	leaveEvent (QEvent *event)

virtual int	metric (PaintDeviceMetric m) const const override

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual bool	nativeEvent (const QByteArray &eventType, void message, qintptr result)

virtual void	paintEvent (QPaintEvent *event)

virtual void	showEvent (QShowEvent *event)

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus (Qt::InputMethodQuery query)

virtual void	wheelEvent (QWheelEvent *event)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Protected Member Functions inherited from QPaintDevice

Detailed Description

Performs calibration and autoguiding using an ST4 port or directly via the INDI driver.

Can be used with the following external guiding applications: PHD2 LinGuider

Author: Jasem Mutlaq

Version: 1.4

Definition at line 50 of file guide.h.

Member Enumeration Documentation

◆ GuiderStage

enum Ekos::Guide::GuiderStage

Definition at line 67 of file guide.h.

◆ GuiderType

enum Ekos::Guide::GuiderType

Definition at line 72 of file guide.h.

Property Documentation

◆ axisDelta

QList< double > Guide::axisDelta

read

Definition at line 60 of file guide.h.

◆ axisSigma

QList< double > Guide::axisSigma

read

Definition at line 61 of file guide.h.

◆ camera

QString Guide::camera

read

Definition at line 57 of file guide.h.

◆ exposure

double Ekos::Guide::exposure

readwrite

Definition at line 59 of file guide.h.

◆ guider

QString Guide::guider

read

Definition at line 58 of file guide.h.

◆ logText

QStringList Ekos::Guide::logText

read

Definition at line 55 of file guide.h.

◆ opticalTrain

QString Ekos::Guide::opticalTrain

readwrite

Definition at line 56 of file guide.h.

◆ status

Ekos::GuideState Ekos::Guide::status

read

Definition at line 54 of file guide.h.

Constructor & Destructor Documentation

◆ Guide()

Guide::Guide ( )

Definition at line 50 of file guide.cpp.

◆ ~Guide()

Guide::~Guide ( )

Definition at line 207 of file guide.cpp.

Member Function Documentation

◆ abort

bool Guide::abort ( )

slot

DBUS interface function.

Stop any active calibration, guiding, or dithering operation

Returns: Returns true if operation is stopped successfully, false otherwise.

Definition at line 889 of file guide.cpp.

◆ abortExposure

void Guide::abortExposure ( )

slot

Definition at line 873 of file guide.cpp.

◆ appendLogText

void Guide::appendLogText ( const QString & text )

slot

Definition at line 1219 of file guide.cpp.

◆ axisDelta

Q_SCRIPTABLE QList< double > Ekos::Guide::axisDelta ( )

slot

DBUS interface function.

axisDelta returns the last immediate axis delta deviation in arcseconds. This is the deviation of locked star position when guiding started.

Returns: List of doubles. First member is RA deviation. Second member is DE deviation.

◆ axisSigma

Q_SCRIPTABLE QList< double > Ekos::Guide::axisSigma ( )

slot

DBUS interface function.

axisSigma return axis sigma deviation in arcseconds RMS. This is the RMS deviation of locked star position when guiding started.

Returns: List of doubles. First member is RA deviation. Second member is DE deviation.

◆ buildTarget

void Guide::buildTarget ( )

slot

Definition at line 258 of file guide.cpp.

◆ calibrate

bool Guide::calibrate ( )

slot

DBUS interface function.

Start the calibration operation. Note that this will not start guiding automatically.

Returns: Returns true if calibration started successfully, false otherwise.

Definition at line 1283 of file guide.cpp.

◆ calibrationUpdate

void Guide::calibrationUpdate	(	GuideInterface::CalibrationUpdateType	type,
		const QString &	message = QString(""),
		double	dx = 0,
		double	dy = 0 )

protectedslot

Definition at line 2199 of file guide.cpp.

◆ camera()

Q_SCRIPTABLE QString Ekos::Guide::camera ( )

DBUS interface function.

select the CCD device from the available CCD drivers.

Parameters

device The CCD device name

Returns: Returns true if CCD device is found and set, false otherwise.

◆ capture

bool Guide::capture ( )

slot

DBUS interface function.

Capture a guide frame

Returns: Returns true if capture command is sent successfully to INDI server.

Definition at line 769 of file guide.cpp.

◆ checkCamera

void Guide::checkCamera ( )

slot

checkCamera Check all CCD parameters and ensure all variables are updated to reflect the selected CCD

Parameters

ccdNum CCD index number in the CCD selection combo box

Definition at line 461 of file guide.cpp.

◆ checkExposureValue

void Guide::checkExposureValue	(	ISD::CameraChip *	targetChip,
		double	exposure,
		IPState	expState )

slot

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

Parameters

targetChip	Chip for which the exposure is undergoing
exposure	numbers of seconds left in the exposure
expState	State of the exposure property

Definition at line 1764 of file guide.cpp.

◆ clearCalibration

void Guide::clearCalibration ( )

slot

DBUS interface function.

Clear calibration data. Next time any guide operation is performed, a calibration is first started.

Definition at line 1567 of file guide.cpp.

◆ clearCalibrationGraphs

void Guide::clearCalibrationGraphs ( )

slot

Definition at line 269 of file guide.cpp.

◆ clearGuideGraphs

void Guide::clearGuideGraphs ( )

slot

Definition at line 263 of file guide.cpp.

◆ clearLog()

void Guide::clearLog ( )

clearLog As the name suggests

Definition at line 1229 of file guide.cpp.

◆ configSEPMultistarOptions

void Guide::configSEPMultistarOptions ( )

protectedslot

Definition at line 1781 of file guide.cpp.

◆ configurePHD2Camera()

void Guide::configurePHD2Camera ( )

Definition at line 363 of file guide.cpp.

◆ connectGuider()

bool Guide::connectGuider ( )

DBUS interface function.

connectGuider Establish connection to guider application. For internal guider, this always returns true.

Returns: True if successfully connected, false otherwise.

Definition at line 2712 of file guide.cpp.

◆ disconnectGuider()

bool Guide::disconnectGuider ( )

DBUS interface function.

disconnectGuider Disconnect from guider application. For internal guider, this always returns true.

Returns: True if successfully disconnected, false otherwise.

Definition at line 2718 of file guide.cpp.

◆ dither

bool Guide::dither ( )

slot

DBUS interface function.

dither Starts dithering process in a random direction restricted by the number of pixels specified in dither options

Returns: True if dither started successfully, false otherwise.

Definition at line 1383 of file guide.cpp.

◆ exposure()

double Ekos::Guide::exposure ( )

inline

Definition at line 125 of file guide.h.

◆ getAllSettings()

QVariantMap Ekos::Guide::getAllSettings ( ) const

Definition at line 3050 of file guide.cpp.

◆ getGuiderInstance()

GuideInterface * Ekos::Guide::getGuiderInstance ( )

inline

Definition at line 206 of file guide.h.

◆ getLogText()

QString Ekos::Guide::getLogText ( )

inline

Returns: Return current log text of guide module

Definition at line 186 of file guide.h.

◆ getStarPosition()

QVector3D Ekos::Guide::getStarPosition ( )

inline

getStarPosition Return star center as selected by the user or auto-detected by KStars

Returns: QVector3D of starCenter. The 3rd parameter is used to store current bin settings and in unrelated to the star position.

Definition at line 195 of file guide.h.

◆ getTrackingBoxSize()

int Ekos::Guide::getTrackingBoxSize ( )

inline

Definition at line 201 of file guide.h.

◆ guide

bool Guide::guide ( )

slot

DBUS interface function.

Start the autoguiding operation.

Returns: Returns true if guiding started successfully, false otherwise.

Definition at line 1329 of file guide.cpp.

◆ guideAfterMeridianFlip

void Guide::guideAfterMeridianFlip ( )

slot

Definition at line 226 of file guide.cpp.

◆ guideHistory

void Guide::guideHistory ( )

slot

Definition at line 292 of file guide.cpp.

◆ guideInfo

void Guide::guideInfo ( const QString & info )

protectedslot

Definition at line 2063 of file guide.cpp.

◆ guider()

Q_SCRIPTABLE QString Ekos::Guide::guider ( )

DBUS interface function.

select the ST4 device from the available ST4 drivers.

Parameters

device The ST4 device name

Returns: Returns true if ST4 device is found and set, false otherwise.

◆ handleHorizontalPlotSizeChange

void Guide::handleHorizontalPlotSizeChange ( )

slot

Definition at line 212 of file guide.cpp.

◆ handleVerticalPlotSizeChange

void Guide::handleVerticalPlotSizeChange ( )

slot

Definition at line 219 of file guide.cpp.

◆ logText()

QStringList Ekos::Guide::logText ( )

inline

Definition at line 178 of file guide.h.

◆ loop

void Guide::loop ( )

slot

DBUS interface function.

Loop frames specified by the exposure control continuously until stopped.

Definition at line 3023 of file guide.cpp.

◆ nonGuidedDither

void Guide::nonGuidedDither ( )

protectedslot

Definition at line 2624 of file guide.cpp.

◆ onControlDirectionChanged

void Guide::onControlDirectionChanged ( )

protectedslot

Definition at line 2113 of file guide.cpp.

◆ onEnableDirDEC

void Guide::onEnableDirDEC ( )

protectedslot

Definition at line 2108 of file guide.cpp.

◆ onEnableDirRA

void Guide::onEnableDirRA ( )

protectedslot

Definition at line 2101 of file guide.cpp.

◆ onThresholdChanged

void Guide::onThresholdChanged ( int i )

protectedslot

Definition at line 2088 of file guide.cpp.

◆ opticalTrain

QString Ekos::Guide::opticalTrain ( ) const

inlineslot

Definition at line 389 of file guide.h.

◆ processCaptureTimeout

void Guide::processCaptureTimeout ( )

protectedslot

Definition at line 981 of file guide.cpp.

◆ processData

void Guide::processData ( const QSharedPointer< FITSData > & data )

slot

newFITS is called by the INDI framework whenever there is a new BLOB arriving

Definition at line 1074 of file guide.cpp.

◆ processGuideOptions

void Guide::processGuideOptions ( )

protectedslot

Definition at line 2553 of file guide.cpp.

◆ removeDevice()

void Guide::removeDevice ( const QSharedPointer< ISD::GenericDevice > & device )

Definition at line 2985 of file guide.cpp.

◆ resetNonGuidedDither

void Guide::resetNonGuidedDither ( )

slot

Reset non guided dithering properties and initialize the random generator seed if not already done.

Should be called in Guide::Guide() for initial seed initialization, and then every time to reset accumulated drift every time a capture task is completed or aborted.

Definition at line 2607 of file guide.cpp.

◆ resume

bool Guide::resume ( )

slot

DBUS interface function.

resume Resume autoguiding

Returns: True if successful, false otherwise.

Definition at line 1429 of file guide.cpp.

◆ saveDefaultGuideExposure

void Guide::saveDefaultGuideExposure ( )

protectedslot

Definition at line 1812 of file guide.cpp.

◆ sendMultiPulse

bool Guide::sendMultiPulse	(	GuideDirection	ra_dir,
		int	ra_msecs,
		GuideDirection	dec_dir,
		int	dec_msecs,
		CaptureAfterPulses	followWithCapture )

slot

Definition at line 1247 of file guide.cpp.

◆ sendSinglePulse

bool Guide::sendSinglePulse	(	GuideDirection	dir,
		int	msecs,
		CaptureAfterPulses	followWithCapture )

slot

Definition at line 1265 of file guide.cpp.

◆ setAdaptiveOptics()

bool Guide::setAdaptiveOptics ( ISD::AdaptiveOptics * device )

Add new Adaptive Optics.

Parameters

device pointer to AO device.

Returns: True if added successfully, false if duplicate or failed to add.

Definition at line 748 of file guide.cpp.

◆ setAllSettings()

void Ekos::Guide::setAllSettings ( const QVariantMap & settings )

Definition at line 3076 of file guide.cpp.

◆ setAutoStarEnabled

void Guide::setAutoStarEnabled ( bool enable )

slot

DBUS interface function.

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.

Parameters

enable if true, it will select a subframe around the guide star depending on the boxSize size.

Definition at line 1561 of file guide.cpp.

◆ setAxisDelta

void Guide::setAxisDelta	(	double	ra,
		double	de )

protectedslot

Definition at line 2177 of file guide.cpp.

◆ setAxisPulse

void Guide::setAxisPulse	(	double	ra,
		double	de )

protectedslot

Definition at line 2254 of file guide.cpp.

◆ setAxisSigma

void Guide::setAxisSigma	(	double	ra,
		double	de )

protectedslot

Definition at line 2226 of file guide.cpp.

◆ setCamera()

bool Guide::setCamera ( ISD::Camera * device )

Add new Camera.

Parameters

device pointer to camera device.

Returns: True if added successfully, false if duplicate or failed to add.

Definition at line 319 of file guide.cpp.

◆ setCaptureComplete

void Guide::setCaptureComplete ( )

slot

Definition at line 1142 of file guide.cpp.

◆ setCaptureStatus

void Guide::setCaptureStatus ( Ekos::CaptureState newState )

slot

Definition at line 1439 of file guide.cpp.

◆ setDarkFrameEnabled()

void Guide::setDarkFrameEnabled ( bool enable )

DBUS interface function.

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.

Parameters

enable if true, a dark frame will be captured to subtract from the light frame.

Definition at line 1806 of file guide.cpp.

◆ setDECSwap

void Guide::setDECSwap ( bool enable )

slot

setDECSwap Change ST4 declination pulse direction.

+DEC pulses increase DEC if swap is OFF. When on +DEC pulses result in decreasing DEC.

Parameters

enable True to enable DEC swap. Off to disable it.

Definition at line 1235 of file guide.cpp.

◆ setExposure()

void Guide::setExposure ( double value )

DBUS interface function.

Set CCD exposure value

Parameters

value exposure value in seconds.

Definition at line 1548 of file guide.cpp.

◆ setGuider()

bool Guide::setGuider ( ISD::Guider * device )

Add new Guider.

Parameters

device pointer to Guider device.

Returns: True if added successfully, false if duplicate or failed to add.

Definition at line 722 of file guide.cpp.

◆ setGuiderType

bool Guide::setGuiderType ( int type )

slot

DBUS interface function.

Selects which guiding process to utilize for calibration & guiding.

Parameters

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.

Returns: True if guiding is switched to the new requested type. False otherwise.

Definition at line 1891 of file guide.cpp.

◆ setLatestGuidePoint

void Guide::setLatestGuidePoint ( bool isChecked )

slot

Definition at line 303 of file guide.cpp.

◆ setMount()

bool Guide::setMount ( ISD::Mount * device )

Add new Mount.

Parameters

device pointer to Mount device.

Returns: True if added successfully, false if duplicate or failed to add.

Definition at line 437 of file guide.cpp.

◆ setMountCoords

void Guide::setMountCoords	(	const SkyPoint &	position,
		ISD::Mount::PierSide	pierSide,
		const dms &	ha )

slot

Definition at line 1541 of file guide.cpp.

◆ setMountStatus

void Guide::setMountStatus ( ISD::Mount::Status newState )

slot

Definition at line 1483 of file guide.cpp.

◆ setOpticalTrain

void Ekos::Guide::setOpticalTrain ( const QString & value )

inlineslot

Definition at line 393 of file guide.h.

◆ setPierSide

void Guide::setPierSide ( ISD::Mount::PierSide newSide )

slot

Definition at line 1460 of file guide.cpp.

◆ setRecommendedExposureValues

QString Guide::setRecommendedExposureValues ( QList< double > values )

slot

Definition at line 313 of file guide.cpp.

◆ setSNR

void Guide::setSNR ( double snr )

protectedslot

Definition at line 2260 of file guide.cpp.

◆ setStarPosition

void Guide::setStarPosition	(	const QVector3D &	newCenter,
		bool	updateNow )

slot

Definition at line 1823 of file guide.cpp.

◆ setStatus

void Guide::setStatus ( Ekos::GuideState newState )

slot

Definition at line 1576 of file guide.cpp.

◆ setSubFrameEnabled

void Guide::setSubFrameEnabled ( bool enable )

slot

DBUS interface function.

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.

Parameters

enable if true, it will select a subframe around the guide star depending on the boxSize size.

Definition at line 1553 of file guide.cpp.

◆ setTrackingStar

void Guide::setTrackingStar	(	int	x,
		int	y )

protectedslot

setTrackingStar Gets called when the user select a star in the guide frame

Parameters

x	X coordinate of star
y	Y coordinate of star

Definition at line 2158 of file guide.cpp.

◆ showFITSViewer

void Guide::showFITSViewer ( )

protectedslot

Definition at line 2562 of file guide.cpp.

◆ slotAutoScaleGraphs

void Guide::slotAutoScaleGraphs ( )

slot

Definition at line 279 of file guide.cpp.

◆ status()

Q_SCRIPTABLE Ekos::GuideState Ekos::Guide::status ( )

inline

getStatus Return guide module status

Returns: state of guide module from Ekos::GuideState

Definition at line 115 of file guide.h.

◆ suspend

bool Guide::suspend ( )

slot

DBUS interface function.

suspend Suspend autoguiding

Returns: True if successful, false otherwise.

Definition at line 1419 of file guide.cpp.

◆ syncCameraInfo()

void Guide::syncCameraInfo ( )

Definition at line 534 of file guide.cpp.

◆ syncTelescopeInfo()

void Guide::syncTelescopeInfo ( )

Definition at line 559 of file guide.cpp.

◆ updateCCDBin

void Guide::updateCCDBin ( int index )

protectedslot

Definition at line 1722 of file guide.cpp.

◆ updateDirectionsFromPHD2

void Guide::updateDirectionsFromPHD2 ( const QString & mode )

slot

Definition at line 2120 of file guide.cpp.

◆ updateProperty

void Guide::updateProperty ( INDI::Property prop )

protectedslot

processCCDNumber Process number properties arriving from CCD.

Currently, binning changes are processed.

Parameters

nvp	pointer to number property.

Definition at line 1741 of file guide.cpp.

◆ updateSetting

void Guide::updateSetting	(	const QString &	key,
		const QVariant &	value )

slot

updateSetting Update per-train and global setting

Parameters

key	Name of setting
value	Value

Note: per-train and global settings are updated. Changes are saved to database and to disk immediately.

Definition at line 3400 of file guide.cpp.

◆ updateTrackingBoxSize

void Guide::updateTrackingBoxSize ( int currentIndex )

protectedslot

Definition at line 2077 of file guide.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Kstars

Ekos::Guide

Public Types

Properties

Signals

Public Slots

Public Member Functions

Protected Slots

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ GuiderStage

◆ GuiderType

Property Documentation

◆ axisDelta

◆ axisSigma

◆ camera

◆ exposure

◆ guider

◆ logText

◆ opticalTrain

◆ status

Constructor & Destructor Documentation

◆ Guide()

◆ ~Guide()

Member Function Documentation

◆ abort

◆ abortExposure

◆ appendLogText

◆ axisDelta

◆ axisSigma

◆ buildTarget

◆ calibrate

◆ calibrationUpdate

◆ camera()

◆ capture

◆ checkCamera

◆ checkExposureValue

◆ clearCalibration

◆ clearCalibrationGraphs

◆ clearGuideGraphs

◆ clearLog()

◆ configSEPMultistarOptions

◆ configurePHD2Camera()

◆ connectGuider()

◆ disconnectGuider()

◆ dither

◆ exposure()

◆ getAllSettings()

◆ getGuiderInstance()

◆ getLogText()

◆ getStarPosition()

◆ getTrackingBoxSize()

◆ guide

◆ guideAfterMeridianFlip

◆ guideHistory

◆ guideInfo

◆ guider()

◆ handleHorizontalPlotSizeChange

◆ handleVerticalPlotSizeChange

◆ logText()

◆ loop

◆ nonGuidedDither

◆ onControlDirectionChanged

◆ onEnableDirDEC

◆ onEnableDirRA

◆ onThresholdChanged

◆ opticalTrain

◆ processCaptureTimeout

◆ processData

◆ processGuideOptions

◆ removeDevice()

◆ resetNonGuidedDither

◆ resume

◆ saveDefaultGuideExposure

◆ sendMultiPulse

◆ sendSinglePulse

◆ setAdaptiveOptics()