This page was created by the IDL library routine
mk_html_help2.
Last modified: Tue Oct 23 09:41:30 2018.
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. Because one can produce arrays of objects, it is a conveniant way of constructing arrays of arrays containing different things. This routine is particularly useful when appending to large arrays on multiple occassions. This is especially useful when the final size of the array is not known when first initialized. USAGE: da = dynamicarray(name='Test1') da.append, findgen(1000000) ; da.append, !values.f_nan ; add a NAN at the end. a = da.array ; retrieve a copy of the array print,da.size ; print the number of elements in the array help,da.name ; display the optional user name
(See projects/SPP/COMMON/dynamicarray__define.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)
SPP_GEN_APDAT This basic object is the entry point for defining and obtaining all data for all apids
(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_3_1/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: davin-mac $ $LastChangedDate: 2018-09-17 08:35:44 -0700 (Mon, 17 Sep 2018) $ $LastChangedRevision: 25818 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_3_1/projects/SPP/COMMON/spp_spc_met_to_unixtime.pro $
(See projects/SPP/COMMON/spp_spc_met_to_unixtime.pro)