Univeristy of Alabama in Huntsville

UAH LTG IDL Library

IDL Routines from Phillip Bitzer and UAH Lightning Group

summary     class     fields     routine details     file attributes

ats509/

ats_import_armor_nc.pro

Radar, ATS509

includes main-level program

This routine will, given a file, return the specified radar variable in an a dictionary.

This file is for use with ATS509. There is a different import routine for regular use available.

On error, a -1 is returned.

Author information

Author

Phillip M. Bitzer, University of Alabama in Huntsville, pm.bitzer "AT" uah.edu

History

Modification History:

First written: Nov 2, 2012 Got rid of suprious call to STRUPCASE when retrieving variables 20121109 PMB Rewritten with new name - ats_import_armor_nc 20131030 PMB Update to return data in a dictionary. 20171107 PMB Future changes will be reflected in the Git log.

Routines

Routines from ats_import_armor_nc.pro

result = ats_import_armor_nc_get_var(id, thisVar, varNames)

This is a helper routine that gets an individual variable from a list of variable names in the NetCDF file.

result = ats_import_armor_nc(file, variable [, Attributes=structure array] [, Varnames=string array])

This function will get the variable(s) of interest from a NetCDF file of gridded radar data from ARMOR.

Routine details

top ats_import_armor_nc_get_var

result = ats_import_armor_nc_get_var(id, thisVar, varNames)

This is a helper routine that gets an individual variable from a list of variable names in the NetCDF file.

Return value

The variable of interest. If the variable is not found, -1 is returned.

Parameters

id in required type=long integer

The id of the opened NetCDF file

thisVar in required type=long integer

The variable you wish to retrieve

varNames in required type=string array

An array of variable names

top ats_import_armor_nc

result = ats_import_armor_nc(file, variable [, Attributes=structure array] [, Varnames=string array])

This function will get the variable(s) of interest from a NetCDF file of gridded radar data from ARMOR.

Return value

A dictionary is returned with data, x, y, z, and time keys. The data key is a nested dictionary of radar variables. Each key in data is a different variable, and the name of the key indicates which variable is available.

Parameters

file in required type=string

The NetCDF file containing the data

variable in required type=string scalar or array

The variables you wish to retrieve. The string should match the variable in the file (case insensitive).

Keywords

Attributes out optional type=structure array

The global attributes in the file. An array of structures, with tags name, value.

Varnames out optional type=string array

The variables that are found in the file. Useful to probe the file, if needed

File attributes

Modification date: Mon Nov 13 15:25:26 2017
Lines: 52
Docformat: rst rst