[education/kstars] doc: Add profile scripts editor section and mosaic planner section
Jasem Mutlaq
null at kde.org
Wed Jul 27 18:59:05 BST 2022
Git commit 25acbb39ed14a8676961e79ba2836c870d2b9650 by Jasem Mutlaq.
Committed on 27/07/2022 at 17:58.
Pushed by mutlaqja into branch 'master'.
Add profile scripts editor section and mosaic planner section
M +25 -2 doc/ekos-profile-editor.docbook
M +60 -37 doc/ekos-scheduler.docbook
A +- -- doc/mosaic_adjust_grid.png
A +- -- doc/mosaic_close_pole.png
A +- -- doc/mosaic_confirm_equipment.png
A +- -- doc/mosaic_create_jobs.png
A +- -- doc/mosaic_planner.png
A +- -- doc/mosaic_select_grid.png
M +- -- doc/mosaic_wizard.png
M +- -- doc/profile_editor.png
A +- -- doc/profile_editor_scripts.png
https://invent.kde.org/education/kstars/commit/25acbb39ed14a8676961e79ba2836c870d2b9650
diff --git a/doc/ekos-profile-editor.docbook b/doc/ekos-profile-editor.docbook
index e88bf327d..070fca1da 100644
--- a/doc/ekos-profile-editor.docbook
+++ b/doc/ekos-profile-editor.docbook
@@ -36,6 +36,11 @@
<guilabel>Auto Connect</guilabel>: Check this option to enable automatic connection to all your devices after INDI server is started. If unchecked, INDI devices are created but not automatically connected. This is useful when you want to make changes to the driver (⪚ change baud rate or IP address or any other settings) <emphasis>before</emphasis> you connect to it.
</para>
</listitem>
+ <listitem>
+ <para>
+ <guilabel>Port Selector</guilabel>: Check this option to enable Port Selector. When creating a new profile, it is checked by default. Port Selector is used to select initial serial and network communication parameters for the devices in the equipment profile. After connecting to equipment for the first time, the Port Selector popup is displayed where the communication parameters can be set before establishing connection. Once connected, the Port Selector option is turned off. it can be toggled to checked in the profile editor to enable it back.
+ </para>
+ </listitem>
<listitem>
<para>
<guilabel>Site Info</guilabel>: Optionally, you can check the <guilabel>Site Info</guilabel> checkbox and Ekos will load the <emphasis role="bold">current</emphasis> city and timezone whenever is Ekos is started with this profile. This can be useful when connecting to the remote geographic site so that Ekos is in sync location and time wise.
@@ -56,9 +61,27 @@
<guilabel>Device Selection</guilabel>: Select your devices from each category. Please note that if you have a CCD with a guide head, you can leave the guider drop-down menu <emphasis>blank</emphasis> as Ekos will auto-detect the guide head from the CCD camera. Similarly, if your CCD includes embedded filter wheel support, then you do <emphasis>not</emphasis> need to specify the filter wheel device in the filter drop-down menu.
</para>
</listitem>
+ <listitem>
+ <para>
+ <guilabel>Scripts</guilabel>: Adjust pre-driver and post-driver delays and scripts for each driver. A rule can be defined for each driver in case there is a need to introduce delays before and/or after starting a particular driver. The fields before the driver selection dropdown are to be executed <emphasis>before</emphasis> the driver is started, whereas the fields after the driver selection dropdown are to be executed <emphasis>after</emphasis> the driver started. The script field, if specified, should include the full path to an executable script with the appropiate permissions. All drivers configured in the scripts editor would be started first and in order before the rest of the equipment profile drivers.
+ </para>
+ <screenshot>
+ <screeninfo>
+ Profile Editor Scripts
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="profile_editor_scripts.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Profile Editor Scripts</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </listitem>
</itemizedlist>
</listitem>
- </varlistentry>
+ </varlistentry>
<varlistentry>
<term>Start & Stop INDI</term>
<listitem>
@@ -78,5 +101,5 @@
</para>
</listitem>
</varlistentry>
- </variablelist>
+ </variablelist>
</sect2>
diff --git a/doc/ekos-scheduler.docbook b/doc/ekos-scheduler.docbook
index dde3555e2..64ece164f 100644
--- a/doc/ekos-scheduler.docbook
+++ b/doc/ekos-scheduler.docbook
@@ -292,18 +292,18 @@ exit(0)
</para>
</sect3>
- <sect3 id="ekos-scheduler-mosaic-wizard">
- <title>Mosaic Wizard</title>
+ <sect3 id="ekos-scheduler-mosaic-Planner">
+ <title>Mosaic Planner</title>
<screenshot>
<screeninfo>
- Mosaic Wizard
+ Mosaic Planner
</screeninfo>
<mediaobject>
<imageobject>
- <imagedata fileref="mosaic_wizard.png" format="PNG"/>
+ <imagedata fileref="mosaic_planner.png" format="PNG"/>
</imageobject>
<textobject>
- <phrase>Mosaic Wizard</phrase>
+ <phrase>Mosaic Planner</phrase>
</textobject>
</mediaobject>
</screenshot>
@@ -329,80 +329,103 @@ exit(0)
The 2nd step is handled by image processing applications such as <ulink url="https://pixinsight.com">PixInsight</ulink>, among others, and will not be the topic of discussion here. The first step can be accomplished in Ekos Scheduler where it creates a mosaic suitable for your equipment and in accordance with the desired field of view. Not only Ekos creates the mosaic panels for your target, but it also constructs the corresponding observatory jobs required to capture all the images. This greatly facilitates the logistics of capturing many images with different filters and calibration frames across a wide area of the sky.
</para>
<para>
- The <guilabel>Mosaic Job Creator</guilabel> in the Ekos Scheduler will create multiple Scheduler jobs based on a central target. It requires that you select first one target and one sequence file. The Sequence File contains all the information necessary to capture an image including exposure time, filters, temperature setting, &etc;, and that information will be used for each pane of the mosaic. Observation job conditions and constraints shall be assigned too, so check that they are as per your requirements. You may simply prepare a new job without adding it, or pick an existing job, as long as both target and sequence file fields are valid in the Scheduler form. If you added jobs to the observation list previously, Ekos will ask you if you would want to keep or remove them before inserting the mosaic jobs in the list.
+ The <guilabel>Mosaic Planner</guilabel> in the Ekos Scheduler will create multiple Scheduler jobs based on a central target. To toggle the planner, click on the <guibutton>Mosaic Planner</guibutton> button in Ekos Scheduler or KStars INDI toolbar as illustrated in the screenshot. The planner draws the Mosaic Panel directly unto the sky map. It is recommended to enable HiPS overlay for the best experience. The planner is composed of four stages:
</para>
- <para>
- When your target and conditions are ready, start the Mosaic Job Creator by clicking on the icon next to the <guibutton>Find</guibutton> button in Ekos Module. A new window will open with a left-side form and your target centered in a sky chart. For convenience, maximize that window. There is a help icon on the top left part of the sky chart. Move your mouse over it to display the latest documentation of the tool. Each gadget also has its own tooltip.
- </para>
- <para>
- On first use, you need to enter your equipment settings including your telescope focal length in addition to camera's width, height, and pixel dimensions. You also need to enter the rotation of the camera with respect to the celestial pole your mount is pointing to. If Ekos is already started, you may retrieve optical information by clicking the <guibutton>Fetch</guibutton> to fill those fields automatically. However, if the camera rotation angle is unknown at that step, you will first need to use the <link linkend="ekos-align">Align module</link> to solve a field, preferentially close to the celestial equator, in order to determine it precisely. The rotation angle is an important parameter of your mosaic, as the Tool will create a grid using this orientation.
- </para>
- <screenshot>
+ <orderedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">Confirm Equipment</emphasis>: Ekos attempts to load equipment settings from INDI. If unsuccessful, you need to enter your equipment settings including your telescope focal length in addition to camera's width, height, and pixel dimensions. The settings are saved for future sessions.
+ </para>
+ <screenshot>
<screeninfo>
- Scheduler Mosaic Tool
+ Confirm Equipment
</screeninfo>
<mediaobject>
<imageobject>
- <imagedata fileref="ekos-scheduler-mosaic-std.png" format="PNG"/>
+ <imagedata fileref="mosaic_confirm_equipment.png" format="PNG"/>
</imageobject>
<textobject>
- <phrase>Scheduler Mosaic Tool</phrase>
+ <phrase>Confirm Equipment</phrase>
</textobject>
</mediaobject>
</screenshot>
- <para>
- Next, enter the desired <guilabel>overlap</guilabel> and number of horizontal and vertical <guilabel>mosaic grid</guilabel> panels (⪚ 2x2, 3x3, &etc;). The sky chart will update automatically after a short time, with target FOV calculated given the number of grid panes and your camera's FOV. By default, the percentage of the overlap among images is 5%, but you can change this value to your desired value. Changing the <guilabel>overlap</guilabel> will adjust the <guilabel>mosaic grid</guilabel> to cover the same area, while changing the <guilabel>mosaic grid</guilabel> will extend or shrink the mosaic area. To reset the extents of the mosaic field of view to the area expectedly covered by the grid, click <guibutton>Cover FOV</guibutton>.
- </para>
- <screenshot>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Adjust Grid</emphasis>: Select the mosaic panel dimension and overlap percentage. The Mosaic Panel is updated accordingly on the sky map. Adjust the Position Angle to match the desired mosaic orientation in the sky. If the Position Angle is different from your camera's usual orientation, you may need to rotate the camera either manually or via a mechanized rotator when the scheduler jobs are executed. Tile transparency is automatically calculated by default but may be turned off and adjusted manually. To compute the mosaic field from the number of tiles, click the <guibutton>Conver FOV</guibutton> button. The mosaic panel can be centered in the sky map by clicking on the <guibutton>Recenter</guibutton> button.
+ </para>
+ <screenshot>
<screeninfo>
- Scheduler Mosaic Tool - Field of view
+ Select Grid
</screeninfo>
<mediaobject>
<imageobject>
- <imagedata fileref="ekos-scheduler-mosaic-std.png" format="PNG"/>
+ <imagedata fileref="mosaic_select_grid.png" format="PNG"/>
</imageobject>
<textobject>
- <phrase>Scheduler Mosaic Tool - Field of view</phrase>
+ <phrase>Select Grid</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
A large overlap will make frame stitching easier during post-processing, but it requires more panes to cover the desired extent. However, if you already know the minimal amount of sub-frames your rejection algorithm will use during post-processing, you may want to increase the overlap to attain that amount on the areas covered by multiple panes. For instance, a 4x4 mosaic grid with 75% overlap has 16 sub-frames covering the central intersection, which is enough for Winsorized Sigma rejection. Although the resulting stack does not have the same height on all parts of the final frame, this method gives you control on signal-to-noise ratio and allows you to provide context to your target while exposing a relatively low number of captures.
</para>
+ <para>
+ The large number drawn in the corner of each grid pane represents the order in which panes will be captured. The default S-shaped choice (west-east then alternating high-low/low-high moves), ensures minimal movement of the mount during observation. Uncheck <guilabel>Minimum mount move</guilabel> to revert to west-east/high-low movement only. The coordinates of each pane are rendered in their center as degrees, minutes and seconds. Finally, the angle each pane rotates from the center of the mosaic is displayed at the bottom. If your field of view is large, or if your mosaic is located close to a celestial pole, you may observe that rendered panes start rotating visibly due their horizontal position or high declination. Use the <guilabel>overlap</guilabel> to ensure panes cover the desired frame extents properly.
+ </para>
<screenshot>
<screeninfo>
- Scheduler Mosaic Tool - 75% overlap
+ Scheduler Mosaic Tool - Large rotation
</screeninfo>
<mediaobject>
<imageobject>
- <imagedata fileref="ekos-scheduler-mosaic-threequarteroverlap.png" format="PNG"/>
+ <imagedata fileref="mosaic_close_pole.png" format="PNG"/>
</imageobject>
<textobject>
- <phrase>Scheduler Mosaic Tool - 75% overlap</phrase>
+ <phrase>Scheduler Mosaic Tool - Large rotation</phrase>
</textobject>
</mediaobject>
</screenshot>
- <para>
- The large number drawn in the corner of each grid pane represents the order in which panes will be captured. The default S-shaped choice (west-east then alternating high-low/low-high moves), ensures minimal movement of the mount during observation. Uncheck <guilabel>Minimum mount move</guilabel> to revert to west-east/high-low movement only. The coordinates of each pane are rendered in their center as degrees, minutes and seconds. Finally, the angle each pane rotates from the center of the mosaic is displayed at the bottom. If your field of view is large, or if your mosaic is located close to a celestial pole, you may observe that rendered panes start rotating visibly due their horizontal position or high declination. Use the <guilabel>overlap</guilabel> to ensure panes cover the desired frame extents properly.
- </para>
- <screenshot>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Adjust Grid</emphasis>: Adjust Grid center by manually entering the J2000 center or by dragging the center of the mosaic on the sky map.
+ </para>
+ <screenshot>
<screeninfo>
- Scheduler Mosaic Tool - Large rotation
+ Adjust Grid
</screeninfo>
<mediaobject>
<imageobject>
- <imagedata fileref="ekos-scheduler-mosaic-atpole.png" format="PNG"/>
+ <imagedata fileref="mosaic_adjust_grid.png" format="PNG"/>
</imageobject>
<textobject>
- <phrase>Scheduler Mosaic Tool - Large rotation</phrase>
+ <phrase>Adjust Grid</phrase>
</textobject>
</mediaobject>
</screenshot>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Create Jobs</emphasis>: The final step is to select the sequence file and directory to store the images. Target field is automatically filled but may be changed as desired. Select the steps each scheduler job should execute in sequence (Track -> Focus -> Align -> Guide -> Capture), and adjust the frequency of automatic alignment and focus routines that must be executed during the mosaic operation. For example, if <guilabel>Align Every</guilabel> is set to 2 Scheduler Jobs, then the first job will run the astrometry alignment, while the second job will skip it. When the third job is executed, alignment is performed again and so forth.
+ </para>
+ <screenshot>
+ <screeninfo>
+ Create Jobs
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="mosaic_create_jobs.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Create Jobs</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </listitem>
+ </orderedlist>
<para>
- If you need to adjust the position of the mosaic, click on the view and drag the chart to recenter your target. When satisfied, set the frequency of alignment and focus steps during the mosaic execution and choose an output folder and accept the dialog. Ekos shall create an observation job and a corresponding customized sequence file for each panel. Save the plan to an Ekos Scheduler List (<literal role="extension">.esl</literal>) file with the <guibutton>Save as...</guibutton> button, so that you may load it on any suitable observing night and, with the <guilabel>Remember Job Progress</guilabel> option, it will pick off where you left.
- </para>
- <para>
- With Ekos Scheduler, multi-night imaging is greatly facilitated and creating super mosaics has never been so easy.
+ Click <guibutton>Create Jobs</guibutton> to generate mosaic scheduler jobs and add them to the schedule queue.
</para>
</sect3>
</sect2>
diff --git a/doc/mosaic_adjust_grid.png b/doc/mosaic_adjust_grid.png
new file mode 100644
index 000000000..b53e685be
Binary files /dev/null and b/doc/mosaic_adjust_grid.png differ
diff --git a/doc/mosaic_close_pole.png b/doc/mosaic_close_pole.png
new file mode 100644
index 000000000..fe224fb0b
Binary files /dev/null and b/doc/mosaic_close_pole.png differ
diff --git a/doc/mosaic_confirm_equipment.png b/doc/mosaic_confirm_equipment.png
new file mode 100644
index 000000000..44487f606
Binary files /dev/null and b/doc/mosaic_confirm_equipment.png differ
diff --git a/doc/mosaic_create_jobs.png b/doc/mosaic_create_jobs.png
new file mode 100644
index 000000000..c76873488
Binary files /dev/null and b/doc/mosaic_create_jobs.png differ
diff --git a/doc/mosaic_planner.png b/doc/mosaic_planner.png
new file mode 100644
index 000000000..874f2978d
Binary files /dev/null and b/doc/mosaic_planner.png differ
diff --git a/doc/mosaic_select_grid.png b/doc/mosaic_select_grid.png
new file mode 100644
index 000000000..fc68fae9d
Binary files /dev/null and b/doc/mosaic_select_grid.png differ
diff --git a/doc/mosaic_wizard.png b/doc/mosaic_wizard.png
index 423d0c52c..874f2978d 100644
Binary files a/doc/mosaic_wizard.png and b/doc/mosaic_wizard.png differ
diff --git a/doc/profile_editor.png b/doc/profile_editor.png
index 3b17f25a9..994504e90 100644
Binary files a/doc/profile_editor.png and b/doc/profile_editor.png differ
diff --git a/doc/profile_editor_scripts.png b/doc/profile_editor_scripts.png
new file mode 100644
index 000000000..958342120
Binary files /dev/null and b/doc/profile_editor_scripts.png differ
More information about the kde-doc-english
mailing list