esys.modellib.input.GaussianProfile

Package esys :: Package modellib :: Module input :: Class GaussianProfile

[show private | hide private]

Type GaussianProfile

    object --+        
             |        
LinkableObject --+    
                 |    
      ParameterSet --+
                     |
                    GaussianProfile

Generates a Gaussian profile at center x_c, width width and height A over a domain

Method Summary
	`__init__(self, debug)`
	`out(self)` Generate the Gaussian profile
Inherited from ParameterSet
	`__delattr__(self, name)` Removes the attribute name.
	`__iter__(self)` Creates an iterator over the parameter and their values.
	`__repr__(self)`
	`declareParameter(self, **parameters)` Declares a new parameter(s) and its (their) initial value.
	`declareParameters(self, parameters)` Declares a set of parameters.
	`fromDom(cls, doc)` (Class method)
	`releaseParameters(self, name)` Removes parameter name from the paramameters.
	`showParameters(self)` Returns a descrition of the parameters.
	`toDom(self, document, node)` `toDom` method of ParameterSet class.
	`writeXML(self, ostream)` Writes the object as an XML object into an output stream.
Inherited from LinkableObject
	`__getattr__(self, name)` Returns the value of attribute name.
	`__setattr__(self, name, value)` Sets the value for attribute name.
	`getAttributeObject(self, name)` Return the object stored for attribute name.
	`hasAttribute(self, name)` Returns True if self as attribute name.
	`trace(self, msg)` If debugging is on, print the message, otherwise do nothing
Inherited from object
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__str__(x)` x.__str__() <==> str(x)

Instance Variable Summary
	`A (in)`: height of the profile.
	`domain (in)`: domain
	`out (callable)`: profile
	`r (in)`: radius of the circle (default = 0)
	`width (in)`: width of the profile (default 0.1)
	`x_c (in)`: center of the Gaussian profile (default [0.,0.,0.])

Class Variable Summary
Inherited from LinkableObject
`count`	`number_sequence` = `<itertools.count object at 0x401ff100>`

Instance Method Details

out(self)

Generate the Gaussian profile

Instance Variable Details

A (in)

height of the profile. A maybe a vector. (default 1.)

domain (in)

domain

out (callable)

profile

In the case that the spatial dimension is two, The third component of x_c is dropped

r (in)

radius of the circle (default = 0)

width (in)

width of the profile (default 0.1)

x_c (in)

center of the Gaussian profile (default [0.,0.,0.])

Generated by Epydoc 2.1 on Thu Apr 27 11:16:24 2006

http://epydoc.sf.net