Revision as of 14:03, 2 October 2013

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.

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.

cd

cd directory

Set the current working directory.

crop

crop x, y, width, height

Crops the current image either with the rectangle previously selected with the mouse or with the x, y, width and height parameters.

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.

entropy

entropy filename

Computes the entropy of the file given in the parameter filename.

exit

exit

Quits the application.

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.

fill

fill value

Fills the whole current image with pixels having the value intensity.

gauss

gauss sigma

Performs a Gaussian filter with the given sigma.

help

help

Gives the available commands.

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

Loads the fits image filename; it first attempts to load filename, then filename.fit and finally filename.fits, 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 (the second, optional argument is reserved for a future use). If the extension ".bmp" is written at the end of the filename, the command is identical to loadbmp.

loadbmp

loadbmp filename

Loads the bmp image filename.

This command has some known bugs and should not be used for now

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

Creates a new image filled with zeros with a size of width height.

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.

save

save filename

Writes the currently displayed image to filename.fit. Fits headers MIPS-HI and MIPS-LO are added with values corresponding to the current viewing levels (the second, optional argument is reserved for a future use).

savergb

savergb filename

Same command than save.

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

Display 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

FreeAstro