projects/maven/general/
mvn_pfp_file_retrieve.pro
Routines
Routines from mvn_pfp_file_retrieve.pro
result = mvn_pfp_file_next_revision(filename, ndigits, extension=extension)
FUNCTION mvn_pfp_file_next_revision(filename,ndigits, [extension=extension])Returns the filename with the next revision numberWarning: unpredictable results at rollover.
result = mvn_pfp_file_retrieve(pathname, trange=trange, verbose=verbose, source=source, files=files, last_version=last_version, valid_only=valid_only, no_update=no_update, create_dir=create_dir, pos_start=pos_start, remote_kp_cdf=remote_kp_cdf, insitu_kp_cdf=insitu_kp_cdf, daily_names=daily_names, hourly_names=hourly_names, resolution=resolution, shiftres=shiftres, no_server=no_server, user_pass=user_pass, L0=L0, recent=recent, DPU=DPU, ATLO=ATLO, RT=RT, pformat=pformat, realtime=realtime, no_download=no_download, name=name)
Function: files = mvn_pfp_file_retrieve(PATHNAME) Purpose: Retrieve or Download MAVEN data files (i.e.
Routine details
top source mvn_pfp_file_next_revision
result = mvn_pfp_file_next_revision(filename, ndigits, extension=extension)
FUNCTION mvn_pfp_file_next_revision(filename,ndigits, [extension=extension]) Returns the filename with the next revision number Warning: unpredictable results at rollover.
Parameters
- filename
- ndigits
Keywords
- extension
top source mvn_pfp_file_retrieve
result = mvn_pfp_file_retrieve(pathname, trange=trange, verbose=verbose, source=source, files=files, last_version=last_version, valid_only=valid_only, no_update=no_update, create_dir=create_dir, pos_start=pos_start, remote_kp_cdf=remote_kp_cdf, insitu_kp_cdf=insitu_kp_cdf, daily_names=daily_names, hourly_names=hourly_names, resolution=resolution, shiftres=shiftres, no_server=no_server, user_pass=user_pass, L0=L0, recent=recent, DPU=DPU, ATLO=ATLO, RT=RT, pformat=pformat, realtime=realtime, no_download=no_download, name=name)
Function: files = mvn_pfp_file_retrieve(PATHNAME) Purpose: Retrieve or Download MAVEN 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: 'maven/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 = mvn_pfp_file_retrieve('maven/pfp/l0/YYYY/MM/mvn_pfp_all_l0_YYYYMMDD_v???.dat',/daily_names) ; get L0 files for user defined time span files = mvn_pfp_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
Parameters
- pathname
Keywords
- trange
- verbose
- source
- files
- last_version
- valid_only
- no_update
- create_dir
- pos_start
- remote_kp_cdf
- insitu_kp_cdf
- daily_names
- hourly_names
- resolution
- shiftres
- no_server
- user_pass
- L0
- recent
- DPU
- ATLO
- RT
- pformat
- realtime
- no_download
- name
File attributes
Modification date: | Wed Dec 10 10:08:31 2014 |
Lines: | 112 |