hwrf.regrib.GRIBGridCompute Class Reference

This class represents a GRIBGrid that must be computed from some other input, usually a GRIB file. More...

Detailed Description

This class represents a GRIBGrid that must be computed from some other input, usually a GRIB file.

This is used to create storm-centered or E-grid GRIB-centered grids for the HWRF.

Definition at line 1249 of file regrib.py.

Inheritance diagram for hwrf.regrib.GRIBGridCompute:

Public Member Functions
def	__init__ (self, name, action, args)
	Creates a new GRIBGridCompute with the given name and action. More...
def	is_ready (self, args, kwargs)
	Returns the logical "or" of is_ready(*args,**kwargs) called on all subobjects. More...
def	input_valid (self, args, kwargs)
	Returns the logical "or" of input_valid(**kwargs) called on all subobjects. More...
def	make (self, regrib, kwargs)
	Runs the action specified in the constructor, providing as arguments regrib, and the result of running make on all of the other arguments sent to the constructor. More...
Public Member Functions inherited from hwrf.regrib.GRIBBase
def	is_ready (self, args, kwargs)
	Returns True if this object and its subobjects are all ready for a call to make, and False otherwise. More...
def	input_valid (self, kwargs)
	Returns True if the specified kwargs are valid and False otherwise. More...
def	make (self, regrib, kwargs)
	Runs the action this object should perform and returns another GRIBBase object. More...

Constructor & Destructor Documentation

def hwrf.regrib.GRIBGridCompute.__init__	(		self,
			name,
			action,
			args
	)

Creates a new GRIBGridCompute with the given name and action.

The action is a function or callable object that takes this object, the regrib, the name and the contents of args. Also, any keyword arguments given to self.make are passed on as well.

Parameters

name	The name of the computed grid.
action	The function that computes the grid.
args	Additional positional arguments are sent to the function.

Definition at line 1253 of file regrib.py.

Member Function Documentation

def hwrf.regrib.GRIBGridCompute.input_valid	(		self,
			args,
			kwargs
	)

Returns the logical "or" of input_valid(**kwargs) called on all subobjects.

Subobjects that are not instances of GRIBBase are assumed to be ready.

Parameters

args,kwargs

Passed to arg.input_valid, for all args sent to the constructor that are subclasses of GRIBBase

Definition at line 1275 of file regrib.py.

def hwrf.regrib.GRIBGridCompute.is_ready	(		self,
			args,
			kwargs
	)

Returns the logical "or" of is_ready(*args,**kwargs) called on all subobjects.

Subobjects that are not instances of GRIBBase are assumed to be ready.

Parameters

args,kwargs

Passed to arg.is_ready, for all args sent to the constructor that are subclasses of GRIBBase

Definition at line 1265 of file regrib.py.

def hwrf.regrib.GRIBGridCompute.make	(		self,
			regrib,
			kwargs
	)

Runs the action specified in the constructor, providing as arguments regrib, and the result of running make on all of the other arguments sent to the constructor.

Parameters

regrib	The Regrib object for data storage.
kwargs	Passed to arg.make, for all args sent to the constructor that are subclasses of GRIBBase

Definition at line 1285 of file regrib.py.

---

The documentation for this class was generated from the following file:

• /mnt/pan2/projects/hwrfv3/Samuel.Trahan/trunk/ush/hwrf/regrib.py