Differential D29817 Diff 83056 kstars/ekos/guide/internalguide/guidelog.h

Changeset View

Standalone View

kstars/ekos/guide/internalguide/guidelog.h

This file was added.

1		/* GuideLog class.
2		Copyright (C) 2020 Hy Murveit
3
4		This application is free software; you can redistribute it and/or
5		modify it under the terms of the GNU General Public
6		License as published by the Free Software Foundation; either
7		version 2 of the License, or (at your option) any later version.
8		*/
9
10		#pragma once
11
12		#include <QElapsedTimer>
	mutlaqjaUnsubmitted Not Done IIRC, QElapsedTimer is a new addition to Qt.. so we need to surround this with ifdef QT_VERSION..etc ? mutlaqja: IIRC, QElapsedTimer is a new addition to Qt.. so we need to surround this with ifdef QT_VERSION.
13		#include <QFile>
14
15		#include "indi/indicommon.h"
16		#include "indi/inditelescope.h"
17
18		// This class will help write guide log files, using the PHD2 guide log format.
19
20		class GuideLog
21		{
22		public:
23		class GuideInfo
24		{
25		public:
26		double pixelScale = 0;
27		int binning = 1;
28		double focalLength = 0;
29		// Recent mount position.
30		double ra = 0, dec = 0, azimuth = 0, altitude = 0;
31		ISD::Telescope::PierSide pierSide;
32		};
33
34		class GuideData
35		{
36		public:
37		enum GuideDataType { MOUNT, DROP };
38		GuideDataType type;
39		double dx, dy;
40		double raDistance, decDistance;
41		double raGuideDistance, decGuideDistance;
42		int raDuration, decDuration;
43		GuideDirection raDirection, decDirection;
44		double mass;
45		double snr;
46		// From https://openphdguiding.org/PHD2_User_Guide.pdf and logs
47		enum ErrorCode {
48		NO_ERROR = 0,
49		STAR_SATURATED = 1,
50		LOW_SNR = 2,
51		STAR_LOST_LOW_MASS = 3,
52		EDGE_OF_FRAME = 4,
53		STAR_MASS_CHANGED = 5,
54		STAR_LOST_MASS_CHANGED = 6,
55		NO_STAR_FOUND = 7
56		};
57		ErrorCode code;
58		};
59
60		GuideLog();
61		~GuideLog();
62
63		// Won't log unless enable() is called.
64		void enable() { enabled = true; }
65		void disable() { enabled = false; }
66
67		// These are called for each guiding session.
68		void startGuiding(const GuideInfo &info);
69		void addGuideData(const GuideData &data);
70		void endGuiding();
71
72		// These are called for each calibration session.
73		void startCalibration(const GuideInfo &info);
74		void addCalibrationData(GuideDirection direction, double x, double y, double xOrigin, double yOrigin);
75		void endCalibrationSection(GuideDirection direction, double degrees);
76		void endCalibration(double raSpeed = 0, double decSpeed = 0);
77
78		// INFO messages
79		void ditherInfo(double dx, double dy, double x, double y);
80		void pauseInfo();
81		void resumeInfo();
82		void settleStartedInfo();
83		void settleCompletedInfo();
84
85		// Deal with suspend, resume, dither, ...
86		private:
87		// Write the file header and footer.
88		void startLog();
89		void endLog();
90		void appendToLog(const QString &lines);
91
92		// Log file info.
93		QFile logFile;
94		QString logFileName;
95
96		// Message indeces and timers.
97		int guideIndex = 1;
98		int calibrationIndex = 1;
99		QElapsedTimer timer;
100
101		// Used to write and end-of-guiding message on exit, if this was not called.
102		bool isGuiding = false;
103
104		// Variable used to detect calibration change of direction.
105		GuideDirection lastCalibrationDirection = NO_DIR;
106
107		// If false, no logging will occur.
108		bool enabled = false;
109
110		// True means the filename was created and the log's header has been written.
111		bool initialized = false;
112		};