Directory Listing of Routines

projects/sosmag

SOSMAG_CSV_CRIB
SOSMAG_CSV_TO_TPLOT
SOSMAG_LOAD_CSV

Routine Descriptions

SOSMAG_CSV_CRIB

 Procedure:
  sosmag_csv_crib

 Purpose:
  Demonstrate how to load and plot SOSMAG data using a CSV file.

 $LastChangedBy: nikos $
 $LastChangedDate: 2023-09-07 09:09:32 -0700 (Thu, 07 Sep 2023) $
 $LastChangedRevision: 32087 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_6_1/projects/sosmag/sosmag_csv_crib.pro $

(See projects/sosmag/sosmag_csv_crib.pro)

SOSMAG_CSV_TO_TPLOT

[Previous Routine] [Next Routine] [List of Routines]

 Procedure:
         sosmag_csv_to_tplot

 Purpose:
         Load SOSMAG data from a structure s into tplot variables

 Keywords:
         s : a structure with sosmag data, usually the result of read_csv()
         tformat (optional): string, time format, for example 'DD.MM.YYYY hh:mm:ss'
                             default time format is 'YYYY-MM-DDThh:mm:ss.fffZ'
                             for more details, see time_struct.pro
         desc (optional): string, description of the data
         prefix (optional): string, prefix for tplot variables
         suffix (optional): string, suffix for tplot variables

 Notes:

 Fields in the CSV files:
 [{"name":"utc","type":"isotime","length":24,"units":"UTC","fill":null,"description":"Timestamp in coordinated Universal Time (UTC)"},
 {"name":"version","type":"double","units":"dimensionless","fill":null,"description":"Data version identifier"},
 {"name":"b_gse_x","type":"double","units":"nT","fill":"NaN","description":"Magnetic Field B in GSE coordinates (X component)"},
 {"name":"b_gse_y","type":"double","units":"nT","fill":"NaN","description":"Magnetic Field B in GSE coordinates (Y component)"},
 {"name":"b_gse_z","type":"double","units":"nT","fill":"NaN","description":"Magnetic Field B in GSE coordinates (Z component)"},
 {"name":"b_hpen_p","type":"double","units":"nT","fill":"NaN","description":"Magnetic Field B in HPEN coordinates (P component)"},
 {"name":"b_hpen_e","type":"double","units":"nT","fill":"NaN","description":"Magnetic Field B in HPEN coordinates (E component)"},
 {"name":"b_hpen_n","type":"double","units":"nT","fill":"NaN","description":"Magnetic Field B in HPEN coordinates (N component)"},
 {"name":"position_x","type":"double","units":"km","fill":"NaN","description":"Spacecraft Position in GSE (X component)"},
 {"name":"position_y","type":"double","units":"km","fill":"NaN","description":"Spacecraft Position in GSE (Y component)"},
 {"name":"position_z","type":"double","units":"km","fill":"NaN","description":"Spacecraft Position in GSE (Z component)"},
 {"name":"data_flags","type":"double","units":"dimensionless","fill":null,"description":"Data flags, see InformationURL"},
 {"name":"final","type":"double","units":"dimensionless","fill":null,"description":"Calibration status, see InformationURL"},
 {"name":"frequency","type":"double","units":"dimensionless","fill":null,"description":"Current sampling frequency"}],

 Dataset description:
 "description":"Recalibrated L2 Magnetic Field Data with 1-16Hz from SOSMAG on GEO-KOMPSAT-2A in geostationary orbit at 128.2E."
 "description":"Near-realtime Magnetic Field Data with 1-16Hz from SOSMAG on GEO-KOMPSAT-2A in geostationary orbit at 128.2E."

 See also:
   sosmag_load_csv.pro
 
 $LastChangedBy: nikos $
 $LastChangedDate: 2023-09-07 09:09:32 -0700 (Thu, 07 Sep 2023) $
 $LastChangedRevision: 32087 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_6_1/projects/sosmag/sosmag_csv_to_tplot.pro $

(See projects/sosmag/sosmag_csv_to_tplot.pro)

SOSMAG_LOAD_CSV

[Previous Routine] [List of Routines]

 Procedure:
         sosmag_load_csv

 Purpose:
         Load SOSMAG data from a local CSV file into tplot variables

 Keywords:
         filename : the csv filename, including the full path
         tformat (optional): string, time format, for example 'DD.MM.YYYY hh:mm:ss'
                             default time format is 'YYYY-MM-DDThh:mm:ss.fffZ'
         desc (optional): string, description of the data
         prefix (optional): string, prefix for tplot variables
         suffix (optional): string, suffix for tplot variables

 Notes:
   First, the user must register at the ESA web site, then download a csv file to his computer,
   and then he can load the csv file data into SPEDAS using "sosmag_load_csv, filename".

   To register, the user can go to the following web site and click on "capabilities".
     https://swe.ssa.esa.int/hapi/
   A new page will appear which includes links for registration.

   To download data as csv files, the user can use a web browser with the ESA HAPI web server.
   For example, the following URL downloads calibrated data (data product esa_gk2a_sosmag_recalib) for 2021/01/31 1am to 2am UTC:
   https://swe.ssa.esa.int/hapi/data?id=spase://SSA/NumericalData/GEO-KOMPSAT-2A/esa_gk2a_sosmag_recalib&time.min=2021-01-31T01:00:00.000Z&time.max=2021-01-31T02:00:00.000Z&format=csv

   And the following downloads real-time data (data product esa_gk2a_sosmag_1m):
   https://swe.ssa.esa.int/hapi/data?id=spase://SSA/NumericalData/GEO-KOMPSAT-2A/esa_gk2a_sosmag_1m&time.min=2021-01-31T01:00:00.000Z&time.max=2021-01-31T02:00:00.000Z&format=csv

   See also:
     sosmag_csv_to_tplot.pro
 
 $LastChangedBy: nikos $
 $LastChangedDate: 2023-09-07 09:09:32 -0700 (Thu, 07 Sep 2023) $
 $LastChangedRevision: 32087 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_6_1/projects/sosmag/sosmag_load_csv.pro $

(See projects/sosmag/sosmag_load_csv.pro)