Ekos::PHD2

#include <phd2.h>

Inheritance diagram for Ekos::PHD2:

[legend]

Public Types
enum	PHD2Connection { DISCONNECTED , CONNECTED , EQUIPMENT_DISCONNECTED , EQUIPMENT_CONNECTED , CONNECTING , DISCONNECTING }

enum	PHD2Event { Version , LockPositionSet , Calibrating , CalibrationComplete , StarSelected , StartGuiding , Paused , StartCalibration , AppState , CalibrationFailed , CalibrationDataFlipped , LoopingExposures , LoopingExposuresStopped , SettleBegin , Settling , SettleDone , StarLost , GuidingStopped , Resumed , GuideStep , GuidingDithered , LockPositionLost , Alert , GuideParamChange , ConfigurationChange }

enum	PHD2MessageType { PHD2_UNKNOWN , PHD2_RESULT , PHD2_EVENT , PHD2_ERROR }

enum	PHD2ResultType { NO_RESULT , CAPTURE_SINGLE_FRAME , CLEAR_CALIBRATION_COMMAND_RECEIVED , DITHER_COMMAND_RECEIVED , APP_STATE_RECEIVED , IS_EQUIPMENT_CONNECTED , GET_CURRENT_EQUIPMENT , DEC_GUIDE_MODE , EXPOSURE_TIME , EXPOSURE_DURATIONS , LOCK_POSITION , PIXEL_SCALE , STAR_IMAGE , GUIDE_COMMAND_RECEIVED , LOOP , CONNECTION_RESULT , SET_DEC_GUIDE_MODE_COMMAND_RECEIVED , SET_EXPOSURE_COMMAND_RECEIVED , SET_LOCK_POSITION , SET_PAUSED_COMMAND_RECEIVED , STOP_CAPTURE_COMMAND_RECEIVED }

enum	PHD2State { STOPPED , SELECTED , CALIBRATING , GUIDING , LOSTLOCK , PAUSED , LOOPING , DITHERING }

Public Types inherited from Ekos::GuideInterface
enum	CalibrationUpdateType { RA_IN , RA_OUT , BACKLASH , DEC_IN , DEC_OUT , CALIBRATION_MESSAGE_ONLY }

Public Types inherited from QObject
typedef	QObjectList

Public Member Functions
bool	abort () override

bool	calibrate () override

void	captureSingleFrame ()

void	checkDEGuideMode ()

void	checkIfEquipmentConnected ()

bool	clearCalibration () override

bool	Connect () override

void	connectEquipment (bool enable)

bool	Disconnect () override

bool	dither (double pixels) override

QString	getCurrentAuxMount ()

QString	getCurrentCamera ()

QString	getCurrentMount ()

bool	guide () override

bool	isConnected () override

bool	isCurrentCameraNotInEkos ()

void	loop ()

void	requestAppState ()

void	requestCurrentEquipmentUpdate ()

void	requestExposureDurations ()

void	requestExposureTime ()

void	requestLockPosition ()

void	requestPixelScale ()

void	requestSetDEGuideMode (bool deEnabled, bool nEnabled, bool sEnabled)

void	requestSetExposureTime (int time)

void	requestStarImage (int size)

bool	resume () override

void	setCurrentCameraIsNotInEkos (bool enable)

void	setGuideView (const QSharedPointer< FITSView > &guideView)

void	setLockPosition (double x, double y)

bool	suspend () override

Public Member Functions inherited from Ekos::GuideInterface
virtual bool	getFrameParams (uint16_t x, uint16_t y, uint16_t w, uint16_t h, uint16_t binX, uint16_t binY)

virtual bool	getGuiderParams (double ccdPixelSizeX, double ccdPixelSizeY, double mountAperture, double mountFocalLength)

virtual bool	reacquire ()

virtual void	resetGPG ()

virtual bool	setFrameParams (uint16_t x, uint16_t y, uint16_t w, uint16_t h, uint16_t binX, uint16_t binY)

virtual bool	setGuiderParams (double ccdPixelSizeX, double ccdPixelSizeY, double mountAperture, double mountFocalLength)

virtual void	setMountCoords (const SkyPoint &position, ISD::Mount::PierSide side)

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

virtual void	setStarPosition (QVector3D &starCenter)

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	event (QEvent *e)

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

Additional Inherited Members
Properties inherited from QObject
	objectName

Signals inherited from Ekos::GuideInterface
void	abortExposure ()

void	calibrationUpdate (CalibrationUpdateType type, const QString &message=QString(""), double x=0, double y=0)

void	frameCaptureRequested ()

void	guideEquipmentUpdated ()

void	guideInfo (const QString &)

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

void	newAxisDelta (double delta_ra, double delta_dec)

void	newAxisPulse (double pulse_ra, double pulse_dec)

void	newAxisSigma (double sigma_ra, double sigma_dec)

void	newLog (const QString &)

void	newSNR (double snr)

void	newStarPixmap (QPixmap &)

void	newStarPosition (const QVector3D &newCenter, bool updateNow)

void	newStatus (Ekos::GuideState)

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)

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 Attributes inherited from Ekos::GuideInterface
double	ccdPixelSizeX { 0 }

double	ccdPixelSizeY { 0 }

dms	mountAltitude

double	mountAperture { 0 }

dms	mountAzimuth

dms	mountDEC

double	mountFocalLength { 0 }

dms	mountRA

ISD::Mount::PierSide	pierSide { ISD::Mount::PIER_UNKNOWN }

Ekos::GuideState	state { GUIDE_IDLE }

uint16_t	subBinX { 1 }

uint16_t	subBinY { 1 }

uint16_t	subH { 0 }

uint16_t	subW { 0 }

uint16_t	subX { 0 }

uint16_t	subY { 0 }

Detailed Description

Uses external PHD2 for guiding.

Author: Jasem Mutlaq

Version: 1.1

Definition at line 29 of file phd2.h.

Member Enumeration Documentation

◆ PHD2Connection

enum Ekos::PHD2::PHD2Connection

Definition at line 75 of file phd2.h.

◆ PHD2Event

enum Ekos::PHD2::PHD2Event

Definition at line 34 of file phd2.h.

◆ PHD2MessageType

enum Ekos::PHD2::PHD2MessageType

Definition at line 84 of file phd2.h.

◆ PHD2ResultType

enum Ekos::PHD2::PHD2ResultType

Definition at line 93 of file phd2.h.

◆ PHD2State

enum Ekos::PHD2::PHD2State

Definition at line 63 of file phd2.h.

Constructor & Destructor Documentation

◆ PHD2()

Ekos::PHD2::PHD2 ( )

Definition at line 32 of file phd2.cpp.

◆ ~PHD2()

Ekos::PHD2::~PHD2 ( )

Definition at line 179 of file phd2.cpp.

Member Function Documentation

◆ abort()

bool Ekos::PHD2::abort ( )

overridevirtual

Implements Ekos::GuideInterface.

Definition at line 1481 of file phd2.cpp.

◆ calibrate()

bool Ekos::PHD2::calibrate ( )

overridevirtual

Implements Ekos::GuideInterface.

Definition at line 1497 of file phd2.cpp.

◆ captureSingleFrame()

void Ekos::PHD2::captureSingleFrame ( )

Definition at line 1133 of file phd2.cpp.

◆ checkDEGuideMode()

void Ekos::PHD2::checkDEGuideMode ( )

Definition at line 1244 of file phd2.cpp.

◆ checkIfEquipmentConnected()

void Ekos::PHD2::checkIfEquipmentConnected ( )

Definition at line 1231 of file phd2.cpp.

◆ clearCalibration()

bool Ekos::PHD2::clearCalibration ( )

overridevirtual

Implements Ekos::GuideInterface.

Definition at line 1139 of file phd2.cpp.

◆ Connect()

bool Ekos::PHD2::Connect ( )

overridevirtual

Implements Ekos::GuideInterface.

Definition at line 185 of file phd2.cpp.

◆ connectEquipment()

void Ekos::PHD2::connectEquipment ( bool enable )

Definition at line 1347 of file phd2.cpp.

◆ Disconnect()

bool Ekos::PHD2::Disconnect ( )

overridevirtual

Implements Ekos::GuideInterface.

Definition at line 242 of file phd2.cpp.

◆ dither()

bool Ekos::PHD2::dither ( double pixels )

overridevirtual

Implements Ekos::GuideInterface.

Definition at line 1157 of file phd2.cpp.

◆ getCurrentAuxMount()

QString Ekos::PHD2::getCurrentAuxMount ( )

inline

Definition at line 208 of file phd2.h.

◆ getCurrentCamera()

QString Ekos::PHD2::getCurrentCamera ( )

inline

Definition at line 200 of file phd2.h.

◆ getCurrentMount()

QString Ekos::PHD2::getCurrentMount ( )

inline

Definition at line 204 of file phd2.h.

◆ guide()

bool Ekos::PHD2::guide ( )

overridevirtual

Implements Ekos::GuideInterface.

Definition at line 1301 of file phd2.cpp.

◆ isConnected()

bool Ekos::PHD2::isConnected ( )

inlineoverridevirtual

Implements Ekos::GuideInterface.

Definition at line 146 of file phd2.h.

◆ isCurrentCameraNotInEkos()

bool Ekos::PHD2::isCurrentCameraNotInEkos ( )

inline

Definition at line 213 of file phd2.h.

◆ loop()

void Ekos::PHD2::loop ( )

Definition at line 1339 of file phd2.cpp.

◆ requestAppState()

void Ekos::PHD2::requestAppState ( )

Definition at line 1222 of file phd2.cpp.

◆ requestCurrentEquipmentUpdate()

void Ekos::PHD2::requestCurrentEquipmentUpdate ( )

Definition at line 1238 of file phd2.cpp.

◆ requestExposureDurations()

void Ekos::PHD2::requestExposureDurations ( )

Definition at line 1256 of file phd2.cpp.

◆ requestExposureTime()

void Ekos::PHD2::requestExposureTime ( )

Definition at line 1250 of file phd2.cpp.

◆ requestLockPosition()

void Ekos::PHD2::requestLockPosition ( )

Definition at line 1262 of file phd2.cpp.

◆ requestPixelScale()

void Ekos::PHD2::requestPixelScale ( )

Definition at line 1271 of file phd2.cpp.

◆ requestSetDEGuideMode()

void Ekos::PHD2::requestSetDEGuideMode	(	bool	deEnabled,
		bool	nEnabled,
		bool	sEnabled )

Definition at line 1379 of file phd2.cpp.

◆ requestSetExposureTime()

void Ekos::PHD2::requestSetExposureTime ( int time )

Definition at line 1404 of file phd2.cpp.

◆ requestStarImage()

void Ekos::PHD2::requestStarImage ( int size )

Definition at line 1282 of file phd2.cpp.

◆ resume()

bool Ekos::PHD2::resume ( )

overridevirtual

Implements Ekos::GuideInterface.

Definition at line 1452 of file phd2.cpp.

◆ setCurrentCameraIsNotInEkos()

void Ekos::PHD2::setCurrentCameraIsNotInEkos ( bool enable )

inline

Definition at line 217 of file phd2.h.

◆ setGuideView()

void Ekos::PHD2::setGuideView ( const QSharedPointer< FITSView > & guideView )

Definition at line 1020 of file phd2.cpp.

◆ setLockPosition()

void Ekos::PHD2::setLockPosition	(	double	x,
		double	y )

Definition at line 1412 of file phd2.cpp.

◆ suspend()

bool Ekos::PHD2::suspend ( )

overridevirtual

Implements Ekos::GuideInterface.

Definition at line 1423 of file phd2.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::PHD2

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ PHD2Connection

◆ PHD2Event

◆ PHD2MessageType

◆ PHD2ResultType

◆ PHD2State

Constructor & Destructor Documentation

◆ PHD2()

◆ ~PHD2()

Member Function Documentation

◆ abort()

◆ calibrate()

◆ captureSingleFrame()

◆ checkDEGuideMode()

◆ checkIfEquipmentConnected()

◆ clearCalibration()

◆ Connect()

◆ connectEquipment()

◆ Disconnect()

◆ dither()

◆ getCurrentAuxMount()

◆ getCurrentCamera()

◆ getCurrentMount()

◆ guide()

◆ isConnected()

◆ isCurrentCameraNotInEkos()

◆ loop()

◆ requestAppState()

◆ requestCurrentEquipmentUpdate()

◆ requestExposureDurations()

◆ requestExposureTime()

◆ requestLockPosition()

◆ requestPixelScale()

◆ requestSetDEGuideMode()

◆ requestSetExposureTime()

◆ requestStarImage()

◆ resume()

◆ setCurrentCameraIsNotInEkos()

◆ setGuideView()

◆ setLockPosition()

◆ suspend()