buildWindow - Creates a window and returns an array of panels (single panel currently supported)
| height= | height of the window |
| width= | width of the window |
| panelTypes= | type of display to create MAP (default) GLOBE |
openBundle - Creates a new window and displays contents of a bundle
| bundle file= | file name of bundle |
| height= | height of display; default= height of the display window when the bundle was saved |
| width= | width of display; default= width of the display window when the bundle was saved |
| dataDirectory= | a dictionary where the keys are datasource names, and the values are either a string or list of strings representing the full path name/names of the data that will be used in place of the data in the bundle |
| mode= | specifies the method that will be used to open the bundle REPLACE - Removes any previously-loaded layers and data sources and replaces the current session with the bundle's data (default) NEWWINDOW - Loads the bundle's data and displays into a new window, without removing any previously-loaded layers and data sources MERGE - Loads the bundle's data and displays into the current tab of the active display window without removing any previously-loaded layers and data sources NEWTAB - Loads the bundle's data and displays into a new tab of the active display window without removing any previously-loaded layers and data sources |
makeLocalADDEEntry - Creates a local ADDE entry in the server table
| dataset= | name of dataset - limit of 8 characters |
| mask= | directory containing the files used by the dataset |
| format= | data format of files used within the dataset. Either Full Name or Short Name can be used as valid options |
| Full Name | Short Name |
|---|---|
| "AMSR-E L 1b" | "AMSR" |
| "AMSR-E L 2a" | "AMSE" |
| "AMSR-E Rain Product" | "AMRR" |
| "LRIT GOES-9" | "FSDX_G9" |
| "LRIT GOES-10" | "FSDX_G10" |
| "LRIT GOES-11" | "FSDX_G11" |
| "LRIT GOES-12" | "FSDX_G12" |
| "LRIT MET-5" | "FSDX_M5" |
| "LRIT MET-7" | "FSDX_M7" |
| "LRIT MTSAT-1R" | "FSDX_MT" |
| "McIDAS Area" | "AREA" |
| "Meteosat OpenMTP" | "OMTP" |
| "Metop AVHRR L 1b" | "LV1B_METOP" |
| "MODIS MOD 02 - Level 1B Calibrated Geolocated Radiances" | "MODS" |
| "MODIS MOD 04 - Aerosol Product" | "MOD4" |
| "MODIS MOD 06 - Cloud Product" | "MODX_06" |
| "MODIS MOD 07 - Atmospheric Profiles" | "MODX_07" |
| "MODIS MOD 28 - Sea Surface Temperature" | "MOD8" |
| "MODIS MOD 35 - Cloud Mask" | "MODX_35" |
| "MODIS MOD R - Corrected Reflectance" | "MODR" |
| "MSG HRIT FD" | "MSGT_FD" |
| "MSG HRIT HRV" | "MSGT_HRV" |
| "MTSAT HRIT" | "MTST" |
| "NOAA AVHRR L 1b" | "LV1B_NOAA" |
| "SSMI" | "SMIN" |
| "TRMM" | "TMIN" |
| "GINI" | "GINI" |
| imageType= | image type name for local server entry. (default=format_dataset) |
| save= | determines if the dataset will be retained from session to session (default = False) True = retains the dataset between sessions False = does not retain the dataset between sessions |
getLocalADDEEntry - Gets the descriptor for a local ADDE entry
| dataset= | local ADDE entry dataset name |
| imageType= | image type of local ADDE entry |
loadADDEImage - Requests data from an ADDE Image server - returns one object containing both data and metadata
| localEntry= | local dataset defined by makeLocalADDEEntry or the descriptor returned from getLocalADDEEntry |
| server= | ADDE server |
| dataset= | ADDE dataset group name |
| descriptor= | ADDE dataset descriptor |
| day= | single day ('date 1') or as a day range ('begin date','end date'); default=most recent day included in data |
| time= | ('begin time','end time'); default=most recent time included in data |
| coordinateSystem= | coordinate system to use for retrieving data; default=server dependent AREA = AREA file coordinates - zero based LATLON = latitude and longitude coordinates IMAGE = image coordinates - one based |
| location= | (x,y); default=coordinateSystem dependent x = AREA line, latitude, or IMAGE line y = AREA element, longitude, or IMAGE element |
| place= | CENTER places specified location (x,y) at center of panel (default) ULEFT places specified location (x,y) at upper-left coordinate of panel |
| band= | McIDAS band number; must be specified if requesting data from multi-banded image; default=band in image |
| unit= | calibration unit to request; default = 'BRIT' |
| position= | time relative (negative values) or absolute (positive values) position in the dataset; default=0 (most recent image) |
| size= | number of lines and elements to request; default=(480,640) |
| mag= | magnification of data (line,element), negative number used for sampling data; default=(1,1) |
| accounting= | ('user', 'project number') user and project number required by servers using McIDAS accounting; default = ('idv','0') |
| debug= | send debug information to file; default=False |
| track= |
True = with real-time data, will wait until the most recent image is complete before pulling it in False = with real-time data, will not wait until the most recent image is complete before pulling it in. Dependent on when the loadADDEImage command is run, this may result in an incomplete image. default=False |
listADDEImages - Lists data from an ADDE Image server that matches the keywords in the request - returns metadata objects which can be passed into loadADDEImage
| localEntry= | local dataset defined by makeLocalADDEEntry or the descriptor returned from getLocalADDEEntry |
| server= | ADDE server |
| dataset= | ADDE dataset group name |
| descriptor= | ADDE dataset descriptor |
| day= | single day ('date 1') or as a day range ('begin date','end date'); default=most recent day included in data |
| time= | ('begin time','end time'); default=most recent time included in data |
| band= | McIDAS band number; must be specified if requesting data from multi-banded image; default=band in image |
| unit= | calibration unit to request; default = 'BRIT' |
| position= | time relative (negative values) or absolute (positive values) position in the dataset; default=0 (most recent image) |
| accounting= | ('user', 'project number') user and project number required by servers using McIDAS accounting; default = ('idv','0') |
| debug= | send debug information to file; default=False |
listADDEImageTimes - Returns a list of available dates and times of data that match the keywords in the request
| localEntry= | local dataset defined by makeLocalADDEEntry or the descriptor returned from getLocalADDEEntry |
| server= | ADDE server |
| dataset= | ADDE dataset group name |
| descriptor= | ADDE dataset descriptor |
| day= | single day ('date 1') or as a day range ('begin date','end date'); default=most recent day included in data |
| time= | ('begin time','end time'); default=most recent time included in data |
| band= | McIDAS band number; must be specified if requesting data from multi-banded image; default=band in image |
| unit= | calibration unit to request; default = 'BRIT' |
| position= | time relative (negative values) or absolute (positive values) position in the dataset; default=0 (most recent image) |
| accounting= | ('user', 'project number') user and project number required by servers using McIDAS accounting; default = ('idv','0') |
| debug= | send debug information to file; default=False |
loadGrid - Loads local netCDF, hdf, and grib files.
| filename= | directory path to local gridded file |
| field= | the short name of the field to load. A listing of field short names included in a file can be printed using listGridFieldsInFile. |
| level= | the vertical level and units to load. Default="All". A listing of vertical levels included with a field can be printed using listGridLevelsInField. Example: level="1000 hPa" |
| time= | the time to load. This can be an integer representing the index of time to be loaded (Default=0 for earliest time). A listing of times included with a field can be printed using listGridTimesInField. This can also be set as a date/time text string. Example: time="2014-01-16 18:00:00 UTC" |
| xStride= | integer value to reduce the resolution of display in the x-direction. Default=1 for full resolution. Higher values reduce the resolution. |
| yStride= | integer value to reduce the resolution of display in the y-direction. Default=1 for full resolution. Higher values reduce the resolution. |
| stride= | integer value to reduce the resolution of the display in the x and y-directions. Default=1 for full resolution. Higher values reduce the resolution. |
| xRange= | integer for geographically subsetting by grid indices in the x-direction. By default, no geographical subsetting is done. Example: xRange=(0,80) |
| yRange= | integer for geographically subsetting by grid indices in the y-direction. By default, no geographical subsetting is done. Example: yRange=(0,80) |
| latLonBounds= | geographically subset by lat/lon bounds. By default, no subsetting is done. The expected format is (upper left lat, upper left, lon, lower right lat, lower right lon). Example: latLonBounds=(50,-130,20,-65) |
listGridFieldsInFile - Lists the fields in a file brought in with loadGrid. The output is shortname ; longname
| filename= | directory path to local gridded file |
listGridLevelsInField - Lists the vertical levels included in a field of a loadGrid file
| filename= | directory path to local gridded file |
| field= | the short name of the field to list levels of. A listing of field short names included in a file can be printed using listGridFieldsInFile |
listGridTimesInField - Lists the times included in a field of a loadGrid file
| filename= | directory path to local gridded file |
| field= | the short name of the field to list times of. A listing of field short names included in a file can be printed using listGridFieldsInFile |
createLayer - Creates a new data layer in a panel
| display type= | display type for layer; valid options shown in Field Selector (e.g. 'Image Display', 'Image Sequence Display') |
| myData= | data object to display (from loadADDEImage) |