src/obase/Checkpoint.c File Reference

Data Structures
struct	CheckpointData
Functions
long	getCheckpoint ()
bool	runningWithCheckpoints ()
void	destroyCheckpoint ()
int	removeCheckpoints ()
int	renameCheckpointFile ()
void	setCheckpointInputFile (char *filename)
char *	getCheckpointInputFile ()
void	lookForLatestCkptFile (char *dirName)
void	lookForCkptDir (DIR *dirPtr2, char *dirName)
void	setCheckpoint (long value, char *outputBaseDir, char *versionedOutputBaseDir)
void	writeCheckpoint (MAP_DEPTH_MATRIX w, FITSParameters parms, BaseDirectory *baseName)
bool	creatCheckpointSubDir ()
Variables
static const char	CheckpointConstantCkptDir [] = "ckpt"
static const char	CheckpointConstantCkptFile0 [] = "w_ckpt0.fits"
static const char	CheckpointConstantCkptFile1 [] = "w_ckpt1.fits"
static struct CheckpointData	CheckpointInfo

---

Function Documentation

bool creatCheckpointSubDir

(

)

Create sub-directory inside output base directory. The sub-directory contains the checkpoint files.

void destroyCheckpoint

(

)

Remove all memory associated with checkpoint file and path names.

long getCheckpoint

(

)

char* getCheckpointInputFile

(

)

Return the full path to the latest checkpoint file.

void lookForCkptDir	(	DIR *	dirPtr2,
		char *	dirName
	)

Look for checkpoint directory

Parameters:

[in]	dirPtr2	Pointer to starting directory structure
[in]	dirName	Name of starting directory for search.

void lookForLatestCkptFile

(

char *

dirName

)

Look for checkpoint files in the given directory. If any are found, record the full path and file name for use later.

Parameters:

[in]

dirName

Directory in which to look for specially named checkpoint files. Find the most recent one.

int removeCheckpoints

(

)

Remove the checkpoint sub-directory

int renameCheckpointFile

(

)

Rename the checkpoint sub-directory

bool runningWithCheckpoints

(

)

void setCheckpoint	(	long	value,
		char *	outputBaseDir,
		char *	versionedOutputBaseDir
	)

Setup everything for checkpoints. Find existing checkpoint directory for restarting, setup the checkpoint filenames.

Parameters:

[in]	value	Write a checkpoint file after this many iterations of lsqr.
[in]	outputBaseDir	Be sure to send the original output base directory, not the one that has version(s). This is where we'll look for an existing checkpoint directory.
[in]	versionedOutputBaseDir	Path for output base directory. This is where the checkpoint files will go.

void setCheckpointInputFile

(

char *

filename

)

Record the path and name of a previous checkpoint file.

Parameters:

[in]

filename

Full path to a previous checkpoint file.

void writeCheckpoint	(	MAP_DEPTH_MATRIX	w,
		FITSParameters	parms,
		BaseDirectory *	baseName
	)

Write OLA inversion weights, w, to a checkpoint file in a sub-directory.

Parameters:

[in]	w	MAP_DEPTH_MATRIX containing the solution weights.
[in]	parms	FITSParameters contains header parameters and values for FITS file.
[in]	baseName	BaseDirectory structure for managing output file name.

---

Variable Documentation

const char CheckpointConstantCkptDir[] = "ckpt" [static]

const char CheckpointConstantCkptFile0[] = "w_ckpt0.fits" [static]

const char CheckpointConstantCkptFile1[] = "w_ckpt1.fits" [static]

struct CheckpointData CheckpointInfo [static]

Initial value:

 {
                0,
                NULL,
                NULL,
                NULL,
                NULL
}

Initial values for the checkpoint data.