cleanlab Documentation

cleanlab - Attempts to set FILE_STATE to CLEAN
cleanlab is provided (reluctantly) to allow users to attempt to salvage
ISIS files that have not been closed properly.

The I/O for ISIS cube files and table files is buffered, i.e., part of
the data in a file is held in memory and is not actually written to the
file until the file is closed.  This improves processing efficiency.
However, if an application program aborts without properly closing the
file, then there is a possibility that the file contains corrupted data.
When this would happen, the FILE_STATE keyword would be set to "DIRTY"
and most ISIS applications would (until the recent change to the I/O
routines) refuse to process this potentially corrupted data.  cleanlab
will attempt to set the FILE_STATE label keyword to a CLEAN state.

Note that there are conditions under which cleanlab will fail.  If the
circumstances of your file being left in a DIRTY state include label
manipulation, there is a very good chance that the label is corrupted.
Also the HISTORY object may be checked for proper syntax or it can be
cleared.  The INITHIST parameter provides the ability to clear or
initialize the HISTORY object to all spaces thus, destroying the entire
contents of the object.  If either of these tasks fail, then cleanlab
cannot salvage your data file.

I highly recommend limited use of this program especially in cases of
critical scientific data that may have implications on your reputation.
When an ISIS program dies, there is NO way to determine the state of
your data files.  There is alot of data being buffered during processing
of your data.  Label, history and most all binary data is buffered to
some degree.  cleanlab does not perform data integrity checks.  Thus,
cleanlab DOES NOT AND CANNOT GUARANTEE THE DATA INTEGRITY!!!  Please use
this program wisely.

Programmer: Kris Becker, U.S.G.S., Flagstaff, AZ

File name of ISIS file
Default extension: .cub

NONE

Clear the HISTORY object

"NO"

User comment

" "

ADDITIONAL NOTES:

Parm	Description
FROM	The name of the ISIS file that is to be cleaned. The default file extention is ".cub" but cleanlab works on any ISIS PDS labeled file.
INITHIST	This option will reinitialize the HISTORY object to all spaces, thus destroying the contents. This option can be useful for cases where the history is corrupt but the label is basically intact.
USERNOTE	Comment from the user. This will be recorded in the ISIS session log file and also in the History entry that is put into the History object of the output file.