[Go to Previous] [Go to Next]

Create an Object - Imagery

getLocalADDEEntry - Gets the descriptor for a local ADDE entry

Usage: localDescriptor=getLocalADDEEntry(keywords)
Keywords - required:
dataset= local ADDE entry dataset name
imageType= image type of local ADDE entry
Example:
desc = getLocalADDEEntry(dataset='AREA',imageType='Area files')

listADDEImages - Lists data from an ADDE Image server that matches the keywords in the request - returns metadata objects which can be passed into loadADDEImage

Usage: directoryList = listADDEImages(keywords)
Keywords - required (local):
localEntry= local dataset defined by makeLocalADDEEntry or the descriptor returned from getLocalADDEEntry
Keywords - required (remote):
server= ADDE server
dataset= ADDE dataset group name
descriptor= ADDE dataset descriptor
Keywords - optional:
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. Use "ALL" to obtain all positions. Multiple positions are obtained when a negative value is used. For example, if position=-4 is used, then the five most recent images will be obtained (positions -4, -3, -2, -1, and 0 (most recent)); default=0 (most recent image).
accounting= ('user', 'project number') user and project number required by servers using McIDAS accounting; default = ('idv','0'). If no accounting is defined for a server/dataset requiring it, McIDAS-V will first check the ADDE Data Manager to see if any accounting is defined for the server/dataset before erroring
debug= send debug information to file; default=False
showUrls= True = Prints the ADDE URL returned from the server to the Jython Shell once the command has completed
False = Does not print the ADDE URL returned from the server to the Jython Shell once the command has completed
default=True
Examples:
directoryListLocal = listADDEImages(localEntry=desc, band=4, unit='TEMP')
directoryListRemote = listADDEImages(server='adde.ucar.edu',dataset='RTIMAGES',descriptor='GE-IR',unit='TEMP')
The data object returned from listADDEImages contains a variety of key:value pairings with information about the data. The list of keys may vary dependent on the server or type of data, but here is a general list of keys that may be included in the data object returned from listADDEImages as well as example values:
Key Example Value
accounting ('idv', '0')
band-count 1
bandList [10]
bandNumber 10
bands [10]
calibration-scale-factor 1
calibration-type RAW
calibration-unit-name None
calinfo ['RAW', 'RAW', 'TEMP', 'TEMPERATURE', 'BRIT', 'BRIGHTNESS'
center-latitude 38.494698
center-latitude-resolution 2.0
center-longitude -74.999992
center-longitude-resolution 2
centerLocation (38.494698, -74.999992)
dataset EASTA
datetime 2018-10-24 14:51:27Z
day 2018297
debug false
descriptor M1
directory-block list of the first 64 words of the AREA
elements 500
imageSize (500, 500)
lines 500
memo-field GOES Mesoscale1
nominal-time 2018-10-24 14:51:27Z
resolution (2.0, 2.0)
sensor-id 186
sensor-type GOES 16 imager
server easta.ssec.wisc.edu
source-type ABIN
start-time

2018-10-24 14:51:27Z
time 14:51:27
unitList ['TEMP']
unitType TEMP
url URL that prints to Jython Shell when data retrieved
These keys and values can be accessed the same way as defined in loadADDEImage.

listADDEImageTimes - Returns a list of available dates and times of data that match the keywords in the request

Usage: directoryList = listADDEImageTimes(keywords)
Keywords - required (local):
localEntry= local dataset defined by makeLocalADDEEntry or the descriptor returned from getLocalADDEEntry
Keywords - required (remote):
server= ADDE server
dataset= ADDE dataset group name
descriptor= ADDE dataset descriptor
Keywords - optional:
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. Use "ALL" to obtain all positions. Multiple positions are obtained when a negative value is used. For example, if position=-4 is used, then the five most recent images will be obtained (positions -4, -3, -2, -1, and 0 (most recent)); default=0 (most recent image)
accounting= ('user', 'project number') user and project number required by servers using McIDAS accounting; default ('idv','0'). If no accounting is defined for a server/dataset requiring it, McIDAS-V will first check the ADDE Data Manager to see if any accounting is defined for the server/dataset before erroring
debug= send debug information to file; default=False
showUrls= True = Prints the ADDE URL returned from the server to the Jython Shell once the command has completed
False = Does not print the ADDE URL returned from the server to the Jython Shell once the command has completed
default=True
Examples:
print listADDEImageTimes(localEntry=desc, position=-5)
print listADDEImageTimes(server='adde.ucar.edu',dataset='RTIMAGES',descriptor='GE-IR',time=('02:00','04:00'),position='ALL')
The data object returned from listADDEImageTimes contains a variety of key:value pairings with information about the data. The list of keys may vary dependent on the server or type of data, but here is a general list of keys that may be included in the data object returned from listADDEImageTimes as well as example values:
Key Example Value
datetime '2018-10-24 14:46:27Z'
day '2018297'
time '14:46:27'
These keys and values can be accessed the same way as defined in loadADDEImage assuming that a data object returned from listADDEImageTimes was defined (e.g. timeList = listADDEImageTimes(...)).

loadADDEImage - Requests data from an ADDE Image server - returns one object containing both data and metadata

Usage: Local: dataLocal=loadADDEImage(keywords)
Keywords - required (local):
localEntry= local dataset defined by makeLocalADDEEntry or the descriptor returned from getLocalADDEEntry
Keywords - required (remote):
server= ADDE server
dataset= ADDE dataset group name
descriptor= ADDE dataset descriptor
Keywords - optional:
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. Use "ALL" to obtain the full size of the image; 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'). If no accounting is defined for a server/dataset requiring it, McIDAS-V will first check the ADDE Data Manager to see if any accounting is defined for the server/dataset before erroring
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
showUrls= True = Prints the ADDE URL returned from the server to the Jython Shell once the command has completed
False = Does not print the ADDE URL returned from the server to the Jython Shell once the command has completed
default=True
Examples:
dataLocal = loadADDEImage(localEntry=desc, size='ALL', mag=(1,1), unit='BRIT',debug=True)
dataRemote = loadADDEImage(server='adde.ucar.edu',dataset='RTIMAGES',descriptor='GE-IR',band=4,unit='TEMP')
The data object returned from loadADDEImage contains a variety of key:value pairings with information about the data. The list of keys may vary dependent on the server or type of data, but here is a general list of keys that may be included in the data object returned from loadADDEImage as well as example values:
Key Example Value
accounting ('idv', '0')
debug False
server adde.ucar.edu
calibration-scale-factor 1
bands [4]
nominal-time 2016-03-08 15:15:00Z
datetime 2016-03-08 15:15:18Z
directory-block list of the first 64 words of the AREA
source-type 'GVAR'
band-count 1
lines 480
day '2016068'
sensor-id 180
satband-band-label 10.7 um IR Surface/Cloud-top Temp
calibration-type 'BRIT'
start-time 2016-03-08 15:15:18Z
bandNumber 4
url URL that prints to Jython Shell when data retrieved
memo-field any memos included with data (e.g. the calibration-type)
elements 640
bandList [4]
sensor-type 'GOES 13 imager'
These keys and values can be printed as follows:
print dataRemote['satband-band-label']
A practical use for this satband-band-label key would be to apply it to a layer label. This example adds the key to the layer label along with the %timestamp% macro:
layer.setLayerLabel(dataRemote['satband-band-label']+' %timestamp%')

makeLocalADDEEntry - Creates a local ADDE entry in the server table

Usage: localDataset=makeLocalADDEEntry(keywords)
Keywords - required:
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"
"MSG Native Format"* "MSGS"*
"Himawari-8"* "WARI"*
"HimawariCast"* "WARC"*
"INSAT-3D Imager"* "INSAT3D_IMAGER"*
"INSAT-3D Sounder"* "INSAT3D_SOUNDER"*
"GOES ABI"* "ABIN"*
"Sectorized CMI"* "SCMI"*
"VIIRS SDR Day/Night Band"* "VIIRSD"*
"VIIRS SDR I-Band"* "VIIRSI"*
"VIIRS SDR M-Band"* "VIIRSM"*
"VIIRS EDR I-Band"* "VIIREI"*
"VIIRS EDR M-Band"* "VIIREM"*

* The WARI, WARC, INSAT-3D*, ABI, SCMI, VIIRS, and MSGS local servers are currently supported on Linux and OS X/macOS platforms

Keywords - optional:
imageType= text description of the data used for the 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
Example:
dataPath = 'C:/Users/myUser/Data/AREA'
areaDataset=makeLocalADDEEntry(dataset='AREA', imageType='Area files', save=True, mask=dataPath, format='McIDAS Area')

[Go to Previous] [Go to Next]