awips2/cave/com.raytheon.viz.gfe/localization/gfe/userPython/smartTools/Swell2Tool.py
2017-06-23 12:21:55 -06:00

112 lines
4 KiB
Python

##
# This software was developed and / or modified by Raytheon Company,
# pursuant to Contract DG133W-05-CQ-1067 with the US Government.
#
# U.S. EXPORT CONTROLLED TECHNICAL DATA
# This software product contains export-restricted data whose
# export/transfer/disclosure is restricted by U.S. law. Dissemination
# to non-U.S. persons whether in the United States or abroad requires
# an export license or other authorization.
#
# Contractor Name: Raytheon Company
# Contractor Address: 6825 Pine Street, Suite 340
# Mail Stop B8
# Omaha, NE 68106
# 402.291.0100
#
# See the AWIPS II Master Rights File ("Master Rights File.pdf") for
# further licensing information.
##
# ----------------------------------------------------------------------------
# This software is in the public domain, furnished "as is", without technical
# support, and with no warranty, express or implied, as to its usefulness for
# any purpose.
#
# Swell2Tool
#
# Author:
# ----------------------------------------------------------------------------
ToolType = "numeric"
WeatherElementEdited = "Swell2"
from numpy import *
# You can screen the elements for which your tool will appear by using
# a ScreenList. For example:
#
#ScreenList = ["T","Td"]
#ScreenList = ["SCALAR","VECTOR","WEATHER","DISCRETE"]
### If desired, Set up variables to be solicited from the user:
##VariableList = [
## ("Variable name1" , defaultValue1, "numeric"),
## ("Variable name2" , "default value2", "alphaNumeric"),
## ("Variable name3" , ["default value1", "default value2"], "check",
## ["value1", "value2", "value3"]),
## ("Variable name4" , "default value4", "radio",
## ["value1", "value2", "value3"]),
## ("Variable name5" , defaultValue, "scale",
## [minValue, maxValue], resolution),
## ("Variable name6" , "", "model"),
## ("Variable name7" , "", "D2D_model"),
## ("Label contents" , "", "label"),
## ("", dialogHeight, "scrollbar"),
## ]
# Set up Class
import SmartScript
## For available commands, see SmartScript
class Tool (SmartScript.SmartScript):
def __init__(self, dbss):
SmartScript.SmartScript.__init__(self, dbss)
# Required Method: Execute
# Called once for each grid
# Fill in the arguments you want to use -- WeatherElement1, WeatherElement2...
def execute(self, Wind):
"Put your tool description here"
## # Set up Variables from the varDict (see VariableList below)
## var1 = varDict["Variable name1"]
## var2 = varDict["Variable name2"]
# Determine new value
Swell2Mag = Wind[0] * 0.5
Swell2Dir = Wind[1]
# Return the new value
return (Swell2Mag, Swell2Dir)
# Optional Methods
## # These methods can have the additional argument:
## # ToolTimeRange -- selected time range over which we are running the tool
## def preProcessTool(self, varDict):
## # Called once at beginning of Tool
## # Cannot have WeatherElement or Grid arguments
## pass
## def postProcessTool(self, varDict):
## # Called once at end of Tool
## # Cannot have WeatherElement or Grid arguments
## pass
## What is "self"????
## "Self" refers to this Tool class instance. Don't worry much about it.
## All you need to do is:
## -- Make sure to list "self" as the first argument of
## method Definitions:
## def _myMethod(self, arg1, arg2)
## -- When calling your methods, use self._methodName omitting
## "self" as the first argument:
## x = self._myMethod(arg1, arg2)
##
## Error Handling
## Call self.abort(errorString) to stop execution of your tool and
## display a message to the user.
## For example:
## if x > 1000:
## self.abort("x is too large")
##
## Call self.noData(messageString) to stop execution of your tool
## and return a "NoData" error which can be checked by a Procedure.