Difference between revisions of "GSFIT GUI Organization and Functionality"

From EOVSA Wiki
Jump to: navigation, search
(Created page with "=GSFIT Help Page= The GSFIT GUI is organized in three main sections: * [http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFIT_Top_Main_Menu_Toolbar GSFIT...")
 
(GSFIT GUI Help)
 
(137 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=GSFIT Help Page=
 
The GSFIT GUI is organized in three main sections:
 
  
* [http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFIT_Top_Main_Menu_Toolbar GSFIT Top Main Menu Toolbar], which may be used to perform most of the actions.
 
* [http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFIT_Left_Panel GSFIT Left Panel], which displays a microwave map corresponding to the observing frequency and time instance selected via two horizontal scroll bars.
 
* [http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFIT_Middle_Panel GSFIT Middle Panel], which displays the microwave spectrum corresponding to the selected pixel in the right panel map.
 
* [http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFIT_Right_Panel GSFIT Right Panel], which consists of three main elements:
 
**[http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFIT_List_Scrollbar GSFIT List Scrollbar], which allows the user to locate spatially and temporarily the fit already performed and inspect the fit results
 
**[http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFIT_Settings GSFIT Settings page], which allows the user to setup a series of the spectral fit options and perform some actions via a local Toolbar menu.
 
**[http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFIT_Task_Queue GSFIT Task Queue page], which displays a list of completed, active, and pending fitting tasks.
 
 
 
==GSFIT Top Main Menu Toolbar==
 
This toolbar contain a series of action buttons described below.
 
 
===[[File:open.png|border]] Upload EOVSA Map Cube===
 
EOVSA map cubes are IDL sav files containg a [ntimes x nfrequencies] brightness temperature (Tb) map structure. 
 
Follow this [http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#Spectral_Imaging_with_SunCASA link] to learn how such EOVSA map cubes are produced. When uploaded, GSFIT converts these Tb maps to Solar Flux (total intensity or circular polarization) maps.
 
===[[File:color.png|border]] Select Color Table===
 
Use this button to select a color table for displaying the microwave maps and spectra. GSFIT uses as default the IDL color table #39 (Rainbow+White)
 
===[[File:mousemode.png|border]]Select Mouse Mode===
 
Use this set of mutual exclusive radio buttons to switch between four modes of mouse tool operation.
 
*'''FOV/Pixel Selection Mode''': Use this mouse mode to zoom in and out the field of view (FOV) of the microwave maps displayed on the [http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFIT_Left_Panel GSFIT Left Panel], or to select the pixel for which the microwave spectrum is displayed in the[http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFIT_Middle_Panel GSFIT Middle Panel].
 
**To zoom in, press, hold, move, and release the left mouse button to select the desired rectangular FOV (rubber-band selection process). To revert to the full FOV, use a single left-button click.
 
**Use the right button to select a map pixel on the [http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFIT_Left_Panel GSFIT Left Panel]. The currently selected pixel is indicated by a set og horizontal and vertical dotted lines. Alternatively, the pixel may be selected using the ''Cursor X'' and ''Cursor Y'' numerical controls located below the map plot area.
 
*'''Rectangular ROI Selection Mode''': Use this mouse mode to define a rectangular region of interest (ROI) through a left button rubber-band selection process. The selected ROI is preserved and displayed as long it is not replaced by another ROI selection, or deleted by a single left button click.
 
*'''Polygonal ROI Selection Mode''': Use this mouse mode to define the vertices of polygonal ROI through a series of sequential left button clicks. To finalize the process, use a right button click to define the last vertex, which will be automatically connected with the first one. The selected ROI is preserved and displayed as long it is not replaced by another ROI selection, or deleted by a single left button click.
 
*'''Free-hand ROI Selection Mode''': Use this mouse mode to define an arbitrarily shaped ROI contour through a continues movement of the mouse cursor while the left button is pressed. To finalize the process, release the left button to define the last vertex of the countour, which will be automatically connected with the first one. The selected ROI is preserved and displayed as long it is not replaced by another ROI selection, or deleted by a single left button click.
 
 
===[[File:SaveROI.png|border]]Save ROI===
 
Use this button to save to an IDL file the current ROI selection as a set of two arrays, xroi and yroi, containing its vertex heliocentric coordinates.
 
===[[File:RestoreROI.png|border]]Restore ROI===
 
Use this button to import from an IDL file a set of xroi and yroi ROI vertex coordinates previously saved by GSFIT, or generated by alternative means.
 
===[[File:FreqRange.png|500px]]Select Fit Frequency Range===
 
Use this set off drop lists controls to select the frequency range to be used for spectral fitting. By default, the full frequency range is selected when a map data cube is uploaded, but the user may choose to restrict this default frequency range for various reasons, such as data quality, or apparent source nonuniformity.
 
 
===[[File:FitPixel.png|border]]Fit Selected Pixel===
 
Use this button to fit the microwave spectrum displayed on the [http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFIT_Middle_Panel GSFIT Middle Panel] using the [http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#Select_Fit_Frequency_Range selected fit frequency range] and the settings displayed on the [http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFIT_Settings GSFIT Settings] panel.
 
 
===[[File:FitRange.png|border]]Fit Range===
 
Use this button to perform one or more of the following actions:
 
*Define a rectangular ROI starting at the current cursor position, if no ROI has been previously defined
 
*Select a time range and time resolution for producing a sequence of fits for each ROI pixel
 
*Ignore the current ROI and Time Range selections and choose instead to fit the entire map cube
 
*Use or change the current FIT Frequency Range selection
 
*Enqueue and start processing the fitting of all ROI pixels over the user-defined time interval (default)
 
*Enqueue and Wait for future processing of the fit task of all ROI pixels over the user-defined time interval
 
*Generate and save the fit task for future batch processing by the GSFIT Command Prompt ([http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFITCP_Batch_Mode_Application GSFITCP]) application.
 
Depending on whether or not a ROI is already defined, the user is exposed to a different dialog box to define a fitting task.
 
<gallery widths=500px heights=500px >
 
File:FitCube.png|Fit Task Dialog Box if no ROI has been already defined
 
File:FitROI.png|Fit Task Dialog Box if a ROI has been already defined
 
</gallery>
 
 
To enqueue the fit tasks for immediate or future processing by GSFIT, the following rules are followed:
 
 
*All ROI spectra from a given time frame are processed simultaneously by being as evenly as possible assigned to all active asynchronous parallel threads
 
 
*The individual time frames are enqueued and processed sequentially
 
 
An example about how the tasks are scheduled is provided in the  [http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFIT_Task_Queue GSFIT Task Queue] section.
 
 
'''NOTE: If a fit task is saved for future batch processing, the scheduling is performed at runtime by the GSFIT Command Prompt'''
 
([http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFITCP_Batch_Mode_Application GSFITCP]) '''application using the number of active parallel threads available to it.'''
 
 
===[[File:ProcessPendingTasks.png|border]]Process Pending Tasks===
 
Use this button to start processing all pending tasks in the [http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFIT_Task_Queue GSFIT Queue]
 
 
===[[File:AbortDeleteTasks.png|border]]Abort/Delete Tasks===
 
Use this button to select one of the options from the Delete Options dialog box.
 
 
[[File:DeleteOptions.png|400px|Abort/Delete Tasks Dialog]]
 
 
==GSFIT Left Panel==
 
<gallery widths=500px heights=500px>
 
 
File:LeftPanel.png|Selected EOVSA map displayed with no Integrated Flux Threshold applied
 
File:LeftPanelTh.png|Selected EOVSA map displayed with 1 sfu Integrated Flux Threshold applied
 
</gallery>
 
 
==GSFIT Middle Panel==
 
<gallery widths=400px heights=400px >
 
Image:MiddlePanel.png|Spectral plot with overlaid Fast Code guess parameters solution (cyan)
 
Image:MiddlePanelG.png|Spectral plot with overlaid GSFIT (green) and Fast Code (cyan) guess parameters solutions
 
Image:MiddlePanelFC.png|Spectral plot with overlaid GSFIT (green) and Fast Code (cyan) solutions
 
</gallery>
 
 
==GSFIT Right Panel==
 
The GSFIT Right Panel consists of three main elements described below.
 
 
[[File:RightPanel.png|GSFIT Right Panel]]
 
 
===GSFIT List Scrollbar===
 
This scrollbar may be used to navigate through the list of already computed fit solutions, if any. The scrollbar displays the selected solution index and the total number of computed solutions. These fit solutions are indexed in the order in which they are processed by the Task Queue, thus they may not be necessarily clustered in space or time.
 
 
Upon selection of a particular fit index the following actions are automatically performed:
 
*The time frame corresponding to the fit is selected and displayed on the Time Scrollbar
 
*The corresponding data map at the frequency currently selected by the Frequency Scrollbar is displayed in the Left Panel
 
*The Right Panel cursor is moved to the corresponding pixel position, which is also displayed by the Cursor X and Cursor Y controls located below the Right Panel plot area
 
*The microwave spectrum corresponding to the selected pixel position and time frame is displayed in the Middle Panel and the fit solution is overlaid.
 
 
Upon selection of a particular pixel and time frame by use of the mouse, numerical cursors, or the time scrollbar that matches an already computed fit solution, the fit solution is overlaid on the Middle Panel spectral plot, and the GSFIT List Scrollbar is moved to the matched fit index.
 
 
===GSFIT Settings===
 
===GSFIT Task Queue===
 
 
This GSFIT Right Panel page displays the current status of the already processed, active, or pending fit tasks.
 
The [http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFIT_Top_Main_Menu_Toolbar GSFIT top menu toolbar] provides several options for controlling the GSFIT Task Queue.
 
 
'''Here we provide an example of how the tasks are enqueued and processed in two diffrent circumstances:'''
 
 
If a 4x4 ROI; 4 time frames is enqueued while only 1 parallel thread is active, only 16 pixels from the same time frame are processed at any given time.
 
If, instead, 4 active threads are used, batches of 4 pixels are processed by 4 asynchronous threads at any given time. Note that, in the case of 4 active threads, the time needed to fully process a given time frame is dictated by the longest time needed to process one of the 4 pixel batched of that frame, which is about half the time needed to process all 16 pixels in a single thread.
 
<gallery widths=400px heights=400px>
 
File:Queue1thread.png|A: GSFIT Queue active processing: 4x4 ROI; 4 time frames; 1 parallel thread
 
File:Queue4threads.png|B: GSFIT Fit Queue active processing: 4x4 ROI; 4 time frames;  4 parallel threads
 
File:Queue4threadsAll.png|C: GSFIT Fit Queue finalized task: 4x4 ROI; 4 time frames;  4 parallel threads
 
</gallery>
 

Latest revision as of 20:12, 10 May 2019