Kstars

Functions
Q_SCRIPTABLE QString	Ekos::Capture::camera ()

Q_SCRIPTABLE Q_NOREPLY void	Ekos::Capture::clearAutoFocusHFR ()

Q_SCRIPTABLE Q_NOREPLY void	Ekos::Capture::clearSequenceQueue ()

Q_SCRIPTABLE QString	Ekos::Capture::filter ()

Q_SCRIPTABLE QString	Ekos::Capture::filterWheel ()

Q_SCRIPTABLE int	Ekos::Capture::getActiveJobID ()

Q_SCRIPTABLE int	Ekos::Capture::getActiveJobRemainingTime ()

Q_SCRIPTABLE int	Ekos::Capture::getJobCount ()

Q_SCRIPTABLE double	Ekos::Capture::getJobExposureDuration (int id)

Q_SCRIPTABLE double	Ekos::Capture::getJobExposureProgress (int id)

Q_SCRIPTABLE QString	Ekos::Capture::getJobFilterName (int id)

Q_SCRIPTABLE CCDFrameType	Ekos::Capture::getJobFrameType (int id)

Q_SCRIPTABLE int	Ekos::Capture::getJobImageCount (int id)

Q_SCRIPTABLE int	Ekos::Capture::getJobImageProgress (int id)

Q_SCRIPTABLE QString	Ekos::Capture::getJobState (int id)

Q_SCRIPTABLE QString	Ekos::Capture::getLogText ()

Q_SCRIPTABLE int	Ekos::Capture::getOverallRemainingTime ()

Q_SCRIPTABLE int	Ekos::Capture::getPendingJobCount ()

Q_SCRIPTABLE double	Ekos::Capture::getProgressPercentage ()

Q_SCRIPTABLE QString	Ekos::Capture::getSequenceQueueStatus ()

Q_SCRIPTABLE bool	Ekos::Capture::hasCoolerControl ()

Q_SCRIPTABLE Q_NOREPLY void	Ekos::Capture::ignoreSequenceHistory ()

Q_SCRIPTABLE bool	Ekos::Capture::loadSequenceQueue (const QString &fileURL, bool ignoreTarget=false)

Q_SCRIPTABLE QStringList	Ekos::Capture::logText ()

Q_SCRIPTABLE bool	Ekos::Capture::saveSequenceQueue (const QString &path)

Q_SCRIPTABLE Q_NOREPLY void	Ekos::Capture::setCapturedFramesMap (const QString &signature, int count)

Q_SCRIPTABLE bool	Ekos::Capture::setCoolerControl (bool enable)

Q_SCRIPTABLE bool	Ekos::Capture::setFilter (const QString &filter)

Q_SCRIPTABLE Q_NOREPLY void	Ekos::Capture::setInSequenceFocus (bool enable, double HFR)

Q_SCRIPTABLE Q_NOREPLY void	Ekos::Capture::setMaximumGuidingDeviation (bool enable, double value)

Q_SCRIPTABLE CaptureState	Ekos::Capture::status ()

Public Slots
Q_SCRIPTABLE Q_NOREPLY void	Ekos::Capture::abort ()

Q_SCRIPTABLE QString	Ekos::Capture::getTargetName ()

Q_SCRIPTABLE Q_NOREPLY void	Ekos::Capture::pause ()

Q_SCRIPTABLE Q_NOREPLY void	Ekos::Capture::restartCamera (const QString &name)

Q_SCRIPTABLE Q_NOREPLY void	Ekos::Capture::setTargetName (const QString &newTargetName)

Q_SCRIPTABLE Q_NOREPLY void	Ekos::Capture::start ()

Q_SCRIPTABLE Q_NOREPLY void	Ekos::Capture::stop (CaptureState targetState=CAPTURE_IDLE)

Q_SCRIPTABLE Q_NOREPLY void	Ekos::Capture::suspend ()

Q_SCRIPTABLE Q_NOREPLY void	Ekos::Capture::toggleSequence ()

Q_SCRIPTABLE Q_NOREPLY void	Ekos::Capture::toggleVideo (bool enabled)

Detailed Description

Ekos::Capture interface provides advanced scripting capabilities to capture image sequences.

Function Documentation

◆ camera()

Q_SCRIPTABLE QString Ekos::Capture::camera ( )

DBUS interface function.

select the CCD device from the available CCD drivers.

Parameters

device The CCD device name

◆ 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 4981 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 4695 of file capture.cpp.

◆ filterWheel()

Q_SCRIPTABLE QString Ekos::Capture::filterWheel ( )

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

◆ 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 4556 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 4671 of file capture.cpp.

◆ getJobCount()

Q_SCRIPTABLE int Ekos::Capture::getJobCount ( )

inline

DBUS interface function.

Returns: Returns the number of jobs in the sequence queue.

Definition at line 195 of file capture.h.

◆ 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 4638 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 4627 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 4594 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 4649 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 4616 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 4605 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 4583 of file capture.cpp.

◆ getLogText()

Q_SCRIPTABLE QString Ekos::Capture::getLogText ( )

inline

DBUS interface function.

Single text string holding all log lines for the capture module.

Definition at line 293 of file capture.h.

◆ 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 4660 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 4570 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 4539 of file capture.cpp.

◆ 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 4708 of file capture.cpp.

◆ hasCoolerControl()

bool Ekos::Capture::hasCoolerControl ( )

DBUS interface function.

Does the CCD has a cooler control (On/Off) ?

Definition at line 4965 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 4337 of file capture.cpp.

◆ loadSequenceQueue()

bool Ekos::Capture::loadSequenceQueue	(	const QString &	fileURL,
		bool	ignoreTarget = `false`
	)

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
ignoreTarget	ignore target defined in the sequence queue file (necessary for using the target of the scheduler)

Definition at line 3682 of file capture.cpp.

◆ logText()

Q_SCRIPTABLE QStringList Ekos::Capture::logText ( )

inline

DBUS interface function.

List of logging entries for the capture module.

Definition at line 285 of file capture.h.

◆ 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 4120 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 5718 of file capture.cpp.

◆ setCoolerControl()

bool Ekos::Capture::setCoolerControl ( bool enable )

DBUS interface function.

Set the CCD cooler ON/OFF

Definition at line 4973 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 1707 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 4686 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 4679 of file capture.cpp.

◆ status()

Q_SCRIPTABLE CaptureState Ekos::Capture::status ( )

inline

DBUS interface function.

Status of the capture module

Definition at line 301 of file capture.h.

Public Slots

◆ abort

Q_SCRIPTABLE Q_NOREPLY void Ekos::Capture::abort ( )

inlineslot

DBUS interface function.

Aborts all jobs and mark current state as ABORTED. It simply calls stop(CAPTURE_ABORTED)

Definition at line 548 of file capture.h.

◆ pause

void Ekos::Capture::pause ( )

slot

DBUS interface function.

pause Pauses the Sequence Queue progress AFTER the current capture is complete.

Definition at line 778 of file capture.cpp.

◆ restartCamera

void Ekos::Capture::restartCamera ( const QString & name )

slot

DBus interface function.

restartCamera Restarts the INDI driver associated with a camera. Remote and Local drivers are supported.

Parameters

name	Name of camera to restart. If a driver defined multiple cameras, they would be removed and added again after driver restart.

Note: Restarting camera should only be used as a last resort when it comes completely unresponsive. Due the complex nature of driver interactions with Ekos, restarting cameras can lead to unexpected behavior.

Definition at line 6299 of file capture.cpp.

◆ setTargetName

void Ekos::Capture::setTargetName ( const QString & newTargetName )

slot

DBus interface function.

Set the name of the target to be captured.

Definition at line 3623 of file capture.cpp.

◆ start

void Ekos::Capture::start ( )

slot

DBUS interface function.

Start the execution of the Capture::SequenceJob list #jobs.

Starting the execution of the Capture::SequenceJob list selects the first job from the ist that may be executed and starts to prepare the job (

See also: prepareJob()).

Several factors determine, which of the jobs will be selected:

First, the list is searched to find the first job that is marked as idle or aborted.
If none is found, it is checked whether ignoring job progress is set. If yes, all jobs are are reset (
See also
reset()) and the first one from the list is selected. If no, the user is asked whether the jobs should be reset. If the user declines, starting is aborted.

Definition at line 851 of file capture.cpp.

◆ stop

void Ekos::Capture::stop ( CaptureState targetState = CAPTURE_IDLE )

slot

DBUS interface function.

Stop, suspend or abort the currently active job.

Stops currently running jobs: CAPTURE_IDLE: capture in idle state waiting for further action (e.g. single sequence is complete, next one starting) CAPTURE_COMPLETE: all capture sequences are complete CAPTURE_ABORT: capture aborted either by user interaction or by a technical error CAPTURE_SUSPEND: capture suspended and waiting to be restarted

Parameters

targetState	status of the job after stop
targetState

Definition at line 968 of file capture.cpp.

◆ suspend

Q_SCRIPTABLE Q_NOREPLY void Ekos::Capture::suspend ( )

inlineslot

DBUS interface function.

Aborts all jobs and mark current state as SUSPENDED. It simply calls stop(CAPTURE_SUSPENDED) The only difference between SUSPENDED and ABORTED it that capture module can automatically resume a suspended state on its own without external trigger once the right conditions are met. When whatever reason caused the module to go into suspended state ceases to exist, the capture module automatically resumes. On the other hand, ABORTED state must be started via an external programmatic or user trigger (e.g. click the start button again).

Definition at line 560 of file capture.h.

◆ toggleSequence

void Ekos::Capture::toggleSequence ( )

slot

DBUS interface function.

toggleSequence Toggle sequence state depending on its current state.

If paused, then resume sequence.
If idle or completed, then start sequence.
Otherwise, abort current sequence.

Definition at line 799 of file capture.cpp.

◆ toggleVideo

void Ekos::Capture::toggleVideo ( bool enabled )

slot

DBUS interface function.

Toggle video streaming if supported by the device.

Parameters

enabled Set to true to start video streaming, false to stop it if active.

Definition at line 5396 of file capture.cpp.

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Kstars

Kstars

Functions

Public Slots

Detailed Description

Function Documentation

◆ camera()

◆ clearAutoFocusHFR()

◆ clearSequenceQueue()

◆ filterWheel()

◆ getActiveJobID()

◆ getActiveJobRemainingTime()

◆ getJobCount()

◆ getJobExposureDuration()

◆ getJobExposureProgress()

◆ getJobFilterName()

◆ getJobFrameType()

◆ getJobImageCount()

◆ getJobImageProgress()

◆ getJobState()

◆ getLogText()

◆ getOverallRemainingTime()

◆ getPendingJobCount()

◆ getProgressPercentage()

◆ getSequenceQueueStatus()

◆ hasCoolerControl()

◆ ignoreSequenceHistory()

◆ loadSequenceQueue()

◆ logText()

◆ saveSequenceQueue()

◆ setCapturedFramesMap()

◆ setCoolerControl()

◆ setFilter()

◆ setInSequenceFocus()

◆ setMaximumGuidingDeviation()

◆ status()

Public Slots

◆ abort

◆ pause

◆ restartCamera

◆ setTargetName

◆ start

◆ stop

◆ suspend

◆ toggleSequence

◆ toggleVideo