Les commandes et usages
Le programme Siril est un incontournable du traitement d’image astronomique, et pour ceux (dans les débuts de l’astrophoto amateur) qui ont débuté sous IRIS (en mode ligne de commande), une belle façon de continuer son usage. Surtout que Python peut se rajouter au poste de contrôle pour diriger les fonctions.
pySiril est un package Python étendant les capacités de script, présent nativement dans Siril. Il est destiné aux utilisateurs déjà familiarisés avec les scripts à la recherche d’une alternative à l’utilisation de shell complexes ou bat (sous Windows).
Avec pySiril, vous pouvez:
- écrire des conditions et des boucles (
if,else,for…) - écrire facilement vos propres fonctions
- récupérer les valeurs renvoyées par certaines des fonctions Siril telles que
stat,bg,cdg,bgnoise… - utiliser toutes les capacités de python pour étendre les traitements ou logiques
Cette bibliothèque fonctionne pour les 3 principaux OS, Linux, Windows et MacOS.
Les commandes implémentées sont directement issues de celles disponibles sous la version 1.0.0. La description de chaque commande est disponible via cmd.help(‘commande’)
Pour le dernier release (1.2.0), sont disponibles :
ASINH
asinh [-human] stretch [offset]
Stretches the image using an hyperbolic arcsin transformation Syntax : status=cmd.asinh(stretch, [human=True],[offset]) Parameters : – stretch = strength of the stretch (1..1000) – human = enables using human eye luminous efficiency weights – offset = the normalized pixel value of [0..1] Return : – status[0] = True: execution ok /status[0] = False: Aborted Example : status=cmd.asinh(10) status=cmd.asinh(100,offset=0.65,human=True) status=cmd.asinh(100,offset=0.35)Étire l’image pour montrer les objets faibles en utilisant une transformation arcsin hyperbolique . L’argument obligatoire stretch, compris typiquement entre 1 et 1000, donnera la force de l’étirement. Le point noir peut-être compensé en indiquant un argument optionnel offset avec la valeur normalisée du pixel de [0,1]. Enfin, l’option human permet en utilisant la forte efficacité lumineuse de l’œil humain de calculer la luminance à utiliser pour donner la valeur d’étirement pour chaque pixel , au lieu de la simple moyenne des valeurs pixel des canaux. Cette méthode d’étirement préserve la légèreté de l’espace de couleur L*a*b*
AUTOGHS
autoghs [-linked] shadowsclip stretchamount [-b=] [-hp=] [-lp=]
Syntax : status=cmd.autoghs(shadowsclip stretchamount, [linked=True],[-b=],[-hp=],[-lp=]) Parameters : – shadowsclip : shadows clipping point – stretchamount : stretch amount – linked : linked channels – b : brightness range (default=13) – hp : HP range (default=0.7) – lp : LP range (default=0) Return : – status[0] = True: execution ok /status[0] = False: Aborted Example : status=cmd.asinh(10) status=cmd.asinh(100,offset=0.65,human=True) status=cmd.asinh(100,offset=0.35)Application de l’étirement hyperbolique généralisé avec un point de symétrie SP défini comme k.sigma de la médiane de chaque canal (la valeur fournie shadowsclip est le k ici et peut être négative). Par défaut, SP et l’étirement sont calculés par canal ; SP peut être calculé comme une moyenne des canaux de l’image en passant -linked. La quantité d’étirement D est fournie dans le deuxième argument obligatoire.
Valeurs implicites de 13 pour B, le rendant très axé sur la plage de luminosité SP, 0,7 pour HP, 0 pour LP sont utilisées mais peuvent être modifiés avec les options du même nom
AUTOSTRETCH
autostretch [-linked] [shadowsclip [targetbg]]
Syntax : status=cmd.autostretch([linked=True], [shadowsclip, [targetbg]]) Parameters : – linked = True/False => linked channels – shadowclip = shadows clipping point (default is -2.8) – targetbg = target background value (range [0, 1], default is 0.25) Return : – status[0] = True: execution ok /status[0] = False: Aborted Example : status=cmd.autostretch(linked=True) status=cmd.autostretch(shadowsclip=-2.8)Etire automatiquement l’image actuellement chargée, avec des paramètres différents pour chaque canal (non lié) à moins que -linked ne soit fourni.
Les arguments sont optionnels, shadowclip est le point d’écrêtage des ombres, mesuré en unités sigma à partir du pic de l’histogramme principal (la valeur par défaut est -2.8), targetbg est la valeur cible de l’arrière-plan, donnant une luminosité finale à l’image, plage [0, 1], la valeur par défaut est 0.25.
Les valeurs par défaut sont celles utilisées dans le rendu Auto-Ajustement à partir de l’interface graphique.
N’utilisez pas la version non liée après l’étalonnage des couleurs, car elle modifierait la balance des blancs
BG
bg
Syntax : status=cmd.bg() Parameters : None Return : – status[0] = True: execution ok /status[0] = False: Aborted – status[1] = background level per layerRetourne le niveau d’arrière-plan de l’image chargée en mémoire
BGNOISE
bgnoise
Syntax : status=cmd.bgnoise() Parameters : None Return : – status[0] = True: execution ok /status[0] = False: Aborted – status[1] = background noise levelRenvoie le niveau du bruit de fond de l’image chargée en mémoire
BINXY
binxy coefficient [-sum]
Syntax : status=cmd.binxy(coefficient,[sum=True]) Parameters : – coefficient = 2 (2×2), 3 (3×3) … – sum = enable sum of pixels is computed else it is the average Return : – status[0] = True: execution ok /status[0] = False: Aborted Example : status=cmd.binxy(2) status=cmd.binxy(3,sum=True)Calcule le binning numérique de l’image en mémoire (somme des pixels 2×2, 3×3…, comme le binning analogique des caméras CCD).
Si l’argument facultatif -sum est passé, alors la somme des pixels est calculée, tandis que c’est la moyenne lorsque aucun argument facultatif n’est fourni
BOXSELECT
boxselect [-clear] [x y width height]
Syntax : status=cmd.boxselect([clear=True] [x y width height]) status=cmd.boxselect() Parameters : – x,y = coordinates of the image area – width = width of the image area – height = height of the image area – clear = deletes any selection area. Return : – status[0] = True: execution ok /status[0] = False: Aborted – status[1] = ( x, y, width,height) if no parameter and a selection is active else () Example : status=cmd.boxselect(2,3,56,35) status=cmd.boxselect() status=cmd.boxselect(clear=True)Créer une zone de sélection dans l’image actuellement chargée avec les arguments ** x**, y, width et ** height**, où x et y sont les coordonnées du coin supérieur gauche commençant à (0, 0), et width et ** height**, la taille de la sélection.
L’argument -clear supprime toute zone de sélection. Si aucun argument n’est transmis, la sélection actuelle est affichée
CALIBRATE
calibrate sequencename [-bias=filename] [-dark=filename] [-flat=filename] [-cc=dark [siglo sighi] || -cc=bpm bpmfile] [-cfa] [-debayer] [-fix_xtrans] [-equalize_cfa] [-opt] [-all] [-prefix=] [-fitseq]
Syntax : status=cmd.calibrate(sequencename, [bias=filename], [dark=filename], [flat=filename], [cc=dark [siglo sighi] || cc=bpm bpmfile] [cfa], [debayer=True], [fix_xtrans=True], [equalize_cfa=True], [opt=True], [prefix=xxx],[fitseq=True] ) Parameters : – sequencename = basename of input images – bias = master-bias filename – dark = master-dark filename – flat = master-flat filename – cc = cosmetic correction – siglo = sigma low if cc=dark – sigHi = sigma high if cc=dark – bpmfile = ‘Bad Pixels Map’ file if cc=bpm – cfa = the images are CFA type – debayer = debayerised – fix_xtrans = option to X-Trans files – equalize_cfa = option to equalize CFA images – opt = to optimize the dark subtraction – all = force processing of all frame – prefix = set the prefix of output images – fitseq = save in a multi-image FIT file Return : – status[0] = True: execution ok /status[0] = False: AbortedCalibre la séquence sequencename en utilisant les bias, dark et flat donnés en argument.
Pour les bias, un niveau uniforme peux être spécifié à la place d’une image, en entrant une expression entre guillemet commençant par le signe = tel que -bias= »=256″ ou -bias= »=64*$OFSFSET ».
Par défaut, la correction cosmétique n’est pas activée. Si vous voulez en appliquer une, vous devez le spécifier avec l’option -cc=.
Vous pouvez utiliser l’option -cc=dark pour détecter les pixels chauds et froids à partir du master dark (un master dark doit être fourni avec l’option -dark=), éventuellement suivi de siglo et sighi pour les pixels froids et chauds respectivement.
Une valeur de 0 désactive la correction.
Si les sigmas ne sont pas fournis, seule la détection des pixels chauds avec un sigma de 3 sera appliquée.
Alternativement, vous pouvez utiliser l’option -cc=bpm suivie du chemin vers votre carte de mauvais pixels pour spécifier quels pixels doivent être corrigés.
A noter : un fichier d’exemple peut être obtenu avec la commande find_hot sur un master dark.
Trois options s’appliquent aux images couleur (au format CFA) :
-cfa pour les corrections cosmétiques, -debayer pour dématricer les images avant de les enregistrer -equalize_cfa pour égaliser l’intensité moyenne des couches RVB du flat maître, afin d’éviter de teinter l’image calibrée.
L’option -fix_xtrans est dédiée aux fichiers X-Trans en appliquant une correction sur les Darks et les Biais/offset pour supprimer un vilain motif carrée.
Il est aussi possible d’optimiser la soustraction des dark avec -opt, qui nécessite la fourniture des fichiers maîtres d’offset et de dark.
Par défaut, les images marquées comme exclues ne sont pas traitées. L’argument -all peut être utilisé pour forcer le traitement de toutes les images même si elles sont marquées comme exclues.
Le nom de la séquence de sortie comme par le préfixe « pp_ » sauf indication contraire spécifié avec l’option -prefix=.
Si -fitseq est fourni, la séquence de sortie sera une séquence FITS (fichier unique)
CALIBRATE_SINGLE
calibrate_single imagename [-bias=filename] [-dark=filename] [-flat=filename] [-cc=dark [siglo sighi] || -cc=bpm bpmfile] [-cfa] [-debayer] [-fix_xtrans] [-equalize_cfa] [-opt] [-prefix=]
Syntax : status=cmd.calibrate_single(imagename, [bias=filename], [dark=filename], [flat=filename], [cc=dark [siglo sighi] || cc=bpm bpmfile] [cfa], [debayer=True], [fix_xtrans=True], [equalize_cfa=True], [opt=True], [prefix=xxx] ) Parameters : – imagenane = basename of input image – bias = master-bias filename – dark = master-dark filename – flat = master-flat filename – cc = cosmetic correction – siglo = sigma low if cc=dark – sigHi = sigma high if cc=dark – bpmfile = ‘Bad Pixels Map’ file if cc=bpm – cfa = the images are CFA type – debayer = debayerised – fix_xtrans = option to X-Trans files – equalize_cfa = option to equalize CFA images – opt = to optimize the dark subtraction – prefix = set the prefix of output images Return : – status[0] = True: execution ok /status[0] = False: AbortedCalibre l’image imagename en utilisant les bias, dark et flat donnés en argument.
Pour les bias, un niveau uniforme peux être spécifié à la place d’une image, en entrant une expression entre guillemet commençant par le signe = tel que -bias= »=256″ ou -bias= »=64*$OFSFSET ».
Par défaut, la correction cosmétique n’est pas activée. Si vous voulez en appliquer une, vous devez le spécifier avec l’option -cc=.
Vous pouvez utiliser l’option -cc=dark pour détecter les pixels chauds et froids à partir du master dark (un master dark doit être fourni avec l’option -dark=), éventuellement suivi de siglo et sighi pour les pixels froids et chauds respectivement. Une valeur de 0 désactive la correction. Si les sigmas ne sont pas fournis, seule la détection des pixels chauds avec un sigma de 3 sera appliquée.
Alternativement, vous pouvez utiliser l’option -cc=bpm suivie du chemin vers votre carte de mauvais pixels pour spécifier quels pixels doivent être corrigés. Un fichier d’exemple peut être obtenu avec la commande find_hot sur un master dark.
Trois options s’appliquent aux images couleur (au format CFA) : -cfa pour les corrections cosmétiques, -debayer pour dématricer les images avant de les enregistrer, et -equalize_cfa pour égaliser l’intensité moyenne des couches RVB du flat maître, afin d’éviter de teinter l’image calibrée.
L’option -fix_xtrans est dédiée aux fichiers X-Trans en appliquant une correction sur les Darks et les Biais/offset pour supprimer un vilain motif carrée.
Il est aussi possible d’optimiser la soustraction des dark avec -opt, qui nécessite la fourniture des fichiers maîtres d’offset et de dark.
Le nom du fichier de sortie comme par le préfixe « pp_ » sauf indication contraire spécifié avec l’option -prefix=
CAPABILITIES
capabilities
Syntax : status=cmd.capabilities() Parameters : None Return : – status[0] = True: execution ok /status[0] = False: Aborted – status[1] = capabilitiesAffiche les fonctionnalités de Siril, en fonction de la compilation et de l’exécution
CATSEARCH
catsearch name
Syntax : status=cmd.catsearch(star_name) Parameters : star_name Return : – status[0] = True: execution ok /status[0] = False: Aborted – status[1] = logRecherche un objet par nom et l’ajoute au catalogue d’annotations de l’utilisateur. L’objet est d’abord recherché dans les catalogues d’annotations, s’il n’est pas trouvé, une demande est faite à SIMBAD.
L’objet peut être un objet du système solaire, auquel cas le préfixe « a : » pour astéroïde, « p : » pour planète ou « c : » pour comète est nécessaire, et la recherche est effectuée sur la base de la date et de la position de la Terre figurant dans l’en-tête de l’image, à l’aide du service Miriade de l’IMCCE
CD
cd directory
Définit le nouveau répertoire de travail courant.L’argument directory peut contenir le jeton ~, qui est remplacé par le répertoire personnel, les répertoires comportant des espaces dans leur nom peuvent être protégés en utilisant des guillemets simples ou doubles
CDG
cdg
Renvoie les coordonnées du centre de gravité de l’image. Seuls les pixels dont la valeur est supérieure à 15,7% de l’ADU maximale et dont les quatre voisins remplissent les mêmes conditions sont utilisés pour le calculer, et il n’est calculé que s’il y en a au moins 50CLAHE
clahe cliplimit tileSize
Égalise l’histogramme d’une image en utilisant l’égalisation d’histogramme par contraste adaptatif limité.cliplimit définit le seuil pour la limitation du contraste.
tilesize définit la taille de la grille pour l’égalisation d’histogramme. L’image d’entrée sera divisée en tuiles rectangulaires de taille égale
CLOSE
close
Ferme correctement l’image ou la séquence ouverte, le cas échéantCONVERT
convert basename [-debayer] [-fitseq] [-ser] [-start=index] [-out=]
Convertit toutes les images du répertoire de travail actuel qui sont dans un format supporté en séquence d’images FITS de Siril (plusieurs fichiers) ou en séquence FITS (un seul fichier) si -fitseq est fourni ou en séquence SER (un seul fichier) si -ser est fourni. L’argument basename est le nom de base de la nouvelle séquence, les nombres et l’extension seront mis derrière.
Pour les images FITS, Siril essaiera de faire un lien symbolique ; si ce n’est pas possible, les fichiers seront copiés. L’option -debayer applique le dématriçage aux images d’entrée CFA ; dans ce cas, aucun lien symbolique n’est effectué.
-start=index définit le numéro d’index de départ, utile pour continuer une séquence existante (non utilisé avec -fitseq ou -ser ; assurez-vous de supprimer ou d’effacer le .seq cible s’il existe dans ce cas).
L’option -out= modifie le répertoire de sortie en fonction de l’argument fourni.
Voir aussi CONVERTRAW et LINK