Basic copy of the commands.pdf from Cyril |
m Few fixes |
||
| Line 1: | Line 1: | ||
=Siril command line functions reference= | =Siril command line functions reference= | ||
This manual is a summary of the | 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. | ||
==cd== | ==cd== | ||
| Line 12: | Line 12: | ||
==ddp== | ==ddp== | ||
ddp level coef sigma | ddp level coef sigma | ||
Performs a DDP (digital development processing) as described | Performs a DDP (digital development processing) as described first by Kunihiko Okano. This implementation is the one described in [http://www.astrosurf.org/buil/us/iris/iris5.htm 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== | ||
| Line 28: | Line 28: | ||
==gauss== | ==gauss== | ||
gauss sigma | gauss sigma | ||
Performs a | Performs a Gaussian filter with the given sigma. | ||
==help== | ==help== | ||
| Line 36: | Line 36: | ||
==load== | ==load== | ||
load filename [rvbag] | load filename [rvbag] | ||
Loads the fits image filename; it | 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) | ||
==log== | ==log== | ||
| Line 58: | Line 58: | ||
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). | 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 [rvbag] | savergb filename [rvbag] | ||
Same command than save. | Same command than save. | ||
| Line 64: | Line 64: | ||
==threshlo, threshhi, thresh== | ==threshlo, threshhi, thresh== | ||
These are threshold functions: | These are threshold functions: | ||
* threshlo 0 replaces negative values with 0s; | * <tt>threshlo 0</tt> replaces negative values with 0s; | ||
* threshhi 1000 replaces values above 1000 with 1000; | * <tt>threshhi 1000</tt> replaces values above 1000 with 1000; | ||
* thresh 0 1000 does both. | * <tt>thresh 0 1000</tt> does both. | ||
==unsharp== | ==unsharp== | ||
| Line 82: | Line 82: | ||
==wrecons== | ==wrecons== | ||
wrecons c1 c2 ... cn | 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 | Reconstructs to current image from the planes previously computed with waveletand weighted with coefficients <tt>c1, c2, ..., cn</tt> according to the number of planes used for wavelet transform | ||
Revision as of 23:07, 25 September 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.
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.
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.
load
load filename [rvbag]
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)
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.
nozero
nozero level
Replaces null values by level values. Useful before an idiv or fdiv operation.
save
save filename [rvbag]
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 [rvbag]
Same command than save.
threshlo, threshhi, thresh
These are threshold functions:
- threshlo 0 replaces negative values with 0s;
- threshhi 1000 replaces values above 1000 with 1000;
- thresh 0 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