Ekos::Capture
#include <capture.h>

Public Types | |
enum | ADUAlgorithm { ADU_LEAST_SQUARES, ADU_POLYNOMIAL } |
enum | MFStage { MF_NONE, MF_REQUESTED, MF_READY, MF_INITIATED, MF_FLIPPING, MF_SLEWING, MF_COMPLETED, MF_ALIGNING, MF_GUIDING } |
typedef IPState(Capture::* | PauseFunctionPointer) () |
![]() | |
enum | RenderFlag |
![]() | |
enum | PaintDeviceMetric |
Properties | |
QString | camera |
bool | coolerControl |
QString | filter |
QString | filterWheel |
QStringList | logText |
QString | observerName |
Ekos::CaptureState | status |
QString | targetName |
![]() | |
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 | |
![]() | |
objectName | |
Signals | |
void | abortFocus () |
void | captureAborted (double exposureSeconds) |
Q_SCRIPTABLE void | captureComplete (const QVariantMap &metadata) |
void | captureStarting (double exposureSeconds, const QString &filter) |
void | checkFocus (double) |
void | driverTimedout (const QString &deviceName) |
void | dslrInfoRequested (const QString &cameraName) |
Q_SCRIPTABLE void | meridianFlipCompleted () |
Q_SCRIPTABLE void | meridianFlipStarted () |
void | newDownloadProgress (double) |
void | newExposureProgress (Ekos::SequenceJob *job) |
void | newGuiderDrift (double deviation_rms) |
void | newImage (Ekos::SequenceJob *job, const QSharedPointer< FITSData > &data) |
Q_SCRIPTABLE void | newLog (const QString &text) |
void | newMeridianFlipSetup (bool activate, double hours) |
void | newMeridianFlipStatus (Mount::MeridianFlipStatus status) |
Q_SCRIPTABLE void | newStatus (Ekos::CaptureState status) |
void | prepareCapture () |
void | ready () |
void | resetFocus () |
void | resumeGuiding () |
void | sequenceChanged (const QJsonArray &sequence) |
void | settingsUpdated (const QJsonObject &settings) |
void | suspendGuiding () |
Public Slots | |
Q_SCRIPTABLE Q_NOREPLY void | abort () |
bool | addJob (bool preview=false, bool isDarkFlat=false) |
bool | addSequenceJob () |
void | appendLogText (const QString &) |
void | captureImage () |
void | captureOne () |
void | checkCamera (int CCDNum=-1) |
void | checkFilter (int filterNum=-1) |
void | clearCameraConfiguration () |
void | generateDarkFlats () |
void | meridianFlipStatusChanged (Mount::MeridianFlipStatus status) |
void | moveJobDown () |
void | moveJobUp () |
Q_SCRIPTABLE Q_NOREPLY void | pause () |
void | prepareActiveJobStage1 () |
void | prepareActiveJobStage2 () |
void | preparePreCaptureActions () |
void | processCCDNumber (INumberVectorProperty *nvp) |
void | processData (const QSharedPointer< FITSData > &data) |
void | processNewTargetName (const QString &name) |
void | processTelescopeNumber (INumberVectorProperty *nvp) |
void | registerNewModule (const QString &name) |
bool | removeJob (int index=-1) |
void | removeJobFromQueue () |
Q_SCRIPTABLE Q_NOREPLY void | restartCamera (const QString &name) |
void | setAlignResults (double orientation, double ra, double de, double pixscale) |
void | setAlignStatus (Ekos::AlignState state) |
void | setBinning (int horBin, int verBin) |
void | setCount (uint16_t count) |
void | setDelay (uint16_t delay) |
void | setExposure (double value) |
void | setFocusStatus (Ekos::FocusState state) |
void | setFocusTemperatureDelta (double focusTemperatureDelta, double absTemperature) |
void | setForceTemperature (bool enabled) |
void | setFrameType (const QString &type) |
void | setGuideChip (ISD::CameraChip *guideChip) |
void | setGuideDeviation (double delta_ra, double delta_dec) |
void | setGuideStatus (Ekos::GuideState state) |
void | setHFR (double newHFR, int) |
void | setISO (int index) |
void | setMountStatus (ISD::Mount::Status newState) |
void | setPrefix (const QString &prefix) |
void | setTargetTemperature (double temperature) |
void | showTemperatureRegulation () |
Q_SCRIPTABLE Q_NOREPLY void | start () |
bool | startFocusIfRequired () |
void | startFraming () |
Q_SCRIPTABLE Q_NOREPLY void | stop (CaptureState targetState=CAPTURE_IDLE) |
Q_SCRIPTABLE Q_NOREPLY void | suspend () |
Q_SCRIPTABLE Q_NOREPLY void | toggleSequence () |
Q_SCRIPTABLE Q_NOREPLY void | toggleVideo (bool enabled) |
void | updateCCDTemperature (double value) |
void | updateTargetDistance (double targetDiff) |
Public Member Functions | |
Capture () | |
bool | addCamera (ISD::Camera *device) |
bool | addDome (ISD::Dome *device) |
void | addDSLRInfo (const QString &model, uint32_t maxW, uint32_t maxH, double pixelW, double pixelH) |
bool | addDustCap (ISD::DustCap *device) |
bool | addFilterWheel (ISD::FilterWheel *device) |
void | addGuideHead (ISD::Camera *device) |
bool | addLightBox (ISD::LightBox *device) |
bool | addMount (ISD::Mount *device) |
bool | addRotator (ISD::Rotator *device) |
Q_SCRIPTABLE QString | camera () |
Q_SCRIPTABLE Q_NOREPLY void | clearAutoFocusHFR () |
void | clearLog () |
Q_SCRIPTABLE Q_NOREPLY void | clearSequenceQueue () |
Q_SCRIPTABLE QString | filter () |
Q_SCRIPTABLE QString | filterWheel () |
Q_SCRIPTABLE int | getActiveJobID () |
Q_SCRIPTABLE int | getActiveJobRemainingTime () |
QJsonObject | getCalibrationSettings () |
double | getEstimatedDownloadTime () |
QJsonObject | getFileSettings () |
Q_SCRIPTABLE int | getJobCount () |
Q_SCRIPTABLE double | getJobExposureDuration (int id) |
Q_SCRIPTABLE double | getJobExposureProgress (int id) |
Q_SCRIPTABLE QString | getJobFilterName (int id) |
Q_SCRIPTABLE CCDFrameType | getJobFrameType (int id) |
Q_SCRIPTABLE int | getJobImageCount (int id) |
Q_SCRIPTABLE int | getJobImageProgress (int id) |
Q_SCRIPTABLE QString | getJobState (int id) |
QJsonObject | getLimitSettings () |
QString | getLogText () |
Q_SCRIPTABLE int | getOverallRemainingTime () |
Q_SCRIPTABLE int | getPendingJobCount () |
QJsonObject | getPresetSettings () |
Q_SCRIPTABLE double | getProgressPercentage () |
const QJsonArray & | getSequence () const |
Q_SCRIPTABLE QString | getSequenceQueueStatus () |
Q_SCRIPTABLE bool | hasCoolerControl () |
Q_SCRIPTABLE Q_NOREPLY void | ignoreSequenceHistory () |
Q_SCRIPTABLE bool | loadSequenceQueue (const QString &fileURL) |
Q_SCRIPTABLE QStringList | logText () |
void | reconnectDriver (const QString &camera, const QString &filterWheel) |
void | removeDevice (ISD::GenericDevice *device) |
Q_SCRIPTABLE bool | saveSequenceQueue (const QString &path) |
void | setCalibrationSettings (const QJsonObject &settings) |
Q_SCRIPTABLE bool | setCamera (const QString &device) |
Q_SCRIPTABLE Q_NOREPLY void | setCapturedFramesMap (const QString &signature, int count) |
Q_SCRIPTABLE bool | setCoolerControl (bool enable) |
void | setFileSettings (const QJsonObject &settings) |
Q_SCRIPTABLE bool | setFilter (const QString &filter) |
void | setFilterManager (const QSharedPointer< FilterManager > &manager) |
Q_SCRIPTABLE bool | setFilterWheel (const QString &device) |
Q_SCRIPTABLE Q_NOREPLY void | setInSequenceFocus (bool enable, double HFR) |
void | setLimitSettings (const QJsonObject &settings) |
Q_SCRIPTABLE Q_NOREPLY void | setMaximumGuidingDeviation (bool enable, double value) |
void | setPresetSettings (const QJsonObject &settings) |
void | setRotatorReversed (bool toggled) |
bool | setVideoLimits (uint16_t maxBufferSize, uint16_t maxPreviewFPS) |
Q_SCRIPTABLE Ekos::CaptureState | status () |
void | syncCameraInfo () |
void | syncDSLRToTargetChip (const QString &model) |
void | syncFilterInfo () |
void | syncFrameType (const QString &name) |
void | syncTelescopeInfo () |
void | updateSequencePrefix (const QString &newPrefix, const QString &dir) |
![]() | |
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 () |
void | addAction (QAction *action) |
void | addActions (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 |
void | getContentsMargins (int *left, int *top, int *right, int *bottom) 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, 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 | isEnabledToTLW () 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 |
QPoint | mapFromGlobal (const QPoint &pos) const const |
QPoint | mapFromParent (const QPoint &pos) const const |
QPoint | mapTo (const QWidget *parent, const QPoint &pos) const const |
QPoint | mapToGlobal (const QPoint &pos) const const |
QPoint | mapToParent (const QPoint &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, QWidget::RenderFlags renderFlags) |
void | render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::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 ®ion) |
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 | 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 |
![]() | |
QObject (QObject *parent) | |
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 () |
void | dumpObjectInfo () const const |
void | dumpObjectTree () |
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 QRegExp ®Exp, 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 |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
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_DISABLE_COPY (Class) | |
Q_DISABLE_COPY_MOVE (Class) | |
Q_DISABLE_MOVE (Class) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
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 | qFindChild (const QObject *obj, const QString &name) |
QList< T > | qFindChildren (const QObject *obj, const QRegExp ®Exp) |
QList< T > | qFindChildren (const QObject *obj, const QString &name) |
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 | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds time, Qt::TimerType timerType) |
QThread * | thread () const const |
![]() | |
int | colorCount () const const |
int | depth () const const |
int | 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 |
Additional Inherited Members | |
![]() | |
QWidget * | createWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags) |
QWidget * | find (WId id) |
QWidget * | keyboardGrabber () |
QWidget * | mouseGrabber () |
void | setTabOrder (QWidget *first, QWidget *second) |
![]() | |
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) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
![]() | |
DrawChildren | |
DrawWindowBackground | |
IgnoreMask | |
typedef | RenderFlags |
![]() | |
typedef | QObjectList |
![]() | |
PdmDepth | |
PdmDevicePixelRatio | |
PdmDevicePixelRatioScaled | |
PdmDpiX | |
PdmDpiY | |
PdmHeight | |
PdmHeightMM | |
PdmNumColors | |
PdmPhysicalDpiX | |
PdmPhysicalDpiY | |
PdmWidth | |
PdmWidthMM | |
![]() | |
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 (QEvent *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 (QPaintDevice::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, long *result) |
virtual void | paintEvent (QPaintEvent *event) |
virtual void | resizeEvent (QResizeEvent *event) |
virtual void | showEvent (QShowEvent *event) |
virtual void | tabletEvent (QTabletEvent *event) |
void | updateMicroFocus () |
virtual void | wheelEvent (QWheelEvent *event) |
![]() | |
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) |
Detailed Description
Captures single or sequence of images from a CCD. The capture class support capturing single or multiple images from a CCD, it provides a powerful sequence queue with filter wheel selection. Any sequence queue can be saved as Ekos Sequence Queue (.esq). All image capture operations are saved as Sequence Jobs that encapsulate all the different options in a capture process. The user may select in sequence autofocusing by setting a maximum HFR limit. When the limit is exceeded, it automatically trigger autofocus operation. The capture process can also be linked with guide module. If guiding deviations exceed a certain threshold, the capture operation aborts until the guiding deviation resume to acceptable levels and the capture operation is resumed.
- Version
- 1.4
Constructor & Destructor Documentation
◆ Capture()
Ekos::Capture::Capture | ( | ) |
Member Function Documentation
◆ addCamera()
bool Ekos::Capture::addCamera | ( | 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 516 of file capture.cpp.
◆ addDome()
bool Ekos::Capture::addDome | ( | ISD::Dome * | device | ) |
Add new Dome.
- Parameters
-
device pointer to Dome device.
- Returns
- True if added successfully, false if duplicate or failed to add.
Definition at line 583 of file capture.cpp.
◆ addDSLRInfo()
void Ekos::Capture::addDSLRInfo | ( | const QString & | model, |
uint32_t | maxW, | ||
uint32_t | maxH, | ||
double | pixelW, | ||
double | pixelH | ||
) |
addDSLRInfo Save DSLR Info the in the database.
If the interactive dialog was open, close it.
- Parameters
-
model Camera name maxW Maximum width in pixels maxH Maximum height in pixels pixelW Pixel horizontal size in microns pixelH Pizel vertical size in microns
Definition at line 6625 of file capture.cpp.
◆ addDustCap()
bool Ekos::Capture::addDustCap | ( | ISD::DustCap * | device | ) |
Add new Dust Cap.
- Parameters
-
device pointer to Dust Cap device.
- Returns
- True if added successfully, false if duplicate or failed to add.
Definition at line 600 of file capture.cpp.
◆ addFilterWheel()
bool Ekos::Capture::addFilterWheel | ( | ISD::FilterWheel * | device | ) |
Add new Filter Wheel.
- Parameters
-
device pointer to filter wheel device.
- Returns
- True if added successfully, false if duplicate or failed to add.
Definition at line 554 of file capture.cpp.
◆ addJob
|
slot |
addJob Add a new job to the sequence queue given the settings in the GUI.
- Parameters
-
preview True if the job is a preview job, otherwise, it is added as a batch job. isDarkFlat True if the job is a dark flat job, false otherwise.
- Returns
- True if job is added successfully, false otherwise.
Definition at line 2970 of file capture.cpp.
◆ addLightBox()
bool Ekos::Capture::addLightBox | ( | ISD::LightBox * | device | ) |
Add new Light Box.
- Parameters
-
device pointer to Light Box device.
- Returns
- True if added successfully, false if duplicate or failed to add.
Definition at line 656 of file capture.cpp.
◆ addMount()
bool Ekos::Capture::addMount | ( | 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 618 of file capture.cpp.
◆ addRotator()
bool Ekos::Capture::addRotator | ( | ISD::Rotator * | device | ) |
Add new Rotator.
- Parameters
-
device pointer to rotator device.
- Returns
- True if added successfully, false if duplicate or failed to add.
Definition at line 638 of file capture.cpp.
◆ addSequenceJob
|
slot |
addSequenceJob Add a sequence job.
This simply calls addJob below with both preview and isDarkFlat set to false.
- Returns
- return result of addJob(..)
Definition at line 2965 of file capture.cpp.
◆ captureImage
|
slot |
captureImage Initiates image capture in the active job.
Definition at line 2475 of file capture.cpp.
◆ captureOne
|
slot |
captureOne Capture one preview image
Definition at line 2434 of file capture.cpp.
◆ checkCamera
|
slot |
checkCamera Refreshes the CCD information in the capture module.
- Parameters
-
CCDNum The CCD index in the CCD combo box to select as the active CCD.
Definition at line 1039 of file capture.cpp.
◆ checkFilter
|
slot |
checkFilter Refreshes the filter wheel information in the capture module.
- Parameters
-
filterNum The filter wheel index in the filter device combo box to set as the active filter.
Definition at line 1656 of file capture.cpp.
◆ clearAutoFocusHFR()
void Ekos::Capture::clearAutoFocusHFR | ( | ) |
DBUS interface function.
Clear in-sequence focus settings. It sets the autofocus HFR to zero so that next autofocus value is remembered for the in-sequence focusing.
Definition at line 5907 of file capture.cpp.
◆ clearSequenceQueue()
void Ekos::Capture::clearSequenceQueue | ( | ) |
DBUS interface function.
Aborts any current jobs and remove all sequence queue jobs.
Definition at line 5331 of file capture.cpp.
◆ generateDarkFlats
|
slot |
generateDarkFlats Generate a list of dark flat jobs from available flat frames.
Definition at line 7517 of file capture.cpp.
◆ getActiveJobID()
int Ekos::Capture::getActiveJobID | ( | ) |
DBUS interface function.
- Returns
- Returns ID of current active job if any, or -1 if there are no active jobs.
Definition at line 5189 of file capture.cpp.
◆ getActiveJobRemainingTime()
int Ekos::Capture::getActiveJobRemainingTime | ( | ) |
DBUS interface function.
- Returns
- Returns time left in seconds until active job is estimated to be complete.
Definition at line 5304 of file capture.cpp.
◆ getCalibrationSettings()
QJsonObject Ekos::Capture::getCalibrationSettings | ( | ) |
getCalibrationSettings Get Calibration settings
- Returns
- settings as JSON object
Definition at line 6847 of file capture.cpp.
◆ getFileSettings()
QJsonObject Ekos::Capture::getFileSettings | ( | ) |
getFileSettings Compile file setting
- Returns
- File settings as JSON object
Definition at line 6809 of file capture.cpp.
◆ getJobCount()
|
inline |
◆ getJobExposureDuration()
double Ekos::Capture::getJobExposureDuration | ( | int | id | ) |
DBUS interface function.
- Parameters
-
id job number. Job IDs start from 0 to N-1.
- Returns
- Returns the total requested exposure duration in the job.
Definition at line 5271 of file capture.cpp.
◆ getJobExposureProgress()
double Ekos::Capture::getJobExposureProgress | ( | int | id | ) |
DBUS interface function.
- Parameters
-
id job number. Job IDs start from 0 to N-1.
- Returns
- Returns the number of seconds left in an exposure operation.
Definition at line 5260 of file capture.cpp.
◆ getJobFilterName()
QString Ekos::Capture::getJobFilterName | ( | int | id | ) |
DBUS interface function.
- Parameters
-
id job number. Job IDs start from 0 to N-1.
- Returns
- Returns the job filter name.
Definition at line 5227 of file capture.cpp.
◆ getJobFrameType()
CCDFrameType Ekos::Capture::getJobFrameType | ( | int | id | ) |
DBUS interface function.
- Parameters
-
id job number. Job IDs start from 0 to N-1.
- Returns
- Returns the frame type (light, dark, ...) of the job.
Definition at line 5282 of file capture.cpp.
◆ getJobImageCount()
int Ekos::Capture::getJobImageCount | ( | int | id | ) |
DBUS interface function.
- Parameters
-
id job number. Job IDs start from 0 to N-1.
- Returns
- Returns the total number of images to capture in the job.
Definition at line 5249 of file capture.cpp.
◆ getJobImageProgress()
int Ekos::Capture::getJobImageProgress | ( | int | id | ) |
DBUS interface function.
- Parameters
-
id job number. Job IDs start from 0 to N-1.
- Returns
- Returns The number of images completed capture in the job.
Definition at line 5238 of file capture.cpp.
◆ getJobState()
QString Ekos::Capture::getJobState | ( | int | id | ) |
DBUS interface function.
- Parameters
-
id job number. Job IDs start from 0 to N-1.
- Returns
- Returns the job state (Idle, In Progress, Error, Aborted, Complete)
Definition at line 5216 of file capture.cpp.
◆ getLimitSettings()
QJsonObject Ekos::Capture::getLimitSettings | ( | ) |
getLimitSettings Get Limit Settings
- Returns
- settings as JSON Object
Definition at line 6908 of file capture.cpp.
◆ getOverallRemainingTime()
int Ekos::Capture::getOverallRemainingTime | ( | ) |
DBUS interface function.
- Returns
- Returns overall time left in seconds until all jobs are estimated to be complete
Definition at line 5293 of file capture.cpp.
◆ getPendingJobCount()
int Ekos::Capture::getPendingJobCount | ( | ) |
DBUS interface function.
- Returns
- Returns the number of pending uncompleted jobs in the sequence queue.
Definition at line 5203 of file capture.cpp.
◆ getPresetSettings()
QJsonObject Ekos::Capture::getPresetSettings | ( | ) |
getSettings get current capture settings as a JSON Object
- Returns
- settings as JSON object
Definition at line 5067 of file capture.cpp.
◆ getProgressPercentage()
double Ekos::Capture::getProgressPercentage | ( | ) |
DBUS interface function.
- Returns
- Returns the percentage of completed captures in all active jobs
Definition at line 5172 of file capture.cpp.
◆ getSequence()
|
inline |
◆ getSequenceQueueStatus()
QString Ekos::Capture::getSequenceQueueStatus | ( | ) |
DBUS interface function.
Returns the overall sequence queue status. If there are no jobs pending, it returns "Invalid". If all jobs are idle, it returns "Idle". If all jobs are complete, it returns "Complete". If one or more jobs are aborted it returns "Aborted" unless it was temporarily aborted due to guiding deviations, then it would return "Suspended". If one or more jobs have errors, it returns "Error". If any jobs is under progress, returns "Running".
Definition at line 5344 of file capture.cpp.
◆ hasCoolerControl()
bool Ekos::Capture::hasCoolerControl | ( | ) |
DBUS interface function.
Does the CCD has a cooler control (On/Off) ?
Definition at line 5891 of file capture.cpp.
◆ ignoreSequenceHistory()
void Ekos::Capture::ignoreSequenceHistory | ( | ) |
DBUS interface function.
Jobs will NOT be checked for progress against the file system and will be always assumed as new jobs.
Definition at line 4963 of file capture.cpp.
◆ loadSequenceQueue()
bool Ekos::Capture::loadSequenceQueue | ( | const QString & | fileURL | ) |
DBUS interface function.
Loads the Ekos Sequence Queue file in the Sequence Queue. Jobs are appended to existing jobs.
- Parameters
-
fileURL full URL of the filename
Definition at line 4329 of file capture.cpp.
◆ moveJobDown
|
slot |
moveJobDown Move the job in the sequence queue one place down.
Definition at line 3353 of file capture.cpp.
◆ moveJobUp
|
slot |
moveJobUp Move the job in the sequence queue one place up.
Definition at line 3315 of file capture.cpp.
◆ prepareActiveJobStage1
|
slot |
prepareActiveJobStage1 Check for pre job script to execute.
If none, move to stage 2
Definition at line 3583 of file capture.cpp.
◆ prepareActiveJobStage2
|
slot |
prepareActiveJob Reset calibration state machine and prepare capture job actions.
Reset #calibrationStage and continue with preparePreCaptureActions().
Definition at line 3607 of file capture.cpp.
◆ preparePreCaptureActions
|
slot |
preparePreCaptureActions Check if we need to update filter position or CCD temperature before starting capture process
Trigger setting the filter, temperature, (if existing) the rotator angle and let the #activeJob execute the preparation actions before a capture may take place (.
- See also
- SequenceJob::prepareCapture()).
After triggering the settings, this method returns. This mechanism is slightly tricky, since it asynchronous and event based and works as collaboration between Capture and SequenceJob. Capture has the connection to devices and SequenceJob knows the target values.
Each time Capture receives an updated value - e.g. the current CCD temperature (
- See also
- updateCCDTemperature()) - it informs the #activeJob about the current CCD temperature. SequenceJob checks, if it has reached the target value and if yes, sets this action as as completed.
As soon as all actions are completed, SequenceJob emits a prepareComplete() event, which triggers executeJob() from the Capture module.
Definition at line 3659 of file capture.cpp.
◆ processCCDNumber
|
slot |
processCCDNumber Process number properties arriving from CCD.
Currently, only CCD and Guider frames are processed.
- Parameters
-
nvp pointer to number property.
Definition at line 1563 of file capture.cpp.
◆ processData
|
slot |
newFITS process new FITS data received from camera.
Update status of active job and overall sequence.
- Parameters
-
bp pointer to blob containing FITS data
Definition at line 1797 of file capture.cpp.
◆ processNewTargetName
|
slot |
processNewTargetName If mount slews to a new object, process it as it can be used for prefix
- Parameters
-
name new sky object under tracking.
Definition at line 4257 of file capture.cpp.
◆ processTelescopeNumber
|
slot |
processTelescopeNumber Process number properties arriving from telescope for meridian flip purposes.
- Parameters
-
nvp pointer to number property.
Definition at line 5399 of file capture.cpp.
◆ registerNewModule
|
slot |
registerNewModule Register an Ekos module as it arrives via DBus and create the appropriate DBus interface to communicate with it.
- Parameters
-
name of module
Definition at line 722 of file capture.cpp.
◆ removeJob
|
slot |
removeJob Remove a job sequence from the queue
- Parameters
-
index Row index for job to remove, if left as -1 (default), the currently selected row will be removed. if no row is selected, the last job shall be removed. true if sequence is removed. False otherwise.
Definition at line 3257 of file capture.cpp.
◆ saveSequenceQueue()
bool Ekos::Capture::saveSequenceQueue | ( | const QString & | path | ) |
DBUS interface function.
Saves the Sequence Queue to the Ekos Sequence Queue file.
- Parameters
-
fileURL full URL of the filename
Definition at line 4747 of file capture.cpp.
◆ setBinning
|
inlineslot |
◆ setCalibrationSettings()
void Ekos::Capture::setCalibrationSettings | ( | const QJsonObject & | settings | ) |
setCalibrationSettings Set Calibration settings
- Parameters
-
settings as JSON object
Definition at line 6826 of file capture.cpp.
◆ setCamera()
bool Ekos::Capture::setCamera | ( | const QString & | device | ) |
DBUS interface function.
select the CCD device from the available CCD drivers.
- Parameters
-
device The CCD device name
Definition at line 1014 of file capture.cpp.
◆ setCapturedFramesMap()
void Ekos::Capture::setCapturedFramesMap | ( | const QString & | signature, |
int | count | ||
) |
DBUS interface function.
Set count of already completed frames. This is required when we have identical external jobs with identical paths, but we need to continue where we left off. For example, if we have 3 identical jobs, each capturing 5 images. Let's suppose 9 images were captured before. If the count for this signature is set to 1, then we continue to capture frame #2 even though the number of completed images is already larger than required count (5). It is mostly used in conjunction with Ekos Scheduler.
Definition at line 6694 of file capture.cpp.
◆ setCoolerControl()
bool Ekos::Capture::setCoolerControl | ( | bool | enable | ) |
◆ setCount
|
inlineslot |
◆ setDelay
|
inlineslot |
◆ setExposure
|
inlineslot |
◆ setFileSettings()
void Ekos::Capture::setFileSettings | ( | const QJsonObject & | settings | ) |
setFileSettings Set File Settings
- Parameters
-
settings as JSON object
Definition at line 6788 of file capture.cpp.
◆ setFilter()
bool Ekos::Capture::setFilter | ( | const QString & | filter | ) |
DBUS interface function.
select the filter name from the available filters in case a filter device is active.
- Parameters
-
filter The filter name
Definition at line 1640 of file capture.cpp.
◆ setFilterWheel()
bool Ekos::Capture::setFilterWheel | ( | const QString & | device | ) |
DBUS interface function.
select the filter device from the available filter drivers. The filter device can be the same as the CCD driver if the filter functionality was embedded within the driver.
- Parameters
-
device The filter device name
Definition at line 1606 of file capture.cpp.
◆ setGuideDeviation
|
slot |
setGuideDeviation Set the guiding deviation as measured by the guiding module.
Slot that listens to guiding deviations reported by the Guide module.
Abort capture if deviation exceeds user value. Resume capture if capture was aborted and guiding deviations are below user value.
- Parameters
-
delta_ra Deviation in RA in arcsecs from the selected guide star. delta_dec Deviation in DEC in arcsecs from the selected guide star.
Depending on the current status, it triggers several actions:
- If there is no active job, it calls checkMeridianFlipReady(), which may initiate a meridian flip.
- If guiding has been started after a meridian flip and the deviation is within the expected limits, the meridian flip is regarded as completed by setMeridianFlipStage(MF_NONE) (
- See also
- setMeridianFlipStage()).
- If the deviation is beyond the defined limit, capturing is suspended (
- See also
- suspend()) and the #guideDeviationTimer is started.
- Otherwise, it checks if there has been a job suspended and restarts it, since guiding is within the limits.
Definition at line 3825 of file capture.cpp.
◆ setInSequenceFocus()
void Ekos::Capture::setInSequenceFocus | ( | bool | enable, |
double | HFR | ||
) |
DBUS interface function.
Enables or disables the in sequence focus and sets Half-Flux-Radius (HFR) limit.
- Parameters
-
enable If true, enable the in sequence auto focus check, otherwise, disable it. HFR if enable is true, it sets HFR in pixels. After each exposure, the HFR is re-measured and if it exceeds the specified value, an autofocus operation will be commanded.
Definition at line 5319 of file capture.cpp.
◆ setISO
|
inlineslot |
◆ setLimitSettings()
void Ekos::Capture::setLimitSettings | ( | const QJsonObject & | settings | ) |
setLimitSettings Set limit settings
- Parameters
-
settings as JSON Object
Definition at line 6864 of file capture.cpp.
◆ setMaximumGuidingDeviation()
void Ekos::Capture::setMaximumGuidingDeviation | ( | bool | enable, |
double | value | ||
) |
DBUS interface function.
Enables or disables the maximum guiding deviation and sets its value.
- Parameters
-
enable If true, enable the guiding deviation check, otherwise, disable it. value if enable is true, it sets the maximum guiding deviation in arcsecs. If the value is exceeded, the capture operation is aborted until the value falls below the value threshold.
Definition at line 5312 of file capture.cpp.
◆ setPrefix
|
inlineslot |
◆ setPresetSettings()
void Ekos::Capture::setPresetSettings | ( | const QJsonObject & | settings | ) |
setSettings Set capture settings
- Parameters
-
settings list of settings
Definition at line 6703 of file capture.cpp.
◆ setTargetTemperature
|
slot |
setTemperature Set the target CCD temperature in the GUI settings.
Definition at line 5326 of file capture.cpp.
◆ setVideoLimits()
bool Ekos::Capture::setVideoLimits | ( | uint16_t | maxBufferSize, |
uint16_t | maxPreviewFPS | ||
) |
setVideoLimits sets the buffer size and max preview fps for live preview
- Parameters
-
maxBufferSize in bytes maxPreviewFPS number of frames per second
- Returns
- True if value is updated, false otherwise.
Definition at line 6390 of file capture.cpp.
◆ showTemperatureRegulation
|
slot |
showTemperatureRegulation Toggle temperature regulation dialog which sets temperature ramp and threshold
Definition at line 7466 of file capture.cpp.
◆ startFocusIfRequired
|
slot |
Check, if re-focusing is required and initiate it in that case.
- Returns
- true iff re-focusing is necessary.
Definition at line 2329 of file capture.cpp.
◆ startFraming
|
slot |
startFraming Like captureOne but repeating.
Definition at line 2451 of file capture.cpp.
◆ syncDSLRToTargetChip()
void Ekos::Capture::syncDSLRToTargetChip | ( | const QString & | model | ) |
syncDSLRToTargetChip Syncs INDI driver CCD_INFO property to the DSLR values.
This include Max width, height, and pixel sizes.
- Parameters
-
model Name of camera driver in the DSLR database.
Definition at line 7377 of file capture.cpp.
◆ updateCCDTemperature
|
slot |
updateCCDTemperature Update CCD temperature in capture module.
- Parameters
-
value Temperature in celcius.
Definition at line 2945 of file capture.cpp.
◆ updateTargetDistance
|
slot |
Slot receiving the update of the current target distance.
- Parameters
-
targetDiff distance to the target in arcseconds.
Definition at line 2465 of file capture.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2022 The KDE developers.
Generated on Fri Aug 12 2022 04:01:02 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.