Kstars
capture.h
37 * It is based on a modular extensible framework to perform common astrophotography tasks. This includes highly accurate GOTOs using astrometry solver, ability to measure and correct polar alignment errors ,
38 * auto-focus & auto-guide capabilities, and capture of single or stack of images with filter wheel support.\n
40 * - Control your telescope, CCD (& DSLRs), filter wheel, focuser, guider, adaptive optics unit, and any INDI-compatible auxiliary device from Ekos.
41 * - Extremely accurate GOTOs using astrometry.net solver (both Online and Offline solvers supported).
42 * - Load & Slew: Load a FITS image, slew to solved coordinates, and center the mount on the exact image coordinates in order to get the same desired frame.
45 * - Automated unattended meridian flip. Ekos performs post meridian flip alignment, calibration, and guiding to resume the capture session.
48 * - Auto guiding with support for automatic dithering between exposures and support for Adaptive Optics devices in addition to traditional guiders.
49 * - Powerful sequence queue for batch capture of images with optional prefixes, timestamps, filter wheel selection, and much more!
51 * - Center the telescope anywhere in a captured FITS image or any FITS with World Coordinate System (WCS) header.
53 * - Automatic abort and resumption of exposure tasks if guiding errors exceed a user-configurable value.
59 * The primary class is Ekos::Manager. It handles startup and shutdown of local and remote INDI devices, manages and orchesterates the various Ekos modules, and provides advanced DBus
79 * sequence autofocusing by setting limits for HFR, execution time or temperature delta. When the limit
81 * linked with guide module. If guiding deviations exceed a certain threshold, the capture operation aborts until
132 * 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.
150 * 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
151 * 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".
161 * @param targetName override the target in the sequence queue file (necessary for using the target of the scheduler)
174 * @param 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.
181 * @param 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.
308 * Clear in-sequence focus settings. It sets the autofocus HFR to zero so that next autofocus value is remembered for the in-sequence focusing.
313 * Jobs will NOT be checked for progress against the file system and will be always assumed as new jobs.
319 * with identical paths, but we need to continue where we left off. For example, if we have 3 identical
320 * jobs, each capturing 5 images. Let's suppose 9 images were captured before. If the count for this signature
321 * is set to 1, then we continue to capture frame #2 even though the number of completed images is already
526 * @brief addDSLRInfo Save DSLR Info the in the database. If the interactive dialog was open, close it.
533 void addDSLRInfo(const QString &model, uint32_t maxW, uint32_t maxH, double pixelW, double pixelH);
584 * The only difference between SUSPENDED and ABORTED it that capture module can automatically resume a suspended
585 * state on its own without external trigger once the right conditions are met. When whatever reason caused the module
586 * to go into suspended state ceases to exist, the capture module automatically resumes. On the other hand, ABORTED state
587 * must be started via an external programmatic or user trigger (e.g. click the start button again).
615 * @brief restartCamera Restarts the INDI driver associated with a camera. Remote and Local drivers are supported.
616 * @param name Name of camera to restart. If a driver defined multiple cameras, they would be removed and added again
680 * @brief addJob Add a new job to the UI. This is used when a job is loaded from a capture sequence file. In
681 * contrast to {@see #createJob()}, the job's attributes are taken from the file and only the UI gehts updated.
691 SequenceJob *createJob(SequenceJob::SequenceJobType jobtype = SequenceJob::JOBTYPE_BATCH, FilenamePreviewType filenamePreview = NOT_PREVIEW);
734 * @brief processCCDNumber Process number properties arriving from CCD. Currently, only CCD and Guider frames are processed.
742 * @param index Row index for job to remove, if left as -1 (default), the currently selected row will be removed.
787 * @brief showTemperatureRegulation Toggle temperature regulation dialog which sets temperature ramp and threshold
811 * @brief setGuideDeviation Set the guiding deviation as measured by the guiding module. Abort capture
Q_OBJECTQ_OBJECT
const QJsonArray & getSequence() const
getSequence Return the JSON representation of the current sequeue queue
Definition: capture.h:456
void setTargetTemperature(double temperature)
setTemperature Set the target CCD temperature in the GUI settings.
Definition: capture.h:771
Q_PROPERTY(...)
void updateJobFromUI(SequenceJob *job, FilenamePreviewType filenamePreview=NOT_PREVIEW)
updateJobFromUI Update all job attributes from the UI settings.
Definition: capture.cpp:3255
void processCameraNumber(INDI::Property prop)
processCCDNumber Process number properties arriving from CCD.
Definition: capture.cpp:1225
Q_SCRIPTABLE Q_NOREPLY void ignoreSequenceHistory()
DBUS interface function.
Definition: capture.cpp:2094
Ekos is an advanced Astrophotography tool for Linux. It is based on a modular extensible framework to...
Definition: align.cpp:76
void generateDarkFlats()
generateDarkFlats Generate a list of dark flat jobs from available flat frames.
Definition: capture.cpp:3232
Q_SCRIPTABLE Q_NOREPLY void stop(CaptureState targetState=CAPTURE_IDLE)
DBUS interface function.
Definition: capture.cpp:3556
Q_CLASSINFO(Name, Value)
void setDelay(uint16_t delay)
setDelay Set delay between capturing images within a sequence in seconds
Definition: capture.h:717
Definition: indicamerachip.h:22
void captureRunning()
captureStarted Manage the result when capturing has been started
Definition: capture.cpp:1456
void updateStartButtons(bool start, bool pause=false)
updateStartButtons Update the start and the pause button to new states of capturing
Definition: capture.cpp:3214
QSharedPointer< MeridianFlipState > getMeridianFlipState()
MeridianFlipState Access to the meridian flip state machine.
Definition: capture.h:751
void editJobFinished()
jobEditFinished Editing of an existing job finished, update its attributes from the UI settings.
Definition: capture.cpp:1620
void updateCCDTemperature(double value)
updateCCDTemperature Update CCD temperature in capture module.
Definition: capture.cpp:1505
Q_SCRIPTABLE Q_NOREPLY void setCapturedFramesMap(const QString &signature, int count)
DBUS interface function.
Definition: capture.h:324
Q_SCRIPTABLE Q_NOREPLY void setInSequenceFocus(bool enable, double HFR)
DBUS interface function.
Definition: capture.cpp:2325
QPointer< CaptureProcess > process() const
process shortcut for the process engine
Definition: capture.h:646
Q_SCRIPTABLE Q_NOREPLY void toggleVideo(bool enabled)
DBUS interface function.
Definition: capture.cpp:3561
Q_SCRIPTABLE bool setFilter(const QString &filter)
DBUS interface function.
Definition: capture.cpp:1288
Q_SCRIPTABLE Q_NOREPLY void setMaximumGuidingDeviation(bool enable, double value)
DBUS interface function.
Definition: capture.cpp:2318
void jobStarting()
captureStarted Change the UI after the capturing process has been started.
Definition: capture.cpp:686
Q_SCRIPTABLE Q_NOREPLY void clearSequenceQueue()
DBUS interface function.
Definition: capture.cpp:2332
The QProgressIndicator class lets an application display a progress indicator to show that a long tas...
Definition: QProgressIndicator.h:23
void showTemperatureRegulation()
showTemperatureRegulation Toggle temperature regulation dialog which sets temperature ramp and thresh...
Definition: capture.cpp:3157
Q_SCRIPTABLE Q_NOREPLY void restartCamera(const QString &name)
DBus interface function.
Definition: capture.cpp:3595
SequenceJob * createJob(SequenceJob::SequenceJobType jobtype=SequenceJob::JOBTYPE_BATCH, FilenamePreviewType filenamePreview=NOT_PREVIEW)
createJob Create a new job with the settings given in the GUI.
Definition: capture.cpp:1537
QJsonObject getCalibrationSettings()
getCalibrationSettings Get Calibration settings
Definition: capture.h:497
Q_SCRIPTABLE Q_NOREPLY void setObserverName(const QString &value)
DBus interface function.
Definition: capture.h:631
Sequence Job is a container for the details required to capture a series of images.
Definition: sequencejob.h:16
void setCount(uint16_t count)
seqCount Set required number of images to capture in one sequence job
Definition: capture.h:708
void setLimitSettings(const QJsonObject &settings)
setLimitSettings Set limit settings
Definition: capture.cpp:2835
void setFocusTemperatureDelta(double focusTemperatureDelta, double absTemperature)
updateAdaptiveFocusStatus Handle new focus state
Definition: capture.cpp:1837
Definition: indicamera.h:46
void removeDevice(const QSharedPointer< ISD::GenericDevice > &device)
Generic method for removing any connected device.
Definition: capture.cpp:3546
QJsonObject getPresetSettings()
getSettings get current capture settings as a JSON Object
Definition: capture.cpp:2214
void setHFR(double newHFR, int)
setHFR Receive the measured HFR value of the latest frame
Definition: capture.cpp:3620
QString join(const QString &separator) const const
enabled
void setPresetSettings(const QJsonObject &settings)
setSettings Set capture settings
Definition: capture.cpp:2740
bool setVideoLimits(uint16_t maxBufferSize, uint16_t maxPreviewFPS)
setVideoLimits sets the buffer size and max preview fps for live preview
Definition: capture.cpp:2469
Captures single or sequence of images from a CCD. The capture class support capturing single or multi...
Definition: capture.h:94
void updateCurrentFilterPosition()
shortcut for updating the current filter information for the state machine
Definition: capture.cpp:1304
void newTargetName(const QString &name)
updateTargetName React upon a new capture target name
Definition: capture.cpp:1755
void refreshCameraSettings()
checkCamera Refreshes the CCD information in the capture module.
Definition: capture.cpp:715
Q_SCRIPTABLE Q_NOREPLY void setTargetName(const QString &newTargetName)
DBus interface function.
Definition: capture.cpp:3566
void updateTargetDistance(double targetDiff)
Slot receiving the update of the current target distance.
Definition: capture.cpp:1404
void registerNewModule(const QString &name)
registerNewModule Register an Ekos module as it arrives via DBus and create the appropriate DBus inte...
Definition: capture.cpp:696
Definition: indidome.h:22
void setFileSettings(const QJsonObject &settings)
setFileSettings Set File Settings
Definition: capture.cpp:2803
void setFocusStatus(FocusState newstate)
setFocusStatus Forward the new focus state to the capture module state machine
Definition: capture.cpp:1855
void refreshFilterSettings()
checkFilter Refreshes the filter wheel information in the capture module.
Definition: capture.cpp:1312
void setCalibrationSettings(const QJsonObject &settings)
setCalibrationSettings Set Calibration settings
Definition: capture.h:488
bool removeJob(int index=-1)
removeJob Remove a job sequence from the queue
Definition: capture.cpp:1660
void focusAdaptiveComplete(bool success)
focusAdaptiveComplete Forward the new focus state to the capture module state machine
Definition: capture.h:842
void moveJob(bool up)
moveJobUp Move the job in the sequence queue one place up or down.
Definition: capture.cpp:1720
void addDSLRInfo(const QString &model, uint32_t maxW, uint32_t maxH, double pixelW, double pixelH)
addDSLRInfo Save DSLR Info the in the database.
Definition: capture.cpp:2680
void setGuideDeviation(double delta_ra, double delta_dec)
setGuideDeviation Set the guiding deviation as measured by the guiding module.
Definition: capture.cpp:1846
void updateFocusStatus(FocusState newstate)
updateFocusStatus Handle new focus state
Definition: capture.cpp:1861
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sat Dec 9 2023 04:04:46 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sat Dec 9 2023 04:04:46 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.