Update english help thanks to gunarm

This commit is contained in:
2022-04-27 20:46:59 +02:00
parent 748f5fac03
commit 555e6c11c8
+61 -41
View File
@@ -2,13 +2,14 @@
<head>
<style type="text/css">
h1, h2, h3, h4 { padding:0px; margin:10px; }
p { padding:0px; margin:5px 5px 10px 5px; }
p { padding:0px; margin:5px; }
img { margin: 5px; }
</style>
</head>
<body>
<h2>Tenmon help</h2>
<p>Tenmon is primary for viewing astro photos and images. It can open following formats
<p>Tenmon is intended primarily for viewing astro photos and images. It supports the following formats:
<ul>
<li>FITS 8, 16 bit integer and 32 bit float</li>
<li>XISF 8, 16 bit integer and 32 bit float</li>
@@ -17,57 +18,76 @@ p { padding:0px; margin:5px 5px 10px 5px; }
</p>
<h3>Main windows</h3>
<p>Main window show loaded images. On the left there is<i>Image info</i> which display detailed about actual image.
<i>File system</i> display all images from current dir.
On top is main menu and under it <i>Stretch panel</i>. All panels can be closed and moved around. Closed panel can be
opened again through menu <i>Docks</i>.
</p>
<p>The main window shows the currently loaded image. On the left is the <i>Image info</i> panel which displays details about the loaded image.
The <i>File system</i> panel shows other images in the same directory as the loaded image. At the top is the main menu and below that is the
<i>Stretch panel</i> containing various options for auto-stretching linear image data.</p>
<p>All panels in the interface can be moved around and/or closed. Any closed or non-visible panel can be
re-opened through the <i>Docks</i> menu at the top.</p>
<h3>Opening and saving images</h3>
<p>To open image select menu <i>File->Open</i>. After file selection this file is displayed in main windows
Panel <i>File system</i> is populated with rest of images in current directory.</p>
<p>Currently displayed image can be saved into different format with <i>File->Save as</i>. There is selection for
of formats JPEG, PNG FITS and XISF. In case of JPEG or PNG first stretch function is applied. FITS and XISF are converted
without format stretch.</p>
<p>To load an image select <i>File->Open</i> and choose the file. After a file is loaded, it becomes visible in the main image panel, and the
<i>File system</i> panel will show the other images in the same directory.</p>
<p>The loaded image can be exported to a different format with <i>File->Save as</i>. Any of the formats JPEG, PNG FITS and XISF can be selected.
In the case of saving JPEG or PNG, the stretch function is applied to the saved image. FITS and XISF are saved/converted without applying the stretch.
To open an image, you can also drag and drop it to main window.</p>
<h3>View</h3>
<p>Menu <i>View</i> affect size and scale displayed images. <i>Zoom In/Zoom Out</i> magnify and shrink image.
For this mouse wheel can be also used. <i>Best fit</i> display image so it is shown across whole window.
<i>100%</i> display image in 1:1 scale. <i>Fullscreen</i> show main window on whole screen.
<i>Thumbnails</i> show small thumnails for all images from current dir.
<p>The <i>View</i> menu has options to control the size and scale of displayed images:
<ul>
<li><i>Zoom In</i> and <i>Zoom Out</i> magnify and shrink the image. The mouse wheel can be also used to zoom freely.</li>
<li><i>Best fit</i> auto-zooms the image to fit the current size of the window.</li>
<li><i>100%</i> will zoom to 1:1 scale.</li>
<li><i>Fullscreen</i> enlarges the main window to the whole screen.</li>
<li><i>Thumbnails</i> will display small thumbnails for all images in the current directory.</li>
</ul>
</p>
<h3>Stretch toolbar</h3>
<p>This panel change how images are displayed. First there is slider scale with three points settings.
<br><br><img src=":/about/stretch-panel.png">
<p>This panel changes how images are displayed.
<br><img src=":/about/stretch-panel.png"></p>
<p>Starting on the left, there is slider scale with three adjustable points to manually control the stretch.
<ul>
<li>black point - all pixels with value lower that set will be black</li>
<li>mid point - all pixels with this value will be shown with 50% intensity</li>
<li>white point - all pixels with value above this will be white</li>
<li>black point - all pixels with lower value (darker) than this setting will be clipped black</li>
<li>mid point - defines the value to be stretched to 50% intensity</li>
<li>white point - all pixels with higher value (brighter) than this will be clipped white</li>
</ul>
Following the slider are 5 buttons for automatic stretching:
<ul>
<li><i>Auto Stretch</i> automatically apply black and mid points to render the image with optimal brightness.</li>
<li><i>Reset</i> reset three values for black, mid and white point to default.</li>
<li><i>Invert</i> invert colors to display the image as negative.</li>
<li><i>Super pixel CFA </i> average 2x2 pixels into one (suitable for images from colour camera).</li>
<li><i>Apply Auto stretch on load</i> toggle automatically applying Autostretch for each image when loaded.</p>
</ul>
Next is button that set black and mid point to optimal place so image can be shown with optimal brightness.
Second button reset three values for black, mid and white point to default. Invert colors display image as negative.
Super pixel CFA average two by two pixels into one which is suitable for images from colour camera.
Last button toggle setting optimal stretch for each image individually on load.</p>
<h3>Marking imagesv</h3>
<p>Images can be marked in menu <i>Select</i>. List of marked images can be shown with
<i>Select->Show marked</i>. This dialog serve to clear marks from images. Marked images have * character in
main window title bar. Marked images can be copied or moved to selected directory with <i>File->Copy/Move marked files</i>.
After copy or move list of marked files is cleard. Program will remember list of marked files after quit.</p>
<h3>Marking images</h3>
<p>Images can be marked in the <i>Select</i> menu. To show a list of only the marked images, use <i>Select->Show marked</i>.
This dialog can be useful to clear marks from images. Marked images show a <b>*</b> character in the title bar of the main window.
Marked images can be copied or moved to a selected directory with <i>File->Copy/Move marked files</i>.
After copying or moving, the list of marked files is cleared. The list of marked files will be remembered after quitting the program.</p>
<h3>Database of FITS/XISF files</h3>
<p>Program can search direcory and index meta data from FIST and XISF images into internal database. This database can be then
searched. To index directory with FIST/XISF images select it through <i>File->Index directoryr</i>.
Selected directory is then searched and meta data from FITS and XISF images are stored into database.
To refresh database you can run <i>File->Reindex</i>. This will update any changed meta data and remove any record about
deleted files. To index new files run index directory again.</p>
<p>To show database select <i>Docks->FITS/XISF database</i>. Database is shown as table where each column is different property.
AT bottom of database panel is button to select which propertis are displayed. Next are three combo boxes and text inputs.
Combo box select which property to search and text input what value to search.
<p>Tenmon can scan a directory of FITS/XISF files and index metadata from FITS headers into it's internal database. This allows searching and sorting images based on that metadata.</p>
<p>To populate the database, select a directory of FITS/XISF files with <i>File->Index directory</i>.
After the selected directory is searched, metadata parsed from the images will be stored in the database.
To refresh the database, run <i>File->Reindex</i>. This will update any changed metadata and remove any record of
deleted files. To index new files, simply run <i>Index directory</i> again.</p>
<p>The database is viewed through a panel which is not visible in the default layout. To add the database panel to the view,
toggle <i>Docks->FITS/XISF database</i>. Once visible, database panel shows the database as a table with a column for each property.
Below the table is button to select which columns/properties are displayed.</p>
<p>Also at the bottom of the database panel are three combo boxes and text inputs used for filtering.
Select the property to filter on with the combo box and in the adjacent text box enter a string to search for in that property.
<p>Wildcards:
<ul>
<li><b>%</b> (percent) is a wildcard representing zero or more of any characters.</li>
<li><b>_</b> (underscore) is a wildcard for exactly one of any character.</i>
<li>Without wildcard characters, the exact string must match.</li>
</ul>
</p>
<br><img src=":/about/filter.png"><br>
In this example it search for files that have "Bias" in their file name and property OBJECT is M_42 and DATE begin with 2022.
Character % (percent sing) is wildcard represent zero, one or many characters. Character _ (underscore) is second wildcard character that
represent single character. Without wildcard character exact string is searched.</p>
This example filters for files where: "Bias" is in the file name, the OBJECT property is "M_42" (where the underscore can be any single character), and the DATE property begins with "2022".
</p>
<p><small>PS: Kanji in icon means astronomy in Japanese</small></p>
</body>
</html>