Kstars

Ekos DBus Interface - Align Module

Functions

Q_SCRIPTABLE Q_NOREPLY void Ekos::Align::abort ()
 
Q_SCRIPTABLE bool Ekos::Align::captureAndSolve (bool initialCall=true)
 
Q_SCRIPTABLE QList< double > Ekos::Align::getTargetCoords ()
 
Q_SCRIPTABLE bool Ekos::Align::loadAndSlew (QString fileURL=QString())
 
Q_SCRIPTABLE Q_NOREPLY void Ekos::Align::setBinningIndex (int binIndex)
 
Q_SCRIPTABLE Q_NOREPLY void Ekos::Align::setSolverMode (int mode)
 
void Ekos::Align::setTarget (const SkyPoint &targetCoord)
 
Q_SCRIPTABLE Q_NOREPLY void Ekos::Align::setTargetCoords (double ra0, double de0)
 
Q_SCRIPTABLE Q_NOREPLY void Ekos::Align::setTargetPositionAngle (double value)
 
void Ekos::Align::setTelescopeCoordinates (const SkyPoint &position)
 
void Ekos::Align::stop (Ekos::AlignState mode)
 
void Ekos::Align::suspend ()
 

Detailed Description

Ekos::Align interface provides advanced scripting capabilities to solve images using online or offline astrometry.net

Function Documentation

◆ abort()

Q_SCRIPTABLE Q_NOREPLY void Ekos::Align::abort ( )
inline

DBUS interface function.

Aborts the solving operation, handle outside of the align module.

Definition at line 399 of file align.h.

◆ captureAndSolve()

bool Ekos::Align::captureAndSolve ( bool initialCall = true)

DBUS interface function.

Capture and solve an image using the astrometry.net engine

Returns
Returns true if the procedure started successful, false otherwise (return true, not false, when retrying!)

Definition at line 1406 of file align.cpp.

◆ getTargetCoords()

QList< double > Ekos::Align::getTargetCoords ( )

getTargetCoords QList of target coordinates.

Returns
First value is J2000 RA in hours. Second value is J2000 DE in degrees.

Definition at line 3804 of file align.cpp.

◆ loadAndSlew()

bool Ekos::Align::loadAndSlew ( QString fileURL = QString())

DBUS interface function.

Loads an image (FITS, RAW, or JPG/PNG) and solve its coordinates, then it slews to the solved coordinates and an image is captured and solved to ensure the telescope is pointing to the same coordinates of the image.

Parameters
fileURLURL to the image to solve

Definition at line 3019 of file align.cpp.

◆ setBinningIndex()

void Ekos::Align::setBinningIndex ( int binIndex)

DBUS interface function.

Sets the binning of the selected CCD device.

Parameters
binIndexIndex of binning value. Default values range from 0 (binning 1x1) to 3 (binning 4x4)

Definition at line 3094 of file align.cpp.

◆ setSolverMode()

void Ekos::Align::setSolverMode ( int mode)

DBUS interface function.

Select the solver mode

Parameters
typeSet solver type. 0 LOCAL, 1 REMOTE (requires remote astrometry driver to be activated)

Definition at line 551 of file align.cpp.

◆ setTarget()

void Ekos::Align::setTarget ( const SkyPoint & targetCoord)

Set the alignment target where the mount is expected to point at.

Parameters
targetCoordexact coordinates of the target position.

Definition at line 3797 of file align.cpp.

◆ setTargetCoords()

void Ekos::Align::setTargetCoords ( double ra0,
double de0 )

DBUS interface function.

Sets the target coordinates that the solver compares the solution coordinates to. By default, the target coordinates are those of the current mount when the capture and solve operation is started. In case of SYNC, only the error between the solution and target coordinates is calculated. When Slew to Target is selected, the mount would be slewed afterwards to this target coordinate.

Parameters
ra0J2000 Right Ascension in hours.
de0J2000 Declination in degrees.

Definition at line 3788 of file align.cpp.

◆ setTargetPositionAngle()

void Ekos::Align::setTargetPositionAngle ( double value)

Definition at line 3809 of file align.cpp.

◆ setTelescopeCoordinates()

void Ekos::Align::setTelescopeCoordinates ( const SkyPoint & position)
inline

Set the coordinates that the mount reports as its position.

Parameters
positioncurrent mount position

Definition at line 459 of file align.h.

◆ stop()

void Ekos::Align::stop ( Ekos::AlignState mode)

Stop aligning.

Parameters
modestop mode (abort or suspend)

Definition at line 2497 of file align.cpp.

◆ suspend()

void Ekos::Align::suspend ( )
inline

Suspend aligning, recovery handled by the align module itself.

Definition at line 407 of file align.h.

This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sun Feb 25 2024 18:45:36 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.