Help documentation for batch processing

about/help_en

@@ -14,7 +14,7 @@ img { margin: 5px; }
     <li>FITS 8, 16, 32 bit integer and 32, 64 bit float</li>
     <li>XISF 8, 16, 32 bit integer and 32, 64 bit float</li>
     <li>JPEG, PNG, BMP, GIF, PBM, PGM, PPM and SVG images</li>
-    <li>CR2, NEF, DNG raw images</li>
+    <li>CR2, CR3, NEF, DNG raw images</li>
 </ul>
 </p>
 
@@ -115,6 +115,116 @@ Pressing Enter or clicking on <i>Filter</i> button will filter out database reco
 <br><img src=":/about/filter.png"><br>
 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>
+
+
+<h3>Batch processing</h3>
+
+This module allow to write scripts in JavaScript that process image files. Batch Processing window consist from three main parts. On top is list of input files and directories.
+You can add directories or individual files to this list. Directories are scanned recursively to find all files even non image files. This list of files is then passed to script in array named <b>files</b>.
+In script you can then iterate through files like this.
+<pre>for(file in files)
+{
+    if(file.suffix() == "fits")
+    {
+        core.log(file.fileName());
+        file.convert(file.relativeFilePath(), "XISF");
+    }
+}
+</pre>
+
+<h4>core</h4>
+There is global object called <b>core</b> that have these methods.
+<ul>
+<li><b>log(message)</b> print message to log window.</li>
+<li><b>mark(file)</b> mark file same way as in GUI. Takes object of type <i>File</i> as argument.</li>
+<li><b>unmark(file)</b>  unmark file same was as in GUI. Takes object of type <i>File</i> as argument.</li>
+<li><b>isMarked(file)</b> check if file was marked.  Takes object of type <i>File</i> as argument.</li>
+<li><b>setMaxThread(maxthread)</b> set maximum number of concurent thread when doing asynchronious task.</li>
+<li><b>sync()</b> wait until all asynchronious tasks are done.</li>
+<li><b>getString(label = "", text = "")</b> show dialog box to get string value from user. String value passed in first argument is used as description label. Second argument text is default value in text box.
+        Both parameters are optional so calling just <i>getString()</i> is valid. When cancel is pressed it return Undefined.</li>
+<li><b>getInt(label = "", value = 0)</b> show dialog box with input box to retrive integer value. String value passed in first argument is used as description label.
+        Second parameter is default value in input box. Both parameters are optional. When cancel is pressed it return Undefined.</li>
+<li><b>getFloat(label = "", value = 0, decimals = 3)</b> show dialog box with input box to retrive decimal value. String value passed in first argument is used as description label.
+        Second parameter is default value in input box. All three parameters are optional. When cancel is pressed it return Undefined.</li>
+<li><b>getItem(items)</b> show selection dialog which allow to select one item from array of items. When cancel is pressed it return Undefined.</li>
+</ul>
+
+<h4>File</h4>
+In <b>files</b> array there are instances of type <b>File</b> objects that have these methods.
+<ul>
+<li><b>fileName()</b> returns the name of the file, excluding the path.</li>
+<li><b>absoluteFilePath()</b> returns an absolute path including the file name.</li>
+<li><b>absolutePath()</b> returns an absolute path without the file name</li>
+<li><b>relativeFilePath()</b> return relative path including file name relative to directory that was in list of directories to be scanned. For example you add C:/images as input directory. In this directory there
+        is file <i>C:/images/lights/red/M42_001.fits</i> then this method will return <i>lights/red/M42_001.fits</i></li>
+<li><b>relativePath()</b> return same path as previous method just without file name. <i>lights/red</i></li>
+<li><b>baseName()</b> return file name up to the first dot. For example for <i>some.file.name.fits</i> it will return <i>some</i></li>
+<li><b>completeBaseName()</b> return file name up to the last dot. For example for <i>some.file.name.fits</i> it will return <i>some.file.name</i></li>
+<li><b>suffix()</b> return string after last dot in file name. For example <i>fits</i></li>
+<li><b>size()</b> return size of file in bytes.</li>
+<li><b>fitsKeywords()</b> return array of strings with every keyword that is in header. <i>SIMPLE,BITPIX,NAXIS,NAXIS1,NAXIS2,EXTEND,COMMENT</i></li>
+<li><b>fitsValue(key)</b> return value for keyword. In case that there is multiple occurences it return last one.</li>
+<li><b>fitsValues(key)</b> return array of values for keyword.</li>
+<li><b>fitsRecords()</b> return array of objects with properties <b>key, value</b> and <b>comment</b> </li>
+<li><b>modifyFITSRecords(FITSRecordModify)</b> modify FITS header by adding, removing or updating FITS record. Return true on success. Refer to <i>FITSRecordModify</i></li>
+<li><b>isMarked()</b> return true if file is marked.</li>
+<li><b>copy(newpath)</b> copy file to new location. It return instance of new <i>File<i> object that represent this copied file. This path can be relative or absolute. In case that <i>newpath</i> parameter is relative
+        path then it "Output directory" from GUI windows is used as base directory. Paramer <i>newpath</i> can absolute path. File is then copied to this path. In case that copy fail it return null.</li>
+<li><b>move(newpath)</b> move file to new location. It return false if move failed. This can happend if destination is not writable but also if destination file already exist. This functions does not overwrite existing file.
+        This path can be relative or absolute. In case that <i>newpath</i> parameter is relative path then it "Output directory" from GUI windows is used as base directory. Paramer <i>newpath</i> can absolute path.
+        File is then moved to this path.</li>
+<li><b>convert(outpath, format, params)</b> convert image file from any format that program is able to open into FITS, XISF, JPEG, PNG, BMP.
+        Parameters are: <i>outputpath</i> path where converted image will be saved. It automatically replace suffix according to format. <i>format</i> one of "FITS" "XISF", "JPG", "PNG" or "BMP". <i>params</i> object with attributes "compressionType" and "compressionLevel".
+        Valid values for compressionType are be "gzip" or "rice" when converting to FITS. When converting to XISF compressionType can be "zlib", "lz4", "lz4hc", "zstd", "zlib+sh", "lz4+sh", "lz4hc+sh", "zstd+sh".
+        It is recomended to use "+sh" variants of compression.
+        XISF format also accept "compressionLevel" in range 0-100 where zero is fastest compression and 100 slowest. If you omit this attribute or set it to -1 then default compression level will be used.
+        It return new instance of <i>File</i> that point to converted file.
+<pre>file.convert("converted_file.xisf", "xisf", {"compressionType": "zstd+sh", "compressionLevel": 70});
+file.convert("converted_file.fits", "fits", {"compressionType": "rice"});
+file.convert("converted_file.jpg", "png");</pre>
+</li>
+<li><b>convertAsync(outpath, format, params)</b> same as previous method but it does conversion in separated thread asynchroniously. Before calling any method on object returned by this method you must call
+        <code>core.sync();</code> to ensure that conversion is done and destination file exists.
+        <pre>let compression = {"compressionType": "zstd+sh"};
+let convertedFiles = [];
+for(file of files)
+{
+    if(file.suffix() == "fits")
+        convertedFiles.push(file.convertAsync("xisf/" + file.fileName(), "XISF", compression));
+}
+core.sync(); // ensure that files exist
+for(file of convertedFiles)// now we can iterate over the files
+{
+    core.log(file.fileName() + " " + file.size()); // let print compressed file sizes
+}</pre></li>
+<li><b>stats()</b> calculate basic images statistics and return them as object with attributes "mean", "stddev", "median", "min", "max" and "mad".
+<pre>let s = file.stats();
+core.log("Median value is " + s.median);</pre></li>
+</ul>
+
+<h4>FITSRecordModify</h4>
+This class is used to define modify operation FITS header in FITS and XISF files. It can remove update and add records. Order of operation is also remove then update and last add.
+The keyword names may be up to 8 characters long and can only contain uppercase letters, the digits 0-9, the hyphen, and the underscore character.
+<pre>let modify = new FITSRecordModify();
+modify.updateKeyword("OBJECT", "M42");
+modify.updateKeyword("MYTILE", "PART1", "adding custom keyword so WBPP can group it");
+modify.removeKeyword("OBJECT");
+// doesn't matter that it is specified as last. This will first remove
+// existing OBJECT record and then add again OBJECT=M42
+for(file in files)
+{
+    file.modifyFITSRecords(modify);
+}</pre>
+
+<ul>
+<li><b>new FITSRecordModify()</b> create new instance of object.</li>
+<li><b>removeKeyword(key);</b> specify removing of record with <i>key</i> as keyword.</li>
+<li><b>updateKeyword(key, value, comment = "")</b> specify updating existing keyword with value and comment. Comment is optional parameter. If record with keyword doesn't exist then it will add new one.
+        Unless you want to have multiple records with same keyword (for example HISTORY) always use this method and not addKeyword.</li>
+<li><b>addKeyword(key, value, comment = "")</b> specify adding new keyword</li>
+</ul>
+
 <p><small>PS: Kanji in icon means astronomy in Japanese</small></p>
 </body>
 </html>

about/help_fr

@@ -14,7 +14,7 @@ img { margin: 5px; }
     <li>FITS 8, 16 bit entier et 32 bit point flottant</li>
     <li>XISF 8, 16 bit entier et 32 bit point flottant</li>
     <li>images JPEG, PNG, BMP, GIF, PBM, PGM, PPM et SVG</li>
-    <li>images RAW CR2, NEF, DNG</li>
+    <li>images RAW CR2, CR3, NEF, DNG</li>
 </ul>
 </p>
 

about/help_sk

@@ -13,7 +13,7 @@ p { padding:0px; margin:5px 5px 10px 5px; }
     <li>FITS 8, 16, 32 bitové celočíselné 32 a 64 bitové s plávajúcou čiarkou</li>
     <li>XISF 8, 16, 32 bitové celočíselné 32 a 64 bitové s plávajúcou čiarkou</li>
     <li>JPEG, PNG, BMP, GIF, PBM, PGM, PPM a SVG obrázky</li>
-    <li>CR2, NEF, DNG raw obrázky</li>
+    <li>CR2, CR3, NEF, DNG raw obrázky</li>
 </ul>
 </p>