From EOVSA Wiki
Jump to: navigation, search

GSFITCP is the command prompt counterpart of the GSFIT GUI microwave spectral fitting application. Once started, GSFITCP is designed to run in unattended mode until all fitting tasks assigned to it are completed and log on the disk in an user-defined *.log file, the content of which may be visualized using the GSFITVIEW GUI application. When run remotely on an Linux/Mac platform, the GSFITCP may be launched on a detached screen, which allows the remote user to logout without stopping the process in which GSFITCP runs.

GSFITCP Installation

GSFITCP is part of the GSFIT IDL Package

To get installation instructions for the IDL GSFIT package, please visit the GSFIT Installation page.

Launching the GSFITCP command prompt application

To obtain a list of valid GSFIT calling sequences one may call gsfitcp with no arguments:

IDL> gsfitcp
% GSFITCP: For a detailed description visit, or use one of the folowing calling sequences:
% IDL-> gsfitcp, taskfilename; to provide a path to a stored GSFIT task stracture
% IDL-> gsfitcp, taskstructure; to provide an already restored GSFIT task structure
% IDL-> gsfitcp, nthreads; to set,increase, or decrease the number of ashyncronious threads to be used
% IDL-> gsfitcp, out=out,log; to change the default "gsfitcp.log" path for run-time logging of the results.
% IDL-> gsfitcp, /status; to report the status of the application
% IDL-> gsfitcp, /quiet; to inhibit automatic printing of progress report messages at run-time
% IDL-> gsfitcp, /start; to start processing the task queue
% IDL-> gsfitcp, /flush; to flush the pending task queue
% IDL-> gsfitcp, /abort; to abort all active tasks and flush the pending task queue
% IDL-> gsfitcp, /exit; to abort all active tasks, flush the pending task queue, and exit the apllication
% GSFITCP: % Any logical combination of the arguments and keywords listed above should result in a valid single-line calling sequence

NOTE: GSFITCP processes all fittings task in at least one asynchronous parallel thread. Therefore, the IDL command line should remain active for other tasks while GSFITCP is running in the background. However, to avoid any clashes with automatic progress report messages printed by GSFIT at the IDL console any time a parallel thread returns a result, the IDL-> gsfitcp, /quiet command may be issued at any time. Use IDL-> gsfitcp, quiet=0 to turn these run-time messages back on.

Visualizing the GSFITCP results

Visualizing the GSFITCP results using the GSFITVIEW GUI application

While processing its fit task queue, GSFITCP continuously logs the individual pixel-based solutions, as they are returned by the parallel thread to which they are assigned. The default GSFITCP log file, called gsfitcp.log is located in the local directory. However, the user may set a different log file using the command

IDL-> gsfitcp, out=out

where out is any valid file path.

To visualize the final or partial fit results at any time, even while gsfitcp is still running in the background use

IDL> gsfitview, 'cplog' 

Visit the GSFITVIEW Help page for detailed information about GSFITVIEW GUI functionality.

Command line or programmatic manipulation of the GSFITCP results

The GSFIT package provides a support routine that my be used to restore and convert the GSFITCP fit results to a GSFIT Parameter Maps IDL structure that may be inspected and manipulated at the command line or programmatically.


Visit GSFIT Data Format for detailed information about this data structure.