-------------------------------------------- User Guide for the HFC IDL client software -------------------------------------------- Requirements ------------ IDL 6.x or higher must be installed on the system. 1 - How to install the IDL client --------------------------------- Download the client file 'hfc_idl_client.sav' from one of the following web sites: - http://voparis-helio.obspm.fr/hfc-gui/api/hfc_idl_client.sav (HFC main site) 2 - How to run the IDL client ----------------------- To restore the IDL client routines, enter the following command: RESTORE,'/path_to_file/hfc_idl_client.sav',/VERBOSE , where path_to_file is the path of the directory where the hfc_idl_client.sav file is stored. A list of use cases is provided at the end of this document. The source files of IDL routines saved in hfc_idl_client.sav can be found here: http://sourceforge.net/p/helio-vo/code/HEAD/tree/trunk/helio-hfc/helio-hfc-client/hfc-idl-client/src/ Feedback ------- Any feedback is welcome, please contact xavier dot bonnin at obspm dot fr. List of use cases ---------------------------------------------------------------- 1 - Display the help message of a routine (here get_feature): empty=hfc_get_feature(/HELP) 2 - Get the list of type of content/feature available in the HFC: hfc_content=hfc_get_content() 3 - Get the list of HFC tables that can be queried with the HFC client for each type of features: hfc_tables=hfc_get_tables() 4 - Open the HFC query web page in Google Chrome : hfc_url= hfc_get_gui(/OPEN,browser='Google\ Chrome') 5 - Open the Helio Project web page in Firefox: hfc_url= hfc_get_gui(/OPEN,/HELIO) 6 - Get the list and description of the feature recogniton codes used to populate the HFC: frc=hfc_get_code() 7 - Get sunspots data from SDO/HMI near 01 January 2011 at midnight UT: hfc_ss_data = hfc_get_feature('sunspots',near_date='2011-01-01T00:00:00', $ observatory='SDO',instrument='HMI') 8 - Get observation data from SoHO/EIT between 05 April 2008 at 22:55:00 UT and 10 April 2008 at 12:00:00 UT: hfc_eit_data = hfc_get_observation(observatory='SoHO',instrument='EIT', $ starttime='2001-04-05T22:55:00', $ endtime='2001-04-10T12:00:00') 9 - Download (in /tmp folder) and plot Nancay radioheliograph image for 01 January 2008 at 08:00:00 UT (first way): hfc_nrh_data=hfc_get_observation(observat='Nancay',instrume='Radioheliograph', $ near_date='2008-01-01T08:00:00') hfc_show,hfc_nrh_data,qclk_dir='tmp' 10 - Download (in /tmp folder) and plot Nancay radioheliograph image for 01 January 2008 at 08:00:00 UT (second way): hfc_show,observat='Nancay',instrume='Radioheliograph', $ near_date='2008-01-01T08:00:00',qclk_dir='tmp' 11 - Download SDO/HMI (magnetogram and continuum) quicklook images on 14 April 2012 at noon UT into the /tmp folder: qclk_url=hfc_get_quicklook(instrument='HMI',near_date='2012-04-14T12:00:00', $' target_directory='tmp',/DOWNLOAD_FILE) 12 - Download SoHO/EIT data file on 15 February 2002 at 15:00:00 UT into the /tmp folder: url=hfc_get_datafile(instrument='EIT',observat='SoHO',near_date='2002-02-15T15:00:00', $ target_directory='tmp',/DOWNLOAD_FILE) ---------------------------------------------------------------- ---------------------------------------------------------------- The following usecases call a mysql client assuming the host server of the HFC database is accessible from the local machine (only for HFC developers): 13 - Return a IDL structure containing the content of the FRC_INFO table: Result=mysql_client('select * from FRC_INFO',database='hfc1test',host="localhost",user="root",/struct) 14 - Return a IDL structure providing the columns description of the VIEW_FIL_HQI table: Result=mysql_client('describe VIEW_FIL_HQI',database='hfc1test',host="localhost",user="root",/struct) 15 - Return a string array containing the values of FEAT_ELONG column in the VIEW_FIL_HQI table: Result=mysql_client('select FEAT_ELONG from VIEW_FIL_HQI',database='hfc1test',host="localhost",user="root")