This page was created by the IDL library routine `mk_html_help2`.

Last modified: Thu Aug 9 01:15:36 2012.

# Directory Listing of Routines

# ssl_general/CDF

- CDF2TPLOT
- CDF_INFO
  Returns a structure with useful information about a CDF file.
- CDF_INFO_TO_TPLOT
- CDF_LOAD_VARS
- CDF_SAVE_VARS
- CDF_SET_CDF27
  Call CDF_SET_CDF27_BACKWARD_COMPATIBLE but don't bomb unnecessarily when
- CDF_VAR_ATTS
  Returns a structure that contains all the attributes of a variable within
- MAKE_CDF_INDEX
  Creates an index file for CDF files.
- PRINT_CDF_INFO

# Routine Descriptions

## CDF2TPLOT

[Next Routine] [List of Routines]

     Please note this routine is still in development
    CDF2TPLOT ,files,varnames=varnames,all=all

     record=record if only one record and not full cdf-file is requested

     $LastChangedBy: davin-win $
     $LastChangedDate: 2011-02-11 15:55:04 -0800 (Fri, 11 Feb 2011) $
     $LastChangedRevision: 8197 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/CDF/cdf2tplot.pro $

(See ssl_general/CDF/cdf2tplot.pro)

## CDF_INFO

[Previous Routine] [Next Routine] [List of Routines]

    NAME:  cdf_info
    FUNCTION:   cdf_info(id)
    PURPOSE:
      Returns a structure with useful information about a CDF file.
      In particular the number of file records is returned in this structure.
    INPUT:
       id:   CDF file ID.
    CREATED BY:    Davin Larson
     LAST MODIFIED: @(#)cdf_info.pro    1.9 02/11/01
     $LastChangedBy: davin-win $
     $LastChangedDate: 2011-02-11 15:55:04 -0800 (Fri, 11 Feb 2011) $
     $LastChangedRevision: 8197 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/CDF/cdf_info.pro $

(See ssl_general/CDF/cdf_info.pro)

## CDF_INFO_TO_TPLOT

[Previous Routine] [Next Routine] [List of Routines]

     This is a new routine that needs further testing, development, and enhancements.
     PROCEDURE:  cdf2tplot, cdfi
     Purpose:  Creates TPLOT variables from a CDF structure (obtained from "CDF_LOAD_VAR")
     This routine will only work well if the underlying CDF file follows the SPDF standard.

     Written by Davin Larson

     $LastChangedBy: pcruce $
     $LastChangedDate: 2012-04-17 12:00:02 -0700 (Tue, 17 Apr 2012) $
     $LastChangedRevision: 10342 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/CDF/cdf_info_to_tplot.pro $

(See ssl_general/CDF/cdf_info_to_tplot.pro)

## CDF_LOAD_VARS

[Previous Routine] [Next Routine] [List of Routines]

     FUNCTION cdfi = cdf_load_vars(file)
     Keywords:
       VARFORMAT = string or string array:  a string or string array (which may contain wildcard
                             characters) that specifies the CDF variable names to load.  Use
                              'VARFORMAT='*' to load all variables.
       VARNAMES = named variable   ;output variable for variable names that were loaded.
       SPDF_DEPENDENCIES :   Set to 1 to have SPDF defined dependent variables also loaded.
       VAR_TYPE = string or string array;  Variables that have a VAR_TYPE matching these strings will
                             be loaded.
       CONVERT_INT1_TO_INT2  Set this keyword to convert signed one byte to signed 2 byte integers.
                             This is useful because IDL does not have the equivalent of INT1   (bytes are unsigned)
       RECORD: Specify the record index where you want to start reading.  By default, this option will read one record.
       NUMBER_RECORDS: Specify the number of records that you want to read.  By default, this option will begin at record zero.

     Note: Record & Number_Records can be used together to specify a range of records to be read.

     Author: Davin Larson - 2006

     $LastChangedBy: pcruce $
     $LastChangedDate: 2012-04-10 11:22:01 -0700 (Tue, 10 Apr 2012) $
     $LastChangedRevision: 10313 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/CDF/cdf_load_vars.pro $

(See ssl_general/CDF/cdf_load_vars.pro)

## CDF_SAVE_VARS

[Previous Routine] [Next Routine] [List of Routines]

     FUNCTION: dummy = cdf_save_vars(cdf_structure,new_cdf_name)
     PURPOSE:  To dump data and metadata from an IDL structure into a CDF file.
    		The structure format is the structure produced by cdf_load_vars.pro
     INPUTS:   cdf_structure : IDL structure defined by cdf_load_vars.pro
    	    new_cdf_name  : a string to name the new CDF file with
     OUTPUTS:  CDF file named by the new_cdf_name input
     EXAMPLE:  dummy = cdf_save_vars(cdfi,'newcdf.cdf')

     Written by: Matt Davis

    Note: To use this routine you must have the CDF_EPOCH/CDF_EPOCH16 bug patch on your IDL6.3
    and if you are using Solaris you need to be in 32-bit mode NOT 64-bit (ie, idl -32)

(See ssl_general/CDF/cdf_save_vars.pro)

## CDF_SET_CDF27

[Previous Routine] [Next Routine] [List of Routines]

     NAME: cdf_set_cdf27
     SYNTAX:
       cdf_set_cdf27 [, /yes | /no]
     PURPOSE:
       Call CDF_SET_CDF27_BACKWARD_COMPATIBLE but don't bomb unnecessarily when
       run on an (unpatched) pre-IDL 6.3, pre-CDF 3.1 installation of IDL.
     VERSION:
       $LastChangedBy: kenb-mac $
       $LastChangedDate: 2006-12-13 11:21:07 -0800 (Wed, 13 Dec 2006) $
       $LastChangedRevision: 88 $
       $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/CDF/cdf_set_cdf27.pro $

(See ssl_general/CDF/cdf_set_cdf27.pro)

## CDF_VAR_ATTS

[Previous Routine] [Next Routine] [List of Routines]

    NAME:  cdf_var_atts
    FUNCTION:   cdf_var_atts(id [,var[,attname]])
    PURPOSE:
      Returns a structure that contains all the attributes of a variable within
      a CDF file. If attname is provided then it returns the value of only that attribute.
    KEYWORDS:
      DEFAULT: The default value of the attribute.
      ATTRIBUTES=att  A named variable that returns an array of structures containing attribute info
                      if this variable is passed in on subsequent calls to cdf_var_atts it can significantly
                      improve performance.   OBSOLETE!!!
    USAGE:
       atts = cdf_var_atts(file)  ; returns structure containing all global attributes
       atts = cdf_var_atts(file
    INPUT:
       id:         CDF file ID or filename.
       var;        CDF variable name or number
       attname:    CDF attribute name
    CREATED BY:    Davin Larson
     $LastChangedBy: jimm $
     $LastChangedDate: 2008-03-11 12:14:10 -0700 (Tue, 11 Mar 2008) $
     $LastChangedRevision: 2469 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/CDF/cdf_var_atts.pro $

(See ssl_general/CDF/cdf_var_atts.pro)

## MAKE_CDF_INDEX

[Previous Routine] [Next Routine] [List of Routines]

    NAME:
      make_cdf_index
    PROCEDURE:
      make_cdf_index,  [pattern]
    PURPOSE:
      Creates an index file for CDF files.
      The index file will have one line for each CDF file found.
      Each line contains the start time, end time and filename
      with the following format:
    YYYY-MM-DD/hh:mm:ss  YYYY-MM-DD/hh:mm:ss   fullpathname.cdf
      CDF files may be distributed over many directories or disks.

    INPUT:
      pattern:  (string) file pattern, default is:  '*.cdf'
    KEYWORDS:
      DATA_DIREC  (string) data directory(s)
      INDEX_FILENAME:  (string) Name of index file to be created.
      NO_DUPLICATES:   Set to 1 if duplicate days are to be ignored.
    SEE ALSO:
      "makecdf","loadcdf","loadcdfstr","loadallcdf",
    CREATED BY:
      Davin Larson,  August 1996
    VERSION:
      02/04/17  make_cdf_index.pro  1.5

(See ssl_general/CDF/make_cdf_index.pro)

## PRINT_CDF_INFO

[Previous Routine] [List of Routines]

    PROCEDURE:     print_cdf_info
    PURPOSE:   prints information about a specified cdf file
    INPUT:
       filename: The name of the file for which info is desired.
    KEYWORDS:
       none

    CREATED BY:    D. Larson
    LAST MODIFICATION:     @(#)print_cdf_info.pro 1.13 02/11/01

(See ssl_general/CDF/print_cdf_info.pro)