next up previous contents
Next: Additional tools Up: Data analysis steps Previous: Image reconstruction - SPISKYMAX   Contents


Cleaning Tool - SPI_CLEAN

Run the SPI cleaning tool spi_clean, to remove all previous pipeline products:

spi_clean obs_group="og_spi.fits[1]" endlevel=PRP

Note that spi_clean is much faster than og_clean, but it only works on SPI data It is launched automatically by the by the pipeline when necessary.

spi_clean checks all entries in the OG (og_spi.fits). All entries that have a higher level than the requested end level are detached from the OG and deleted. If in force mode, spi_clean checks whether the detaching was successful, and if the file still exists, uses the UNIX rm command to delete file.

In force mode, spi_clean is also able to work with corrupted OGs (i.e., if one member of an OG has been manually deleted or renamed) and it will try to fix the OG. In this case, however, it cannot be guaranteed that the cleaning will work properly.

Table: spi_clean parameters
   
Name Type Description
obsgroup string DOL of observation group

default: ``og_spi.fits[GROUPING]''

endlevel string output level of the OG

possible values:``PRP, CAT_I, POIN, BIN_I, BKG_I, IMA, SPE''

default: ``PRP''

chatter integer verbosity level

possible values: 0 - 5

Chatter=5 is for debugging

default: 3

force boolean Force removal of files

possible values:

no - spi_clean will neither work on corrupt OGs, nor delete any files using the system command rm.

yes - spi_clean will also work on broken OGs and delete any detached file using rm. Furthermore, spi_clean will also try to repair a broken OG in the sense that it checks that links in the OG are ok. Corrupt links are removed. The level of the OG is set to the highest level of the children of the OG. Be careful! The results when working on broken OGs can be quite unpredictable.

default: ``yes''

clean_swg boolean Determines whether science window group should also be cleaned (not recommended).

default: ``no''


next up previous contents
Next: Additional tools Up: Data analysis steps Previous: Image reconstruction - SPISKYMAX   Contents
inthelp@sciops.esa.int