This page was created by the IDL library routine
mk_html_help2
.
Last modified: Fri Jul 19 18:16:32 2019.
FUNCTION: elf_files_in_interval PURPOSE: filters file list returned by the server to the trange. This filter is purposefully liberal, it regularly grabs an extra file due to special cases $LastChangedBy: egrimes $ $LastChangedDate: 2016-08-11 11:36:41 -0700 (Thu, 11 Aug 2016) $ $LastChangedRevision: 21630 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/elf/load_data/mms_files_in_interval.pro $
(See projects/elfin/load_data/elf_files_in_interval.pro)
PROCEDURE: elf_get_att PURPOSE: This routine will get the latest elfin attitude information. tplot variables created include ela_att_gei, ela_att_last_solution, ela_spin_norm_ang, and ela_spin_sun_ang, ela_pos_gei and ela_vel_gei NOTE: This routine can also be called from the elf_load_state routine by using the keyword /get_att KEYWORDS trange: time range of interest [starttime, endtime] with the format ['YYYY-MM-DD','YYYY-MM-DD'] or to specify more or less than a day ['YYYY-MM-DD/hh:mm:ss','YYYY-MM-DD/hh:mm:ss'] probe: elf probes include 'a', or 'b' EXAMPLE: ela_get_att, trange=['2019-07-15','2019-07-16'], probe='a'
(See projects/elfin/load_data/elf_get_att.pro)
Function elf_get_authorization This function returns a structure that contains the user_name and password for accessing elfin data. authorization = { user_name: user_name, password: password } Note this function is only necessary for ELFIN data that is not yet public. This procedure will define the location of data files and the data server. This procedure is intended to be called from within the "ELF_INIT" procedure. KEYWORDS none
(See projects/elfin/load_data/elf_get_authorization.pro)
Procedure: elf_get_local_files Purpose: Search for local ELFIN files in case a list cannot be retrieved from the remote server. Returns a sorted list of file paths. Calling Sequence: files = elf_get_local_file_info( probe=probe, instrument=instrument, $ data_rate=data_rate, level=level, datatype=datatype, trange=trange) Input: probe: (string) Full spacecraft designation, e.g. 'ela' instrument: (string) Instrument designation, e.g. 'fgm' data_rate: (string) Data collection mode? e.g. 'srvy' level: (string) Data processing level, e.g. 'l1' trange: (string/double) Two element time range, e.g. ['2015-06-22','2015-06-23'] datatype: (string) Optional datatype specification, e.g. 'pos' Output: return value: Sorted string array of file paths, if successful; 0 otherwise Notes: -Input strings should not contain wildcards (datatype may be '*') $LastChangedBy: egrimes $ $LastChangedDate: 2018-04-09 12:14:36 -0700 (Mon, 09 Apr 2018) $ $LastChangedRevision: 25023 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/elf/common/elf_get_local_files.pro $
(See projects/elfin/load_data/elf_get_local_files.pro)
NAME: elf_load_data This routine loads local ELFIN data. There is no server available yet so all files must be local. The default value is currently set to 'C:/data/elfin/el[ab]/l[0,1,2]/instrument/yyyy/mm/dd/*.cdf' If you do not want to place your cdf files there you must change the elfin system variable !elf.local_data_dir = 'yourdirectorypath' KEYWORDS (commonly used by other load routines): trange: time range of interest [starttime, endtime] with the format ['YYYY-MM-DD','YYYY-MM-DD'] or to specify more or less than a day ['YYYY-MM-DD/hh:mm:ss','YYYY-MM-DD/hh:mm:ss'] probes: list of probes, valid values for ELFIN probes are ['a','b']. if no probe is specified the default is probe 'a' level: indicates level of data processing. levels include 'l1' and 'l2' The default if no level is specified is 'l1' (l1 default needs to be confirmed) datatype: depends on the instrument, see header for the instruments load routine data_rate: instrument data rates tplotnames: returns a list of the names of the tplot variables loaded by the load routine get_support_data: load support data (defined by VAR_TYPE="support_data" in the CDF) no_color_setup: don't setup graphics configuration; use this keyword when you're using this load routine from a terminal without an X server running no_time_clip: don't clip the data to the requested time range; note that if you do use this keyword you may load a longer time range than requested. no_update: set this flag to preserve the original data. if not set and newer data is found the existing data will be overwritten suffix: appends a suffix to the end of the tplot variable name. this is useful for preserving original tplot variable. varformat: should be a string (wildcards accepted) that will match the CDF variables that should be loaded into tplot variables cdf_filenames: this keyword returns the names of the CDF files used when loading the data cdf_version: specify a specific CDF version # to load (e.g., cdf_version='4.3.0') latest_version: only grab the latest CDF version in the requested time interval (e.g., /latest_version) major_version: only open the latest major CDF version (e.g., X in vX.Y.Z) in the requested time interval min_version: specify a minimum CDF version # to load cdf_records: specify the # of records to load from the CDF files; this is useful for grabbing one record from a CDF file spdf: grab the data from the SPDF instead of the LASP SDC (only works for public data) available: returns a list of files available at the SDC for the requested parameters this is useful for finding which files would be downloaded (along with their sizes) if you didn't specify this keyword (also outputs total download size) versions: this keyword returns the version #s of the CDF files used when loading the data always_prompt: set this keyword to always prompt for the user's username and password; useful if you accidently save an incorrect password, or if your SDC password has changed no_time_sort: set this flag to not order by time and remove duplicates tt2000: flag for preserving TT2000 timestamps found in CDF files (note that many routines in SPEDAS (e.g., tplot.pro) do not currently support these timestamps) pred: set this flag for 'predicted' state data. default state data is 'definitive'. ; EXAMPLE: elf_load_data,probe='a' NOTES: Since there is no data server - yet - files must reside locally. Current file naming convention is el[a/b]_ll_instr_yyyymmdd_v01.cdf.
(See projects/elfin/load_data/elf_load_data.pro)
PROCEDURE: elf_load_eng PURPOSE: Load the ELFIN engineering data KEYWORDS: trange: time range of interest [starttime, endtime] with the format ['YYYY-MM-DD','YYYY-MM-DD'] or to specify more or less than a day ['YYYY-MM-DD/hh:mm:ss','YYYY-MM-DD/hh:mm:ss'] probes: list of probes, valid values for elf probes are ['a','b']. if no probe is specified the default is probe 'a' datatypes: see list below data_rate: instrument data rates are not applicable level: indicates level of data processing. levels include 'l1' and 'l2' The default if no level is specified is 'l1' (l1 default needs to be confirmed) local_data_dir: local directory to store the CDF files; should be set if you're on *nix or OSX, the default currently assumes Windows (c:\data\elfin\) source: specifies a different system variable. By default the elf mission system variable is !elf get_support_data: load support data (defined by support_data attribute in the CDF) tplotnames: names for tplot variables no_color_setup: don't setup graphics configuration; use this keyword when you're using this load routine from a terminal without an X server running no_time_clip: don't clip the data to the requested time range; note that if you do use this keyword you may load a longer time range than requested no_update: set this flag to preserve the original data. if not set and newer data is found the existing data will be overwritten suffix: appends a suffix to the end of the tplot variable name. this is useful for preserving original tplot variable. varformat: should be a string (wildcards accepted) that will match the CDF variables that should be loaded into tplot variables cdf_filenames: this keyword returns the names of the CDF files used when loading the data cdf_version: specify a specific CDF version # to load (e.g., cdf_version='4.3.0') latest_version: only grab the latest CDF version in the requested time interval (e.g., /latest_version) major_version: only open the latest major CDF version (e.g., X in vX.Y.Z) in the requested time interval min_version: specify a minimum CDF version # to load cdf_records: specify a number of records to load from the CDF files. e.g., cdf_records=1 only loads in the first data point in the file This is especially useful for loading S/C position for a single time spdf: grab the data from the SPDF instead of the LASP SDC (only works for public access) available: returns a list of files available at the SDC for the requested parameters this is useful for finding which files would be downloaded (along with their sizes) if you didn't specify this keyword (also outputs total download size) versions: this keyword returns the version #s of the CDF files used when loading the data always_prompt: set this keyword to always prompt for the user's username and password; useful if you accidently save an incorrect password, or if your SDC password has changed no_time_sort: set this flag if you don't want to order time and remove duplicates tt2000: flag for preserving TT2000 timestamps found in CDF files (note that many routines in SPEDAS (e.g., tplot.pro) do not currently support these timestamps) EXAMPLES: to load/plot the eng data for probe a on 2/20/2019: elf> elf_load_eng, probe='a', trange=['2016-02-20', '2016-02-21'], level='l1' elf> tplot, 'ela_sips_5v0_voltage' NOTES: $LastChangedBy: clrussell $ $LastChangedDate: 2018-12-06 11:58:25 -0700 (Mon, 06 Aug 2018) $ $LastChangedRevision: 25588 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/elfin/elf_load_eng.pro $
(See projects/elfin/load_data/elf_load_eng.pro)
PROCEDURE: elf_load_epd PURPOSE: Load the ELFIN EPD KEYWORDS: trange: time range of interest [starttime, endtime] with the format ['YYYY-MM-DD','YYYY-MM-DD'] or to specify more or less than a day ['YYYY-MM-DD/hh:mm:ss','YYYY-MM-DD/hh:mm:ss'] probes: list of probes, valid values for elf probes are ['a','b']. if no probe is specified the default is probe 'a' datatype: valid datatypes include level 1 - ['pis', 'pif', 'pef', 'pes'] and level 2 -['pis_eflux', 'pif_eflux', 'pef_eflux', 'pes_eflux'] data_rate: instrument data rates include ['srvy', 'fast']. The default is 'srvy'. level: indicates level of data processing. levels include 'l1' and 'l2' The default if no level is specified is 'l1' unit: Valid units include 'raw', 'flux', and 'eflux' where raw=ADC, flux=mev/cm^2-s-sr-mev and eflux type: 'raw' or 'calibrated' local_data_dir: local directory to store the CDF files; should be set if you're on *nix or OSX, the default currently assumes Windows (c:\data\elfin\) source: specifies a different system variable. By default the elf mission system variable is !elf get_support_data: load support data (defined by support_data attribute in the CDF) tplotnames: names for tplot variables no_color_setup: don't setup graphics configuration; use this keyword when you're using this load routine from a terminal without an X server running no_time_clip: don't clip the data to the requested time range; note that if you do use this keyword you may load a longer time range than requested no_update: set this flag to preserve the original data. if not set and newer data is found the existing data will be overwritten suffix: appends a suffix to the end of the tplot variable name. this is useful for preserving original tplot variable. varformat: should be a string (wildcards accepted) that will match the CDF variables that should be loaded into tplot variables cdf_filenames: this keyword returns the names of the CDF files used when loading the data cdf_version: specify a specific CDF version # to load (e.g., cdf_version='4.3.0') latest_version: only grab the latest CDF version in the requested time interval (e.g., /latest_version) major_version: only open the latest major CDF version (e.g., X in vX.Y.Z) in the requested time interval min_version: specify a minimum CDF version # to load cdf_records: specify a number of records to load from the CDF files. e.g., cdf_records=1 only loads in the first data point in the file This is especially useful for loading S/C position for a single time spdf: grab the data from the SPDF instead of the LASP SDC (only works for public access) available: returns a list of files available at the SDC for the requested parameters this is useful for finding which files would be downloaded (along with their sizes) if you didn't specify this keyword (also outputs total download size) versions: this keyword returns the version #s of the CDF files used when loading the data always_prompt: set this keyword to always prompt for the user's username and password; useful if you accidently save an incorrect password, or if your SDC password has changed no_time_sort: set this flag to not order time and remove duplicates tt2000: flag for preserving TT2000 timestamps found in CDF files (note that many routines in SPEDAS (e.g., tplot.pro) do not currently support these timestamps) no_spec: flag to set tplot options to linear rather than the default of spec EXAMPLES: to load/plot the EPD data for probe a on 2/20/2019: elf> elf_load_epd, probe='a', trange=['2016-02-20', '2016-02-21'], level='l1', data_type='pif_counts' elf> tplot, 'ela_pif' NOTES: $LastChangedBy: clrussell $ $LastChangedDate: 2018-12-06 11:58:25 -0700 (Mon, 06 Aug 2018) $ $LastChangedRevision: 25588 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/elfin/elf_load_fgm.pro $
(See projects/elfin/load_data/elf_load_epd.pro)
PROCEDURE: elf_load_FGM PURPOSE: Load the ELFIN FGM KEYWORDS: trange: time range of interest [starttime, endtime] with the format ['YYYY-MM-DD','YYYY-MM-DD'] or to specify more or less than a day ['YYYY-MM-DD/hh:mm:ss','YYYY-MM-DD/hh:mm:ss'] probes: list of probes, valid values for elf probes are ['a','b']. if no probe is specified the default is probe 'a' datatype: valid datatypes include level 1 - ['fgf', 'fgs'] and level 2 -['fgf_dsl','fgf_gei','fgf_mag','fgs_dsl','fgs_gei','fgs_mag'] data_rate: instrument data rates include ['srvy', 'fast']. The default is 'srvy'. level: indicates level of data processing. levels include 'l1' and 'l2' The default if no level is specified is 'l1' (l1 default needs to be confirmed) local_data_dir: local directory to store the CDF files; should be set if you're on *nix or OSX, the default currently assumes Windows (c:\data\elfin\) source: specifies a different system variable. By default the elf mission system variable is !elf get_support_data: load support data (defined by support_data attribute in the CDF) tplotnames: names for tplot variables no_color_setup: don't setup graphics configuration; use this keyword when you're using this load routine from a terminal without an X server running no_time_clip: set this keyword to not clip the data to the requested time range; no_update: set this flag to preserve the original data. if not set and newer data is found the existing data will be overwritten suffix: appends a suffix to the end of the tplot variable name. this is useful for preserving original tplot variable. varformat: should be a string (wildcards accepted) that will match the CDF variables that should be loaded into tplot variables cdf_filenames: this keyword returns the names of the CDF files used when loading the data cdf_version: specify a specific CDF version # to load (e.g., cdf_version='4.3.0') latest_version: only grab the latest CDF version in the requested time interval (e.g., /latest_version) major_version: only open the latest major CDF version (e.g., X in vX.Y.Z) in the requested time interval min_version: specify a minimum CDF version # to load cdf_records: specify a number of records to load from the CDF files. e.g., cdf_records=1 only loads in the first data point in the file This is especially useful for loading S/C position for a single time spdf: grab the data from the SPDF instead of the LASP SDC (only works for public access) available: returns a list of files available at the SDC for the requested parameters this is useful for finding which files would be downloaded (along with their sizes) if you didn't specify this keyword (also outputs total download size) versions: this keyword returns the version #s of the CDF files used when loading the data always_prompt: set this keyword to always prompt for the user's username and password; useful if you accidently save an incorrect password, or if your SDC password has changed no_time_sort: set this flag if you don't want the time ordered tt2000: flag for preserving TT2000 timestamps found in CDF files (note that many routines in SPEDAS (e.g., tplot.pro) do not currently support these timestamps) EXAMPLES: to load/plot the FGM magnetometer data for probe a on 2/20/2019: elf> elf_load_fgm, probe='a', trange=['2016-02-20', '2016-02-21'], level='l1' elf> tplot, 'ela_fgs' NOTES: HISTORY: egrimes, replaced new_tvars code with tplotnames and enabled calibration by default, 14 March 2019 $LastChangedBy: clrussell $ $LastChangedDate: 2018-12-06 11:58:25 -0700 (Mon, 06 Aug 2018) $ $LastChangedRevision: 25588 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/elfin/elf_load_fgm.pro $
(See projects/elfin/load_data/elf_load_fgm.pro)
PROCEDURE: elf_load_mrma PURPOSE: Load the ELFIN mrm data from the ACB board KEYWORDS: trange: time range of interest [starttime, endtime] with the format ['YYYY-MM-DD','YYYY-MM-DD'] or to specify more or less than a day ['YYYY-MM-DD/hh:mm:ss','YYYY-MM-DD/hh:mm:ss'] probes: list of probes, valid values for elf probes are ['a','b']. if no probe is specified the default is probe 'a' datatypes: only one valid datatype -'mrma' data_rate: instrument data rates are not applicable level: indicates level of data processing. levels include 'l1' and 'l2' The default if no level is specified is 'l1' (l1 default needs to be confirmed) local_data_dir: local directory to store the CDF files; should be set if you're on *nix or OSX, the default currently assumes Windows (c:\data\elfin\) source: specifies a different system variable. By default the elf mission system variable is !elf get_support_data: load support data (defined by support_data attribute in the CDF) tplotnames: names for tplot variables no_color_setup: don't setup graphics configuration; use this keyword when you're using this load routine from a terminal without an X server running no_time_clip: don't clip the data to the requested time range; note that if you do use this keyword you may load a longer time range than requested no_update: set this flag to preserve the original data. if not set and newer data is found the existing data will be overwritten suffix: appends a suffix to the end of the tplot variable name. this is useful for preserving original tplot variable. varformat: should be a string (wildcards accepted) that will match the CDF variables that should be loaded into tplot variables cdf_filenames: this keyword returns the names of the CDF files used when loading the data cdf_version: specify a specific CDF version # to load (e.g., cdf_version='4.3.0') latest_version: only grab the latest CDF version in the requested time interval (e.g., /latest_version) major_version: only open the latest major CDF version (e.g., X in vX.Y.Z) in the requested time interval min_version: specify a minimum CDF version # to load cdf_records: specify a number of records to load from the CDF files. e.g., cdf_records=1 only loads in the first data point in the file This is especially useful for loading S/C position for a single time spdf: grab the data from the SPDF instead of the LASP SDC (only works for public access) available: returns a list of files available at the SDC for the requested parameters this is useful for finding which files would be downloaded (along with their sizes) if you didn't specify this keyword (also outputs total download size) versions: this keyword returns the version #s of the CDF files used when loading the data always_prompt: set this keyword to always prompt for the user's username and password; useful if you accidently save an incorrect password, or if your SDC password has changed no_time_sort: set this flag if you don't want to order time and remove duplicates tt2000: flag for preserving TT2000 timestamps found in CDF files (note that many routines in SPEDAS (e.g., tplot.pro) do not currently support these timestamps) EXAMPLES: to load/plot the mrm attitude data for probe a on 2/20/2019: elf> elf_load_mrma, probe='a', trange=['2016-02-20', '2016-02-21'], level='l1' elf> tplot, 'ela_mrma' NOTES: $LastChangedBy: clrussell $ $LastChangedDate: 2018-12-06 11:58:25 -0700 (Mon, 06 Aug 2018) $ $LastChangedRevision: 25588 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/elfin/elf_load_mrma.pro $
(See projects/elfin/load_data/elf_load_mrma.pro)
PROCEDURE: elf_load_mrmi PURPOSE: Load the ELFIN mrm data from the IDPU board KEYWORDS: trange: time range of interest [starttime, endtime] with the format ['YYYY-MM-DD','YYYY-MM-DD'] or to specify more or less than a day ['YYYY-MM-DD/hh:mm:ss','YYYY-MM-DD/hh:mm:ss'] probes: list of probes, valid values for elf probes are ['a','b']. if no probe is specified the default is probe 'a' datatypes: only valid datatype is 'mrmi' data_rate: instrument data rates are not applicable level: indicates level of data processing. levels include 'l1' and 'l2' The default if no level is specified is 'l1' (l1 default needs to be confirmed) local_data_dir: local directory to store the CDF files; should be set if you're on *nix or OSX, the default currently assumes Windows (c:\data\elfin\) source: specifies a different system variable. By default the elf mission system variable is !elf get_support_data: load support data (defined by support_data attribute in the CDF) tplotnames: names for tplot variables no_color_setup: don't setup graphics configuration; use this keyword when you're using this load routine from a terminal without an X server running no_time_clip: don't clip the data to the requested time range; note that if you do use this keyword you may load a longer time range than requested no_update: set this flag to preserve the original data. if not set and newer data is found the existing data will be overwritten suffix: appends a suffix to the end of the tplot variable name. this is useful for preserving original tplot variable. varformat: should be a string (wildcards accepted) that will match the CDF variables that should be loaded into tplot variables cdf_filenames: this keyword returns the names of the CDF files used when loading the data cdf_version: specify a specific CDF version # to load (e.g., cdf_version='4.3.0') latest_version: only grab the latest CDF version in the requested time interval (e.g., /latest_version) major_version: only open the latest major CDF version (e.g., X in vX.Y.Z) in the requested time interval min_version: specify a minimum CDF version # to load cdf_records: specify a number of records to load from the CDF files. e.g., cdf_records=1 only loads in the first data point in the file This is especially useful for loading S/C position for a single time spdf: grab the data from the SPDF instead of the LASP SDC (only works for public access) available: returns a list of files available at the SDC for the requested parameters this is useful for finding which files would be downloaded (along with their sizes) if you didn't specify this keyword (also outputs total download size) versions: this keyword returns the version #s of the CDF files used when loading the data no_time_sort: set this flag to order time and remove duplicates always_prompt: set this keyword to always prompt for the user's username and password; useful if you accidently save an incorrect password, or if your SDC password has changed tt2000: flag for preserving TT2000 timestamps found in CDF files (note that many routines in SPEDAS (e.g., tplot.pro) do not currently support these timestamps) EXAMPLES: to load/plot the mrm attitude data for probe a on 2/20/2019: elf> elf_load_mrmi, probe='a', trange=['2016-02-20', '2016-02-21'], level='l1' elf> tplot, 'ela_mrmi' NOTES: $LastChangedBy: clrussell $ $LastChangedDate: 2018-12-06 11:58:25 -0700 (Mon, 06 Aug 2018) $ $LastChangedRevision: 25588 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/elfin/elf_load_mrma.pro $
(See projects/elfin/load_data/elf_load_mrmi.pro)
Procedure: elf_load_options Purpose: Provides information on valid data rates, levels, and datatypes for ELFIN science instruments. Valid load options for a specified instrument will be returned via a corresponding keyword. Each output keyword may be used as an input to narrow the results the the contingent options. Calling Sequence: elf_load_options, instrument=instrument [,rate=rate] [,level=level], [,datatype=datatype] [valid=valid] Example Usage: Input: instrument: (string) Instrument designation, e.g. 'afg' rate: (string)(array) Data rate e.g. 'fast', 'srvy' level: (string)(array) Data processing level e.g. 'l1b', 'ql' datatype: (string)(array) Data type, e.g. 'moments' Output: rate: If not used as an input this will contain all valid rates for the instrument. level: If not used as an input this will contain all valid levels, given any specified rate. datatype: If not used as an input this will contain all valid datatypes, given any specified rate and level. valid: 1 if valid outputs were found, 0 otherwise Notes: $LastChangedBy: egrimes $ $LastChangedDate: 2016-09-22 12:22:45 -0700 (Thu, 22 Sep 2016) $ $LastChangedRevision: 21901 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/elfin/elf_load_options.pro $
(See projects/elfin/load_data/elf_load_options.pro)
Purpose: Helper function to return structure describing the available data types for State files
(See projects/elfin/load_data/elf_load_options.pro)
Purpose: Helper function to return structure describing the available data types for MRM ACB
(See projects/elfin/load_data/elf_load_options.pro)
Purpose: Helper function to return structure describing the available data types for MRM IDPU
(See projects/elfin/load_data/elf_load_options.pro)
Purpose: Helper function to return structure describing the available data types for engineering data
(See projects/elfin/load_data/elf_load_options.pro)
Purpose: Helper function to return structure describing the available data types for FGM
(See projects/elfin/load_data/elf_load_options.pro)
Purpose: Helper function to return structure describing the available data types for EPD
(See projects/elfin/load_data/elf_load_options.pro)
Purpose: Extracts valid rate/level/datatype based on input. If an input is specified then only subsets of that input are checked. If an input is not specified then all possible matches are used. e.g. -If rate is specified then only levels and datatypes for that rate are retuned. -If nothing is specified then all rates/levels/datatypes are returned. -If all three are specified then then the output will be identical to the input (if the input is valid).
(See projects/elfin/load_data/elf_load_options.pro)
PROCEDURE: elf_load_state PURPOSE: Load the ELFIN ephemeris and attitude data KEYWORDS: trange: time range of interest [starttime, endtime] with the format ['YYYY-MM-DD','YYYY-MM-DD'] or to specify more or less than a day ['YYYY-MM-DD/hh:mm:ss','YYYY-MM-DD/hh:mm:ss'] probes: list of probes, valid values for elf probes are ['a','b']. if no probe is specified the default is probe 'a' datatype: valid datatypes include ['pos', 'vel'] Note: attitude data will be added soon [spinras, spindec, spinper, ..]. level: there is only one level for state - 'l1' data_rate: instrument data rates are not applicable for state data local_data_dir: local directory to store the CDF files; should be set if you're on *nix or OSX, the default currently assumes Windows (c:\data\elf\) source: specifies a different system variable. By default the elf mission system variable is !elf get_support_data: load support data (defined by support_data attribute in the CDF) tplotnames: names for tplot variables no_color_setup: don't setup graphics configuration; use this keyword when you're using this load routine from a terminal without an X server running no_time_clip: don't clip the data to the requested time range; note that if you do use this keyword you may load a longer time range than requested no_update: set this flag to preserve the original data. if not set and newer data is found the existing data will be overwritten suffix: appends a suffix to the end of the tplot variable name. this is useful for preserving original tplot variable. varformat: should be a string (wildcards accepted) that will match the CDF variables that should be loaded into tplot variables cdf_filenames: this keyword returns the names of the CDF files used when loading the data cdf_version: specify a specific CDF version # to load (e.g., cdf_version='4.3.0') latest_version: only grab the latest CDF version in the requested time interval (e.g., /latest_version) major_version: only open the latest major CDF version (e.g., X in vX.Y.Z) in the requested time interval min_version: specify a minimum CDF version # to load cdf_records: specify a number of records to load from the CDF files. e.g., cdf_records=1 only loads in the first data point in the file This is especially useful for loading S/C position for a single time spdf: grab the data from the SPDF instead of the LASP SDC (only works for public access) available: returns a list of files available at the SDC for the requested parameters this is useful for finding which files would be downloaded (along with their sizes) if you didn't specify this keyword (also outputs total download size) versions: this keyword returns the version #s of the CDF files used when loading the data always_prompt: set this keyword to always prompt for the user's username and password; useful if you accidently save an incorrect password, or if your SDC password has changed tt2000: flag for preserving TT2000 timestamps found in CDF files (note that many routines in SPEDAS (e.g., tplot.pro) do not currently support these timestamps) pred: set this flag to retrieve predicted data. default is definitive. get_att: set this flag to force retrieval of attitude data, even if there is none for this day EXAMPLES: to load/plot the S/C position data for probe a on 2/20/2016: elf> elf_load_state, probe='a', trange=['2016-02-20', '2016-02-21'] elf> tplot, 'ela_pos_gsm' NOTES: Will need to add attitude data - so far this only handles position and velocity $LastChangedBy: clrussell $ $LastChangedDate: 2018-12-06 11:58:25 -0700 (Mon, 06 Aug 2018) $ $LastChangedRevision: 25588 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/elfin/elf_load_state.pro $
(See projects/elfin/load_data/elf_load_state.pro)
PROCEDURE: elf_state_fix_metadata PURPOSE: Helper routine for setting metadata of ELFIN state variables $LastChangedBy: egrimes $ $LastChangedDate: 2017-05-01 13:00:22 -0700 (Mon, 01 May 2017) $ $LastChangedRevision: 23255 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/mms/mec/mms_mec_fix_metadata.pro $
(See projects/elfin/load_data/elf_state_fix_metadata.pro)