Kstars

Ekos DBus Interface - Focus Module

Public Slots

Q_SCRIPTABLE Q_NOREPLY void Ekos::Focus::abort ()
 
Q_SCRIPTABLE Q_NOREPLY void Ekos::Focus::capture (double settleTime=0.0)
 
Q_SCRIPTABLE Q_NOREPLY void Ekos::Focus::checkFocus (double requiredHFR)
 
Q_SCRIPTABLE bool Ekos::Focus::focusIn (int ms=-1)
 
Q_SCRIPTABLE bool Ekos::Focus::focusOut (int ms=-1)
 
Q_SCRIPTABLE Q_NOREPLY void Ekos::Focus::runAutoFocus (bool buildOffsets)
 
Q_SCRIPTABLE Q_NOREPLY void Ekos::Focus::start ()
 

Detailed Description

Ekos::Focus interface provides advanced scripting capabilities to perform manual and automatic focusing operations.

Public Slots

◆ abort

void Ekos::Focus::abort ( )
slot

DBUS interface function.

Abort the autofocus operation.

Definition at line 1382 of file focus.cpp.

◆ capture

void Ekos::Focus::capture ( double settleTime = 0.0)
slot

DBUS interface function.

Capture a focus frame.

Parameters
settleTimeif > 0 wait for the given time in seconds before starting to capture

Definition at line 1461 of file focus.cpp.

◆ checkFocus

void Ekos::Focus::checkFocus ( double requiredHFR)
slot

checkFocus Given the minimum required HFR, check focus and calculate HFR.

If current HFR exceeds required HFR, start autofocus process, otherwise do nothing.

Parameters
requiredHFRMinimum HFR to trigger autofocus process.

Definition at line 4542 of file focus.cpp.

◆ focusIn

bool Ekos::Focus::focusIn ( int ms = -1)
slot

DBUS interface function.

Focus inward

Parameters
msIf set, focus inward for ms ticks (Absolute Focuser), or ms milliseconds (Relative Focuser). If not set, it will use the value specified in the options.

Definition at line 1627 of file focus.cpp.

◆ focusOut

bool Ekos::Focus::focusOut ( int ms = -1)
slot

DBUS interface function.

Focus outward

Parameters
msIf set, focus outward for ms ticks (Absolute Focuser), or ms milliseconds (Relative Focuser). If not set, it will use the value specified in the options.

Definition at line 1647 of file focus.cpp.

◆ runAutoFocus

void Ekos::Focus::runAutoFocus ( bool buildOffsets)
slot

runAutoFocus Run the autofocus process for the currently selected filter

Parameters
policyis the filter policy to use.

Definition at line 4559 of file focus.cpp.

◆ start

void Ekos::Focus::start ( )
slot

DBUS interface function.

Start the autofocus operation.

Definition at line 998 of file focus.cpp.

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.