This page was created by the IDL library routine `mk_html_help2`.

Last modified: Sat Jul 26 18:17:38 2025.

# Directory Listing of Routines

# projects/secs

- EIC_ASCII2TPLOT
- EIC_READ_ASCII_DATA
- EICS_OVERLAY_PLOTS
  This routine will create a plot of EICS and THEMIS ASI data which is overlaid onto a map of
- SEC_ASCII2TPLOT
- SEC_READ_ASCII_DATA
- SECA_OVERLAY_PLOTS
  This routine will create a plot of SECA and THEMIS ASI data which is overlaid onto a map of
- SECS_CONFIG_FILEDIR
- SECS_FILECONFIG
  A widget that allows the user to set some of the !secs variable. The user
- SECS_INIT
- SECS_LOAD_DATA
- SECS_READ_CONFIG
  Reads the secs configuration file
- SECS_READ_STATIONS
- SECS_STATIONS2TPLOT
- SECS_WRITE_CONFIG
  Writes the secs_config file

# Routine Descriptions

## EICS_OVERLAY_PLOTS

[Next Routine] [List of Routines]

     NAME:
      eics_overlay_plots

     PURPOSE:
      This routine will create a plot of EICS and THEMIS ASI data which is overlaid onto a map of
      the northern hemisphere. See the SECS ASI mosaic overlay plot crib sheet for an explanation of the
      data and how to use this routine. You can find the crib sheet in spedas/projects/secs/examples/

     KEYWORDS:
      trange:        time range of interest
      createpng:     set this flag to create a PNG file of the plot
      showgeo:       set this flag to display geographic latitude and longitude lines
      showmag:       set this flag to display magnetic latitude and longitude lines
      dynscale:      set this flag to use dynamic scaling

     OUTPUT:
      none

     CALLING SEQUENCE:
      eics_overlay_plots, trange=['2017-02-28/00:01:00','2017-02-28/00:02:00'],
          /showgeo, /showmag, /makepng, /dynscale
      See example crib sheets for additional examples

     NOTE: If no time range is specified the routine will use whatever was set previously by timespan or
       timerange.
       If no time has not been set the user will be queried for the time.

    $LastChangedBy: adrozdov $
    $LastChangedDate: 2017-11-03 16:31:55 -0700 (Fri, 03 Nov 2017) $
    $LastChangedRevision: 24261 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/secs/eics_overlay_plots.pro $

(See projects/secs/eics_overlay_plots.pro)

## EIC_ASCII2TPLOT

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

      eic_ascii2tplot, files, prefix=prefix,suffix=suffix,verbose=verbose,tplotnames=tplotnames

    Purpose:
      This routine reads in the EIC ascii data files and creates two tplot variables eic_latlong and
      eic_jxy containing the Equivalent Ionosopheric Currents and the Latitude and Longitude grid

    Keywords:
     PREFIX = STRING      ; String that will be pre-pended to all tplot variable names.
     SUFFIX = STRING      ; String appended to end of each tplot variable created.
     VERBOSE = INTEGER    ; Controls number of informational and error messages displayed
     TPLOTNAMES = STRING ARRAY ; Returns the names of tplot variables

    Author: Cindy Russell, June 2017

     $LastChangedBy: egrimes $
     $LastChangedDate: 2014-09-23 14:56:22 -0700 (Tue, 23 Sep 2014) $
     $LastChangedRevision: 15845 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/poes/poes_cdf2tplot.pro $

(See projects/secs/eic_ascii2tplot.pro)

## EIC_READ_ASCII_DATA

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

    Function: eic_read_ascii_data

    Purpose:
     This is a routine to read the EIC ascii data files (James Weygand)

     Data contains Latitude, Longitude, Jx, Jy in geocoordinates
     Each file is for 10 seconds
     Files need to be read and bundled into one data array that spans the
     start and stop times

    INPUT:
      filename: a
    OUTPUT:
      data: array of data [5xn] ([time, lat, lon, jx, jy])

    KEYWORDS:
     out_dir = the output directory for the .dat files

     $LastChangedBy: crussell $
     $LastChangedDate: 2012-05-10 14:23:29 -0700 (Thu, 10 May 2012) $
     $LastChangedRevision: 10410 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/thmsoc/fmi_gmag/thm_read_fmi10secfile.pro $

(See projects/secs/eic_read_ascii_data.pro)

## SECA_OVERLAY_PLOTS

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

     NAME:
      seca_overlay_plots

     PURPOSE:
      This routine will create a plot of SECA and THEMIS ASI data which is overlaid onto a map of
      the northern hemisphere. See the SECS ASI mosaic overlay plot crib sheet for an explanation of the
      data and how to use this routine. You can find the crib sheet in spedas/projects/secs/examples/

     KEYWORDS:
      trange:        time range of interest
      createpng:     set this flag to create a PNG file of the plot
      showgeo:       set this flag to display geographic latitude and longitude lines
      showmag:       set this flag to display magnetic latitude and longitude lines
      dynscale:      set this flag to use dynamic scaling

     OUTPUT:
      none

     CALLING SEQUENCE:
      seca_overlay_plots, trange=['2017-02-28/00:01:00','2017-02-28/00:02:00'],
          /showgeo, /showmag, /makepng, /dynscale
      See example crib sheets for additional examples

     NOTE: If no time range is specified the routine will use whatever was set previously by timespan or
       timerange.
       If no time has not been set the user will be queried for the time.
       Data files for each data set are available per minute

     VERSION:
       $LastChangedBy: crussell $
       $LastChangedDate: 2017-11-02 08:14:23 -0700 (Thu, 02 Nov 2017) $
       $LastChangedRevision: 24249 $
       $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/secs/seca_overlay_plots.pro $

(See projects/secs/seca_overlay_plots.pro)

## SECS_CONFIG_FILEDIR

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

    Function:
        secs_config_filedir.pro

    Purpose:
        Get the directory of the Spherical Elementary Currents SECS configuration file

    $LastChangedBy: egrimes $
    $LastChangedDate: 2014-09-18 13:30:13 -0700 (Thu, 18 Sep 2014) $
    $LastChangedRevision: 15821 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/eic/eic_config_filedir.pro $

(See projects/secs/secs_config_filedir.pro)

## SECS_FILECONFIG

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

    NAME:
     secs_fileconfig

    PURPOSE:
     A widget that allows the user to set some of the !secs variable. The user
     can resettodefault, modify, and save the system variable.

    HISTORY:

    $LastChangedBy: aaflores $
    $LastChangedDate: 2015-06-19 18:59:28 -0700 (Fri, 19 Jun 2015) $
    $LastChangedRevision: 17927 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/secs/spedas_plugin/secs_fileconfig.pro $

(See projects/secs/secs_fileconfig.pro)

## SECS_INIT

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

    PROCEDURE:  secs_init
    PURPOSE:    Initializes system variables for secs.

    HISTORY

    $LastChangedBy: egrimes $
    $LastChangedDate: 2017-02-13 08:50:37 -0800 (Mon, 13 Feb 2017) $
    $LastChangedRevision: 22761 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/secs/secs_init.pro $

(See projects/secs/secs_init.pro)

## SECS_LOAD_DATA

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

     Procedure: secs_load_data

     Keywords:
                 trange:        time range of interest
                 datatype:      type of secs data to be loaded. Valid data types are: secs or SEC
                 suffix:        String to append to the end of the loaded tplot variables
                 prefix:        String to append to the beginning of the loaded tplot variables
                 /downloadonly: Download the file but don't read it
                 /noupdate:     Don't download if file exists (partially implemented, need to test when
                                two tvars are requested)
                 /nodownload:   Don't download - use only local files
                 verbose:       controls amount of error/information messages displayed
                 /get_stations: get list of stations used to generate this data

     NOTE:
     - Can only handle time ranges that don't overlap a day
     - Need to  No Update and No clobber
     - Need to correctly handle time clip
     - Add all standard tplot options
     - If no files downloaded notify user

     $LastChangedBy: egrimes $
     $LastChangedDate: 2017-02-13 15:32:14 -0800 (Mon, 13 Feb 2017) $
     $LastChangedRevision: 22769 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/secs/secs_load_data.pro $

(See projects/secs/secs_load_data.pro)

## SECS_READ_CONFIG

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

    NAME:
         secs_read_config
    PURPOSE:
         Reads the secs configuration file
    CALLING SEQUENCE:
         secs_struct = secs_read_config()
    INPUT:
     none, the filename is hardcoded, 'secs_config.txt',and is put in a
     folder given by the routine istp_config_filedir, that uses the IDL
     routine app_user_dir to create/obtain it: my linux example:
     /disks/ice/home/jimm/.idl/themis/secs_config-4-linux
    OUTPUT:
     otp = a structure with the changeable fields of the !secs
               structure
     Copied from thm_read_config and tt2000_read_config lphilpott 20-jun-2012
    $LastChangedBy: nikos $
    $LastChangedDate: 2015-11-18 14:02:09 -0800 (Wed, 18 Nov 2015) $
    $LastChangedRevision: 19410 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/secs/secs_read_config.pro $

(See projects/secs/secs_read_config.pro)

## SECS_READ_STATIONS

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

    Function: secs_read_stations

    Purpose:
     This is a routine to read the sec ascii data file that contains the
     name of the stations used to derive the SECS eics and seca data

     The file includes station name (abbreviated) and latitude, longitude in geocoordinates
     Each file is for one day. On any given day all eics and seca 10 second data files refers to this 1 one

    INPUT:
      filename: a
    OUTPUT:
      trange: array of start and stop times [optional if time is set via timerange)

     $LastChangedBy: crussell $
     $LastChangedDate: 2012-05-10 14:23:29 -0700 (Thu, 10 May 2012) $
     $LastChangedRevision: 10410 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/thmsoc/fmi_gmag/thm_read_fmi10secfile.pro $

(See projects/secs/secs_read_stations.pro)

## SECS_STATIONS2TPLOT

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

      secs_stations2tplot, file, prefix=prefix,suffix=suffix,verbose=verbose,tplotnames=tplotnames

    Purpose:
      This routine reads in the stations files that were used to create SECS data and creates
      a tplot variable secs_stations. This tplot var contains the station name (abbreviated) and
      the Latitude and Longitude of the station in geographic coordinates

    Keywords:
     PREFIX = STRING      ; String that will be pre-pended to all tplot variable names.
     SUFFIX = STRING      ; String appended to end of each tplot variable created.
     VERBOSE = INTEGER    ; Controls number of informational and error messages displayed
     TPLOTNAMES = STRING ARRAY ; Returns the names of tplot variables

    Author: Cindy Russell, June 2017

     $LastChangedBy: egrimes $
     $LastChangedDate: 2014-09-23 14:56:22 -0700 (Tue, 23 Sep 2014) $
     $LastChangedRevision: 15845 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/poes/poes_cdf2tplot.pro $

(See projects/secs/secs_stations2tplot.pro)

## SECS_WRITE_CONFIG

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

    NAME:
     secs_write_config
    PURPOSE:
     Writes the secs_config file
    CALLING SEQUENCE:
     secs_write_config, copy=copy
    INPUT:
     none, the filename is hardcoded, 'secs_config.txt',and is  put in a
     folder given by the routine secs_config_filedir, that uses the IDL
     routine app_user_dir to create/obtain it: my linux example:
     /disks/ice/home/jimm/.idl/themis/secs_config-4-linux
    OUTPUT:
     the file is written, and a copy of any old file is generated
    KEYWORD:
     copy = if set, the file is read in and a copy with the !stime
            appended is written out

    $LastChangedBy: egrimes $
    $LastChangedDate: 2014-09-18 13:30:13 -0700 (Thu, 18 Sep 2014) $
    $LastChangedRevision: 15821 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/secs/secs_write_config.pro $

(See projects/secs/secs_write_config.pro)

## SEC_ASCII2TPLOT

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

      sec_ascii2tplot, files, prefix=prefix,suffix=suffix,verbose=verbose,tplotnames=tplotnames

    Purpose:
      This routine reads in the SEC ascii data files and creates a tplot variable sec_amp that
      contains the amplitude

    Keywords:
     PREFIX = STRING      ; String that will be pre-pended to all tplot variable names.
     SUFFIX = STRING      ; String appended to end of each tplot variable created.
     VERBOSE = INTEGER    ; Controls number of informational and error messages displayed
     TPLOTNAMES = STRING ARRAY ; Returns the names of tplot variables

    Author: Cindy Russell, June 2017

     $LastChangedBy: egrimes $
     $LastChangedDate: 2014-09-23 14:56:22 -0700 (Tue, 23 Sep 2014) $
     $LastChangedRevision: 15845 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/poes/poes_cdf2tplot.pro $

(See projects/secs/sec_ascii2tplot.pro)

## SEC_READ_ASCII_DATA

[Previous Routine] [List of Routines]

    Function: sec_read_ascii_data

    Purpose:
     This is a routine to read the sec ascii data files (James Weygand)

     Data contains Latitude, Longitude in geocoordinates and J (amplitude)
     Each file is for 10 seconds
     Files need to be read and bundled into one data array that spans the
     start and stop times

    INPUT:
      filename: a
    OUTPUT:
      data: array of data [4xn] ([time, lat, lon, amp])

    KEYWORDS:
     out_dir = the output directory for the .dat files

     $LastChangedBy: nikos $
     $LastChangedDate: 2019-03-23 18:49:02 -0700 (Sat, 23 Mar 2019) $
     $LastChangedRevision: 26887 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/secs/sec_read_ascii_data.pro $

(See projects/secs/sec_read_ascii_data.pro)