This page was created by the IDL library routine mk_html_help2.

Last modified: Fri Jun 30 10:57:01 2017.


Directory Listing of Routines


Routine Descriptions

SPP_FLD_CDF_CREATE

[Next Routine] [List of Routines]
 NAME:
   SPP_FLD_CDF_CREATE

 PURPOSE:
   Creates a FIELDS CDF file using the CDF_CREATE function.

 CALLING SEQUENCE:
   spp_fld_cdf_create, 1, 0, cdf_att, filename_timestring, $
     filename = filename, fileid = fileid

 INPUTS:
   LEVEL: The level (L1, L2, ...) of the created CDF file
   VERS_NUM: The version number of the file
   CDF_ATT: An IDL dictionary containing the global attributes of the CDF file,
     read (for L1 files) from the XML definition of the APID or (for higher
     level files) from the lower level CDF files.
   FILENAME_TIMESTRING: A string specifying the time string included in the
     CDF filename.  For a daily file, the format is YYYYMMDD.  For a specific
     non-daily interval, the format is YYYYMMDDHHMMSS_YYYYMMDDHHMMSS, with the
     two times specifying the start and end of the interval.

 OUTPUTS:
   FILENAME: The full path of the created CDF file.
   FILEID: The CDF file ID assigned to the created CDF file by CDF_CREATE.

 EXAMPLE:
   See call in SPP_FLD_MAKE_CDF_L1.

 CREATED BY:
   pulupa

 $LastChangedBy: pulupalap $
 $LastChangedDate: 2017-06-12 10:50:22 -0700 (Mon, 12 Jun 2017) $
 $LastChangedRevision: 23450 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/SPP/fields/common/spp_fld_cdf_create.pro $

(See projects/SPP/fields/common/spp_fld_cdf_create.pro)


SPP_FLD_CDF_PUT_DATA

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
   SPP_FLD_CDF_PUT_DATA

 PURPOSE:
   Stores SPP/FIELDS data in a created CDF file.

 CALLING SEQUENCE:
   spp_fld_cdf_put_data, fileid, data, close = close

 INPUTS:
   FILEID: The file ID of the destination CDF file.
   DATA: A single IDL hash which contains items to be put into the
     CDF file.  The items themselves are hashes.  Each data item is itself
     an IDL hash which contains:
       - the parsed information from the corresponding XML file definition
         of the data item
       - the set of CDF attributes which will be stored as metadata in the
         CDF file
       - the data itself, as an IDL list.  The list is converted into an
         array before being stored in the CDF file.
     Items which do not have defined CDF attributes are not stored in the
     CDF file.
   CLOSE: Set to 1 to close the CDF after putting in the data.

 OUTPUTS:
   No explicit outputs are returned.  After completion, the data in the
   input IDL hash is stored in the specified CDF file.

 EXAMPLE:
   See call in SPP_FLD_MAKE_CDF_L1.

 CREATED BY:
   pulupa

 $LastChangedBy: pulupalap $
 $LastChangedDate: 2017-05-20 11:46:22 -0700 (Sat, 20 May 2017) $
 $LastChangedRevision: 23342 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/SPP/fields/common/spp_fld_cdf_put_data.pro $

(See projects/SPP/fields/common/spp_fld_cdf_put_data.pro)


SPP_FLD_CDF_PUT_DEPEND

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
   SPP_FLD_CDF_PUT_DEPEND

 PURPOSE:
   Add support variables to a SPP FIELDS CDF file.
   Some dimensional CDF variables (such as spectrograms) require additional
   support data which are not directly specified in the data packet.  
   For example, the frequencies of the RFS LFR and HFR spectra are not 
   included in the LFR and HFR packets.  The XML definition of the packet
   can optionally include a key (ADD_CDF_DEPEND_ROUTINE) which specifies
   an IDL routine that adds the support variable to the CDF.

 CALLING SEQUENCE:
   spp_fld_cdf_put_depend, fileid, idl_att = idl_att

 INPUTS:
   FILEID: The file ID of the destination CDF file.
   IDL_ATT: If set, contains the 'IDL_ATT' attributes returned from reading
     the XML file defining the structure of the data to be stored in the CDF.
     If this exists, and if it has a key ADD_CDF_DEPEND_ROUTINE, then the
     defined routine is run and adds support variable(s) to the CDF.
     If not, this routine has no effect.

 OUTPUTS:
   No explicit outputs are returned.  After completion, the support data is
   stored in the specified CDF file.

 EXAMPLE:
   See call in SPP_FLD_MAKE_CDF_L1.

 CREATED BY:
   pulupa

 $LastChangedBy: pulupalap $
 $LastChangedDate: 2017-01-11 16:14:34 -0800 (Wed, 11 Jan 2017) $
 $LastChangedRevision: 22579 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/SPP/fields/common/spp_fld_cdf_put_depend.pro $

(See projects/SPP/fields/common/spp_fld_cdf_put_depend.pro)


SPP_FLD_CDF_PUT_METADATA

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
   SPP_FLD_CDF_PUT_METADATA

 PURPOSE:
   Add metadata to a SPP FIELDS CDF file.
   This includes general metadata which applies for all SPP data products
   as well as file-specific attributes from the XML files which define
   the data items.  Variable attributes are created as well.

 CALLING SEQUENCE:
   spp_fld_cdf_put_metadata, fileid, filename, cdf_atts

 INPUTS:
   FILEID: The file ID of the destination CDF file.
   FILENAME: The name of the CDF file.
   CDF_ATTS: File-specific CDF attributes, read from the XML file which
     defines the data product.
   
 OUTPUTS:
   No explicit outputs are returned.  After completion, the data in the
   input IDL hash is stored in the specified CDF file.;

 EXAMPLE:
   See call in SPP_FLD_MAKE_CDF_L1.

 CREATED BY:
   pulupa

 $LastChangedBy: pulupalap $
 $LastChangedDate: 2017-01-11 16:14:34 -0800 (Wed, 11 Jan 2017) $
 $LastChangedRevision: 22579 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/SPP/fields/common/spp_fld_cdf_put_metadata.pro $

(See projects/SPP/fields/common/spp_fld_cdf_put_metadata.pro)


SPP_FLD_CDF_PUT_TIME

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
   SPP_FLD_CDF_PUT_TIME

 PURPOSE:
   Add time data to a SPP FIELDS CDF file, in several formats.
   The formats are TT2000 time (which is stored in the CDF file as
   'epoch'), Unix time, and MET.
   
 CALLING SEQUENCE:
   spp_fld_cdf_put_time, fileid, times

 INPUTS:
   FILEID: The file ID of the destination CDF file.
   TIME: An array of times.
   SUFFIX: An optional parameter which adds a suffix

 OUTPUTS:
   No explicit outputs are returned.  After completion, the input times
   are stored in the CDF file.

 EXAMPLE:
   See call in SPP_FLD_MAKE_CDF_L1.

 CREATED BY:
   pulupa

 $LastChangedBy: pulupalap $
 $LastChangedDate: 2017-01-11 16:14:34 -0800 (Wed, 11 Jan 2017) $
 $LastChangedRevision: 22579 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/SPP/fields/common/spp_fld_cdf_put_time.pro $

(See projects/SPP/fields/common/spp_fld_cdf_put_time.pro)


SPP_FLD_CDF_TIMESPAN

[Previous Routine] [List of Routines]
 NAME:
   SPP_FLD_CDF_TIMESPAN

 PURPOSE:
   Define a timestring for SPP FIELDS CDF files.

 CALLING SEQUENCE:
   spp_fld_cdf_timespan, trange = trange, success = success, $
     filename_timestring = filename_timestring

 INPUTS:
   TRANGE: An optional one or two element input specifying the time range.
     A one element input implies a daily 24 hour file.  Two elements imply
     a specific start and end time.

 OUTPUTS:
   SUCCESS: Returns 1 if the timespan and timestring are set.
   FILENAME_TIMESTRING: Returns a string specifying the time string
     portion of the CDF file that will be created.  If the file is
     a daily file, the format is YYYYMMDD.  If the file is not
     a daily file, the format is YYYYMMDD_HHMMSS_YYYYMMDD_HHMMSS, with
     the two halves of the string corresponding to the start and
     end of the interval.

 EXAMPLE:
   See call in SPP_FLD_MAKE_CDF_L1.

 CREATED BY:
   pulupa

 $LastChangedBy: pulupalap $
 $LastChangedDate: 2017-01-11 16:14:34 -0800 (Wed, 11 Jan 2017) $
 $LastChangedRevision: 22579 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/SPP/fields/common/spp_fld_cdf_timespan.pro $

(See projects/SPP/fields/common/spp_fld_cdf_timespan.pro)