HESSI Flare List Utilities


Here is a list of some handy routines associated with the HESSI flare list.  For a complete description of these routines and their calling arguments, please refer to the documentation in the header of each routine (the .pro file).  To see the documentation in IDL, type
doc_library, 'routine'

 These routines read the HESSI flare list file (hessi_flare_list.fits) that is in the directory pointed to by the HSI_FLARE_LIST_ARCHIVE environment variable. These routines use the Flare List Object and methods, but are easier to use than using the object directly and provide additional searching and formatting capabilities.   For a description of how to use the Flare List Object and methods directly, click here

Note: the Flare List Object returns a structure of flare parameters named hsi_flarelistdata, while these routines return a structure named hsi_flarelistdata_ext, which is an extended version of hsi_flarelistdata (a few derived quantities like flare duration, radial distance are added).

Routines:
    hsi_read_flarelist
    hsi_getflare
    hsi_whichflare
    hsi_select_flare
    hsi_format_flare
    hsi_flarecat


 

hsi_read_flarelist

Purpose:  Function to return the entire HESSI flare list in a structure.  Also returns the info structure for the flare list if the info keyword is used.

Calling examples:
    flares = hsi_read_flarelist()
    flares = hsi_read_flarelist(info=flare_info, /force, err_msg=err_msg)
    help, flares, /structure

hsi_getflare

Purpose:  Function to return the structure for specified flares, and optionally a text description summarizing the flare(s) (a string including start, end, peak times and peak rate).

Calling examples:
    flares = hsi_getflare(2090203)
    flares = hsi_getflare( [2090203, 2090204, 2090220], desc=desc)

hsi_whichflare

Purpose: Function to return flare number of flares whose start/end time overlaps with the time range specified. If the only_one keyword is set, then it returns the flare number of the single flare whose peak time is closest to the center of the time interval.  If no flares were found in the time range, and the closest keyword is set, then it returns the flare number of the flare closest to the time range.  If the structure keyword is set, then returns the flare structure(s) instead of the flare number(s).  Instead of a time_range, you can instead pass in a hessi object from which the absolute_time_range (or if not found, the obs_time_interval) will be extracted and used as the time range.

Calling examples:
    time_range = ['2002/9/2 00:00', '2002/9/2 12:00']
    flares = hsi_whichflare(time_range)
    flare_str = hsi_whichflare(time_range, /only_one, /structure)
    flare_str = hsi_whichflare(time_range, /closest, /structure)

    flares = hsi_whichflare (image_obj, /closest)

hsi_select_flare

Purpose:  Function to select flares based on  flare parameter values.  Keywords for specifying allowed range are constructed by appending '_range' to the parameter name.  For a list of parameter names, type
    help, hsi_read_flarelist(), /structure
For example, to select by flare number (parameter name is id_number), use the keyword id_number_range.  Note:  only parameters that are a scalar can be searched in this manner.
Normally returns an array of flare numbers.  If structure keyword is set, then returns an array of flare structures.  If the formatted keyword is set, then returns an ASCII flare list.

Calling examples:
    flares = hsi_select_flare( id_number_range=[2090202, 2090220] )
    flares = hsi_select_flare( x_position_range=[400,700], /structure)
    flares = hsi_select_flare(radial_dist_range=[300,900], $
            peak_countrate_range=[1000,2000], /formatted)

hsi_format_flare

Purpose:  Function to return an ASCII list of flare parameters.  If flares keyword not specified, then returns list of all flares in catalog.  Use prstr to view the list.  Use the sort_field keyword to sort the list by any parameter.

Calling examples:
    list = hsi_format_flare()
    prstr, list
    list = hsi_format_flare(/noheader, /notrailer)
    list = hsi_format_flare(flares=[2090203, 2090204, 2090220], sort_field='peak_countrate', /descending)
 

hsi_flarecat

Purpose:  Widget program to select and display flares.  Using the widget, select ranges of parameters, then click Select Flares.  After clicking Close, the flares that were listed are returned in the list parameter, as flare numbers,  flare structures, or an ASCII flare list.

Calling examples:
    hsi_flarecat, list=list
    hsi_flarecat, list=list, /structure
    hsi_flarecat, list=list, /formatted

 

 

Last updated 11 October 2004 by Kim Tolbert , 301-286-3965