awips2/cave/com.raytheon.uf.viz.derivparam.python/localization/derivedParameters/functions/Gradient.py
root 7dbd17a5aa Initial revision of AWIPS2 11.9.0-7p5
Former-commit-id: 133dc97f67 [formerly a02aeb236c] [formerly 9f19e3f712] [formerly 133dc97f67 [formerly a02aeb236c] [formerly 9f19e3f712] [formerly 06a8b51d6d [formerly 9f19e3f712 [formerly 64fa9254b946eae7e61bbc3f513b7c3696c4f54f]]]]
Former-commit-id: 06a8b51d6d
Former-commit-id: 9bb8decbcf [formerly 8e80217e59] [formerly 377dcd10b9 [formerly 3360eb6c5f]]
Former-commit-id: 377dcd10b9
Former-commit-id: e2ecdcfe33
2012-01-06 08:55:05 -06:00

70 lines
2.2 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.
###
## @file Gradient.py
from numpy import empty, shape, NaN
import Vector
##
# Calculate the X and Y gradient arrays of a 2+D array of scalars.
#
# @param scalar: Array of scalar values
# @param dx: Spacing between data points in X direction.
# @param dy: Spacing between data points in Y direction.
# @return: gradient of scalar
# @rtype: tuple(u, v)
def execute(scalar, dx, dy):
"Calculate the 2D gradient arrays of a 2+D scalar array."
result_u = empty(shape(scalar), dtype=scalar.dtype)
result_v = empty(shape(scalar), dtype=scalar.dtype)
# Left/rt edges of result_u can't be calculated.
result_u[:,0] = NaN
result_u[:,-1] = NaN
# Top/bot edges of result_v can't be calculated.
result_v[0,:] = NaN
result_v[-1,:] = NaN
# If dx and dy are arrays, remove extra cells.
shapedx = shape(dx)
if len(shapedx) < sum(shapedx):
dx = dx[:,1:-1]
shapedy = shape(dy)
if len(shapedy) < sum(shapedy):
dy = dy[1:-1,:]
# assume dx and dy are never zero
# dx = masked_values(dx, 0.0, copy=False)
# dy = masked_values(dy, 0.0, copy=False)
# calculate d(scalar)/dx
ans_u = scalar[:,2:] - scalar[:,0:-2]
ans_u = ans_u/(2 * dx)
# calculate d(scalar)/dy
ans_v = scalar[0:-2,:] - scalar[2:,:]
ans_v = ans_v/(2 * dy)
result_u[:,1:-1] = ans_u
result_v[1:-1,:] = ans_v
return Vector.execute(result_u, result_v)