gess

gessengine

This module is the core module of GeSS, called by most other modules. It takes as input a working directory path (similar to the working directory for launching a script in Siril) and a dictionnary specifying the options you want to apply.

gess.gessengine.Run(workdir, opt=None, app=None, dryrun=False)

Parameters:

workdir (str) – the path to the working directory.
opt (DictX, optional) – a DictX instance containing all the options for the processing workflow described in the First Steps section, defaults to None. Can be formed as the options member of an Options instance, with optiontype=’gess’. Have a look at gess.cfg settings for a full description of all the options keys.
app (Siril, optional) – a Siril class instance that can be used to call pySiril functions. Pass None if it needs to be started, defaults to None.
dryrun (bool, optional) – flag to stop engine just after starting Siril, if set to True. Used mainly for checking that the options are passed correctly and that the masters can be found, defaults to False.

Returns:

(True if successful, dict with keys specifying inputs and outputs)

Return type:

(bool,dict)

The bool is set to True is the processing was successful.

The dictionnary contains the following keys (if successful):

’dark’: the masterdark that was used (if any)
’flat’: the masterflat that was used (if any)
’offset’: the masteroffset that was used (if any)
’workdir’: the path to the working directory
’options’: the options which were passed
’version’: gess version number
’log’: the path to the session log file if debug was on

Otherwise, if something wrong happened, the dictionnary contains a single key ‘messsage’ detailing where the process failed.

gessi

This module is used to call interactively gess.gessengine. More help on its usage can be found in interactive mode section.

It takes no input and returns the (bool,dict) tuple output by gessengine.

gessmultisession

This module is used to gather calibrated lights from multiple sessions, already processed with gess.gessengine. More help on its usage can be found in multisession mode section.

It can take as input an additional gess-type cfg file (if you have used one for the lights calibration) and returns the (bool,dict) tuple output by gessengine.

gess.gessmultisession.Run(addcfgfile='')

[summary]

Parameters:: addcfgfile (str, optional) – the path to a gess-style additional cfg file, if one was used to calibrate your lights, defaults to ‘’.
Returns:: (True if successful, dict with keys specifying inputs and outputs)
Return type:: (bool,dict)

see gess.gessengine for details on returned values.

gessloop

This module is used to batch-process multiple sessions by calling iteratively gess.gessengine. More help on its usage can be found in loop mode section.

gess.gessloop.Run(addgesscfg='', addloopcfg='', searchstr='')

main function of gessloop.

Parameters:

addgesscfg – the path to a gess-style additional cfg file, defaults to ‘’.
addloopcfg (str, optional) – the path to a loop-style additional cfg file, defaults to ‘’.
searchstr (str, optional) – the string to be searched for in your imaging folder, defaults to ‘’

Returns:

(True if successful, dict with ‘message’ key summarizing the different folders processed)

Return type:

(bool,dict)

gesscopyback

This module is used to copy calibrated lights around, most likely after having processed them with gess.gessloop. More help on its usage can be found in copyback mode section.

gess.gesscopyback.Run(addgesscfg='', addloopcfg='', searchstr='', addcopybackcfg='')

main function of gesscopyback.

Parameters:

addgesscfg – the path to a gess-style additional cfg file, defaults to ‘’.
addloopcfg (str, optional) – the path to a loop-style additional cfg file, defaults to ‘’.
searchstr (str, optional) – the string to be searched for in your imaging folder, defaults to ‘’
addcopybackcfg (str, optional) – the path to a copyback-style additional cfg file, defaults to ‘’

Returns:

(True if successful, dict with ‘log’,’in’ and ‘out’ keys listing files which have been copied)

Return type:

(bool,dict)