Ekos DBus Interface - Capture Module

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 int	Ekos::Capture::getJobImageCount (int id)
Q_SCRIPTABLE int	Ekos::Capture::getJobImageProgress (int id)
Q_SCRIPTABLE QString	Ekos::Capture::getJobState (int id)
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)
Q_SCRIPTABLE QStringList	Ekos::Capture::logText ()
Q_SCRIPTABLE bool	Ekos::Capture::setCamera (const QString &device)
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 bool	Ekos::Capture::setFilterWheel (const QString &device)
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 Ekos::CaptureState	Ekos::Capture::status ()

Public Slots
Q_SCRIPTABLE Q_NOREPLY void	Ekos::Capture::abort ()
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::toggleVideo (bool enabled)

Detailed Description

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

Function Documentation

Q_SCRIPTABLE QString Ekos::Capture::camera

(

)

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

void Ekos::Capture::clearSequenceQueue

(

)

DBUS interface function.

Aborts any current jobs and remove all sequence queue jobs.

Definition at line 4304 of file capture.cpp.

Q_SCRIPTABLE QString Ekos::Capture::filter

(

)

Q_SCRIPTABLE QString Ekos::Capture::filterWheel

(

)

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

int Ekos::Capture::getActiveJobRemainingTime

(

)

DBUS interface function.

Returns

Returns time left in seconds until active job is estimated to be complete.

Definition at line 4277 of file capture.cpp.

Q_SCRIPTABLE int Ekos::Capture::getJobCount ( )

inline

DBUS interface function.

Returns

Returns the number of jobs in the sequence queue.

Definition at line 197 of file capture.h.

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

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

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

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

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

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

int Ekos::Capture::getPendingJobCount

(

)

DBUS interface function.

Returns

Returns the number of pending uncompleted jobs in the sequence queue.

Definition at line 4186 of file capture.cpp.

double Ekos::Capture::getProgressPercentage

(

)

DBUS interface function.

Returns

Returns the percentage of completed captures in all active jobs

Definition at line 4155 of file capture.cpp.

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

bool Ekos::Capture::hasCoolerControl

(

)

DBUS interface function.

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

Definition at line 4764 of file capture.cpp.

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

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

Q_SCRIPTABLE QStringList Ekos::Capture::logText ( )

inline

Definition at line 271 of file capture.h.

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

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

bool Ekos::Capture::setCoolerControl

(

bool

enable

)

DBUS interface function.

Set the CCD cooler ON/OFF

Definition at line 4772 of file capture.cpp.

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

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

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

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

Q_SCRIPTABLE Ekos::CaptureState Ekos::Capture::status ( )

inline

Definition at line 276 of file capture.h.

Public Slots

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 367 of file capture.h.

void Ekos::Capture::start ( )

slot

DBUS interface function.

Starts the sequence queue capture procedure sequentially by starting all jobs that are either Idle or Aborted in order.

Definition at line 451 of file capture.cpp.

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

slot

DBUS interface function.

Stop all jobs and set current job status to aborted if abort is set to true, otherwise status is idle until sequence is resumed or restarted.

Parameters

targetState

status of the job after abortion

Definition at line 552 of file capture.cpp.

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 379 of file capture.h.

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