Siril:Commands

=Siril command line functions reference= This manual is a summary of the different commands you can find in Siril. As Siril is in alpha test phase, numerous commands can be added and some others can be changed. Please check the date of the page (the history link) before using.

The  character is the delimiter between arguments. If you need to have spaces inside the arguments, you can use the quote or double quote, just like in a shell.

addmax
addmax filename addmax compute a new image IMG with IMG_1 and IMG_2. The pixel of IMG_1 is replaced by the pixel at the same coordinates of IMG_2 if the intensity of 2 is greater than 1. Do not forget to save the result.

bg
bg Return the background level of the image loaded in memory.

cd
cd directory Set the current working directory.

clearstar
clearstar Clear all the stars saved in memory and displayed on the screen.

crop
crop x, y, width, height Crops the current image within the rectangle previously selected.

ddp
ddp level coef sigma Performs a DDP (digital development processing) as described first by Kunihiko Okano. This implementation is the one described in IRIS. It combines a linear distribution on low levels (below level) and a non-linear on high levels. It uses a Gaussian filter of sigma sigma multiplies the resulting image by coef. The typical values for sigma are included between 0.7 and 2

entropy
entropy Computes the entropy of the opened image on the displayed layer, only in the selected area if one has been selected or in the whole image else. The entropy is one way of measuring the noise or the details in an image.

exit
exit Quits the application.

extract
extract NbPlane Extracts NbPlane Planes of Wavelet domain.

fdiv
fdiv filename scalar Divides the image in memory by the image given in argument. The resulting image is multiplied by the value of the scalar argument. Please check that the image is in the working directory. See also fdiv.

fftd
fftd modulus phase Applies a Fast Fourier Transform to the image loaded in memory. Modulus and phase given in argument are saved in FITS files.

ffti
ffti modulus phase This function is used to retrieve corrected image applying an inverse transformation. The modulus and phase used are the files given in argument.

fill
fill value x y width height Fills the whole current image with pixels having the value intensity.

fill2
fill2 value x y width height Same command than fill but this is a symmetric fill of a region defined by the mouse. Used to process an image in the Fourier (FFT) domain.

findstar
findstar Detects stars having a level greater than a threeshold computed by Siril. The algorithm is based on the publication of Mighell, K. J. 1999, in ASP Conf. Ser., Vol. 172, Astronomical Data Analysis Software and Systems VIII, eds. D. M. Mehringer, R. L. Plante, & D. A. Roberts (San Francisco: ASP), 317.

After that, a dynamic PSF is applied and Siril rejects all detected structures that don't fulfill a set of prescribed detection criteria. Finaly, a circle is drawn around detected stars. See also the command clearstar.

fmedian
fmedian ksize modulation Performs a median filter of size ksize $$ \times$$ksize (ksize MUST be odd) to the original image with a modulation parameter modulation. The output pixel is computed as : out $$=$$mod $$ \times\ m + (1-$$mod$$) \times $$in, where m is the median-filtered pixel value. A modulation's value of 1 will apply no modulation.

gauss
gauss sigma Performs a Gaussian filter with the given sigma.

help
help Gives the available commands.

histo
histo layer Calculates the histogram of the image layer in memory and produces file histo_[layer name].dat in the working directory.

layer = 0, 1 or 2 with 0=red, 1=green and 2=blue.

iadd
iadd filename Adds the image in memory to the image designed in argument. Please check that the image is in the working directory.

idiv
idiv filename Divides the image in memory by the image given in argument. Please check that the image is in the working directory. See also fdiv.

imul
imul filename Multiplies the image in memory by the image given in argument. Please check that the image is in the working directory.

isub
isub filename Substracts the image in memory by the image given in argument. Please check that the image is in the working directory.

load
load filename load filename.ext Loads the fits image filename; it first attempts to load filename, then filename.fit and finally filename.fits and after, all supported format, aborting if none of these are found. These scheme is applicable to every Siril command implying reading files. Fits headers MIPS-HI and MIPS-LO are read and their values given to the current viewing levels.

Writing a known extension at the end of filename will load the image filename.ext: this is used when numerous files have the same name but not the same extension.

Extensions supported are :
 * *.fit, *.fits, *.fts
 * *.bmp / *.jpg, *.jpeg / *.png / *.tif, *.tiff
 * *.ppm, *.pgm
 * *.pic (IRIS file)

log
log Computes and applies a logarithmic scale to the current image.

mirrorx
mirrorx Rotates the image around a vertical axis.

mirrory
mirrory Rotates the image around an horizontal axis.

new
new width height nb_layers Creates a new image filled with zeros with a size of width x height. The image is in 16-bit format, and it contains nb_layers layers, nb_layers being 1 or 3. It is not saved, but displayed and can be saved afterwards.

nozero
nozero level Replaces null values by level values. Useful before an idiv or fdiv operation.

offset
offset value Adds the constant value to the current image. This constant can take a negative value. As Siril uses unsigned fit files, if the intensity of the pixel become negative its value is replaced by 0 and by 65535 (for a 16-bit file) if the pixel intensity overflows. To check the minimum and maximum intensities values, click on the Auto level button and note the low and high threshold.

psf
psf Make a selection around a star and call the command PSF. It will give you:
 * The centroid coordinates (x0 and y0) in pixel units, which is the position of the center of symmetry of the fitted PSF.
 * The FWHM on the X and Y axis.
 * The rotation angle of the X axis with respect to the centroid coordinates.
 * The average local background.
 * The maximal intensity of the star: this is the peak value of the fitted function, located at the centroid coordinates x0 and y0.
 * The relative magnitude of the star.
 * The RMSE. This is an estimate of fitting quality. The smaller the RMSE is, the better the function is fitted.

To be relevant, the selection MUST be done on a non-saturated star.

rotate
rotate degree Rotates the image of an angle of degree value. This function requieres the installation of libopencv.

rotatepi
rotatepi Rotates the image of an angle of 180° around its center. This is equivalent to the command "rotate 180" or "rotate -180".

rmgreen
rmgreen type rmgreen is a chromatic noise reduction filter. It removes green noise in the current image. This filter is based on PixInsight's SCNR Average Neutral algorithm and it is the same filter used by HLVG plugin in Photoshop. In command line, the lightness is always preserved. For image processing without L* preservation use the graphical tool box and uncheck the corresponding button.

Type=1 stands for Average Neutral Protection, while type=2 stands for Maximum Neutral Protection.

satu
satu coeff Enhance the global saturation of the image. Try iteratively to obtain best results. For example: satu 0.1

save
save filename Save current image to filename.fit. Fits headers MIPS-HI and MIPS-LO are added with values corresponding to the current viewing levels..

savebmp
savebmp filename Save current image under the form of a bitmap file with 8bits per channel: filename.bmp (BMP 24 bits). This function is like a screenshot of what you see with the levels updated. This is very usefull to share an image in the bitmap format.

savejpg
savejpg filename [quality] Save current image into a JPG file. You have the possibility to adjust the quality of the compression. A value 100 for quality parameter offers best fidelity while a low value increases the compression ratio. If no value is specified, it holds a value of 100. This command is very usefull to share an image in the jpeg format on the forums for example.

savepnm
savepnm filename Save current image under the form of a Netpbm file format with 16bits per channel. The extension of the output will be filename.ppm for RGB image and filename.pgm for gray-level image. More details about the Netpbm format at : http://en.wikipedia.org/wiki/Netpbm_format.

savetif
savetif filename Save current image under the form of a uncompressed TIFF file with 16bits per channel.

savetif8
savetif8 filename Same command than savetif but the output file is saved in 8bits per channel.

split
split r g b The command splits the color image into three distincts files (one for each color) and save them in r g and b file.

stat
stat Returns global statistic of the current image. If a selection is made, the command returns global statistic within the selection.

threshlo, threshhi, thresh
These are threshold functions:
 * threshlo 40 replaces values below 40 with 40;
 * threshhi 1000 replaces values above 1000 with 1000;
 * thresh 40 1000 does both.

unsharp
unsharp sigma multi Applies to the working image an unsharp mask with sigma sigma and coefficient multi.

visu
visu low high Displays an image with low and high as the low and high threshold.

wavelet
wavelet plan_number type Computes the wavelet transform on plan_number plans using linear (type=1) or bspline (type=2) version of the 'a trous' algorithm. The result is stored in a file as a structure containing the planes, ready for weighted reconstruction with wrecons.

wrecons
wrecons c1 c2 ... cn Reconstructs to current image from the planes previously computed with waveletand weighted with coefficients c1, c2, ..., cn according to the number of planes used for wavelet transform