This page was created by the IDL library routine
mk_html_help2.
Last modified: Thu Aug 6 12:53:14 2020.
Written by Davin Larson October 2018 $LastChangedBy: davin-mac $ $LastChangedDate: 2020-04-11 14:15:16 -0700 (Sat, 11 Apr 2020) $ $LastChangedRevision: 28558 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/projects/SPP/COMMON/cdf_tools_varinfo__define.pro $
(See projects/SPP/COMMON/cdf_tools_varinfo__define.pro)
Written by Davin Larson October 2018 cdf_tools This basic object is the entry point for reading and writing cdf files $LastChangedBy: davin-mac $ $LastChangedDate: 2020-06-25 18:55:02 -0700 (Thu, 25 Jun 2020) $ $LastChangedRevision: 28813 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/projects/SPP/COMMON/cdf_tools__define.pro $
(See projects/SPP/COMMON/cdf_tools__define.pro)
NAME: SW_VERSION Function: PURPOSE: Acts as a timestamp file to trigger the regeneration of SEP data products. Also provides Software Version info for the MAVEN SEP instrument. Author: Davin Larson - January 2014 $LastChangedBy: davin-mac $ $LastChangedDate: 2020-06-25 18:55:02 -0700 (Thu, 25 Jun 2020) $ $LastChangedRevision: 28813 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/projects/SPP/COMMON/cdf_tools__define.pro $
(See projects/SPP/COMMON/cdf_tools__define.pro)
This is a wrapper routine to create CDF variables within an open CDF file. usage: CDF_VAR_ATT_CREATE,fileid,'RandomVariable',randomn(seed,3,1000),attributes = atts Attributes are contained in a orderedhash and should have already been created.
(See projects/SPP/COMMON/cdf_tools__define.pro)
Purpose: Object that provides an efficient means of concatenating arrays
da= DynamicArray([InitialArray][,name='name1')
Purpose: Returns a "dynamic array" object. This dynamic array can have any number of elements and can be efficiently
appended to.
This routine is particularly useful when appending to large arrays on numerous occassions. This is especially useful
when the final size of the array is not known when first initialized.
It is functionally equivalent to:
a= findgen(10)
b = 1.
a = [a,b]
but considerably more effiecient because the array size does not need to be increased at every append operation.
Because one can produce arrays of objects, it is a conveniant way of constructing arrays of arrays
containing different things.
Works with multidimensional arrays too.
USAGE:
da = dynamicarray(findgen(1000000), name='Test1')
Or
da.array = findgen(1000000) ; equivalent
Or
da = dynamicarray() & da.append, findgen(1000000)
da.append, findgen(1000) ; append some data
da.append, !values.f_nan ; add a NAN at the end.
da.name = 'NewName' ; change name
a = da.array ; retrieve a copy of the array
print,da.size ; print the number of elements in the array (first dimension of multidimensional arrays)
help,da.name ; display the optional user name
object_destroy, da ; cleanup when done.
Written by Davin Larson - August 2016
(See projects/SPP/COMMON/dynamicarray__define.pro)
$LastChangedBy: pulupalap $ $LastChangedDate: 2019-11-09 17:31:21 -0800 (Sat, 09 Nov 2019) $ $LastChangedRevision: 28000 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/projects/SPP/COMMON/psp_fld_load.pro $
(See projects/SPP/COMMON/psp_fld_load.pro)
spp_data_product_hash This basic object is the entry point for defining and obtaining all data for all data products $LastChangedBy: davin-mac $ $LastChangedDate: 2020-04-20 12:02:46 -0700 (Mon, 20 Apr 2020) $ $LastChangedRevision: 28594 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/projects/SPP/COMMON/spp_data_product_hash.pro $
(See projects/SPP/COMMON/spp_data_product_hash.pro)
spp_data_product This basic object is the entry point for defining and obtaining all data for all data products $LastChangedBy: davin-mac $ $LastChangedDate: 2020-04-15 17:18:26 -0700 (Wed, 15 Apr 2020) $ $LastChangedRevision: 28586 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/projects/SPP/COMMON/spp_data_product__define.pro $
(See projects/SPP/COMMON/spp_data_product__define.pro)
Written by Davin Larson
$LastChangedBy: davin-mac $
$LastChangedDate: 2020-04-28 16:55:34 -0700 (Tue, 28 Apr 2020) $
$LastChangedRevision: 28618 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/projects/SPP/COMMON/spp_file_retrieve.pro $
Function: files = spp_file_retrieve(PATHNAME)
Purpose: Retrieve or Download Solar Probe data files (i.e. L0 files) (Can be used to generate filenames too)
INPUT:
PATHNAME: string specifying relative path to files. Default might change- Currently: 'psp/pfp/l0/YYYY/MM/mvn_pfp_all_l0_YYYYMMDD_v???.dat'
PATHNAME must be relative to the LOCAL_DATA_DIR and REMOTE_DATA_DIR fields of the source keyword.
"globbed" filenames (*,?) are accepted.
typical usage:
files = spp_file_retrieve('psp/xxxxxx/YYYY/MM/mvn_pfp_all_l0_YYYYMMDD_v???.dat',/daily_names) ; get L0 files for user defined time span
files = spp_file_retrieve(pathname,/daily_names,trange=trange) ; set time range
Keywords: (All are optional - none are recommended)
L0: set to 1 to return PFP L0 files
DAILY_NAMES : resolution (in days) for generating file names.
YYYY, yy, MM, DD, hh, mm, ss, .f, DOY, DOW, TDIFF are special characters that will be substituted with the appropriate date/time field
Be especially careful of extensions that begin with '.f' since these will be translated into a fractional second.
See "time_string" TFORMAT keyword for more info.
TRANGE : two element vector containing start and end times (UNIX_TIME or UT string). if not present then timerange() is called to obtain the limits.
SOURCE: alternate file source. Default is whatever is return by the function: mvn_file_source() (see "mvn_file_source" for more info)
FILES: if provided these will be passed through as output.
VALID_ONLY: Set to 1 to prevent non existent files from being returned.
CREATE_DIR: Generates a filename and creates the directories needed to create the file without errors. Will not check for file on remote server.
KEYWORDS Passed on to "FILE_RETRIEVE":
LAST_VERSION : [0,1] if set then only the last matching file is returned. (Default is defined by source)
VALID_ONLY: [0,1] If set then only existing files are returned. (Default is defined by source keyword)
VERBOSE: set verbosity level (2 is typical)
USER_PASS: user:password combination for the remote server
LIMITATIONS:
Beware of file pathnames that include the character sequences: YY, MM, DD, hh, mm, ss, .f since these can be retranslated to the time
(See projects/SPP/COMMON/spp_file_retrieve.pro)
Author: Davin Larson December 2018 $LastChangedBy: pulupalap $ $LastChangedDate: 2020-08-05 13:30:19 -0700 (Wed, 05 Aug 2020) $ $LastChangedRevision: 28993 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/projects/SPP/COMMON/spp_fld_load.pro $
(See projects/SPP/COMMON/spp_fld_load.pro)
SPP_GEN_APDAT This basic object is the entry point for defining and obtaining all data for all apids $LastChangedBy: ali $ $LastChangedDate: 2020-07-17 17:23:27 -0700 (Fri, 17 Jul 2020) $ $LastChangedRevision: 28907 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/projects/SPP/COMMON/spp_gen_apdat__define.pro $
(See projects/SPP/COMMON/spp_gen_apdat__define.pro)
NAME: MVN_SEP_SW_VERSION Function: mvn_spice_kernels(name) PURPOSE: Acts as a timestamp file to trigger the regeneration of SEP data products. Also provides Software Version info for the MAVEN SEP instrument. Author: Davin Larson - January 2014 $LastChangedBy: ali $ $LastChangedDate: 2020-07-17 17:23:27 -0700 (Fri, 17 Jul 2020) $ $LastChangedRevision: 28907 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/projects/SPP/COMMON/spp_gen_apdat__define.pro $
(See projects/SPP/COMMON/spp_gen_apdat__define.pro)
WIDGET Procedure:
spp_ptp_recorder
PURPOSE:
Widget tool that opens a socket and records streaming data from a server (host) and can save it to a file
or send to a user specified routine. This tool runs in the background.
Keywords:
SET_FILE_TIMERES : defines how often the current output file will be closed and a new one will be opened
DIRECTORY: string prepended to fileformat when opening an output file.
Author:
Davin Larson - April 2011
$LastChangedBy: davin-mac $
$LastChangedDate: 2018-07-27 16:40:55 -0700 (Fri, 27 Jul 2018) $
$LastChangedRevision: 25525 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/projects/SPP/COMMON/spp_ptp_recorder.pro $
(See projects/SPP/COMMON/spp_ptp_recorder.pro)
Function: spp_spc_met_to_unixtime Purpose: Convert MET (mission Elapsed Time) to Unix Time (which is almost equivalent to UTC) see also: "spp_spc_unixtime_to_met" for the reverse conversion This routine is in the process of being modified to use SPICE Kernels to correct for clock drift as needed. Author: Davin Larson $LastChangedBy: ali $ $LastChangedDate: 2020-07-01 08:47:47 -0700 (Wed, 01 Jul 2020) $ $LastChangedRevision: 28827 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/projects/SPP/COMMON/spp_spc_met_to_unixtime.pro $
(See projects/SPP/COMMON/spp_spc_met_to_unixtime.pro)