mwavepy.frequency
index
/home/alex/docs/python/path/mwavepy/frequency.py

Provides the Frequency class, and related functions

 
Classes
       
__builtin__.object
Frequency

 
class Frequency(__builtin__.object)
    represents a frequency band. 
 
attributes:
        start: starting frequency  (in Hz)
        stop: stoping frequency  (in Hz)
        npoints: number of points, an int
        unit: unit which to scale a formated axis, when accesssed. see
                formattedAxis
        
frequently many calcluations are made in a given band , so this class 
is used in other classes so user doesnt have to continually supply 
frequency info.
 
  Methods defined here:
__eq__(self, other)
__init__(self, start, stop, npoints, unit='hz', sweep_type='lin')
takes:
        start: start of band.  units of unit, defaults is  Hz
        stop: end of band. units of unit, defaults is  Hz
        npoints: number of points in the band. 
        unit: unit you want the band in for plots. a string. can be:
                'hz', 'mhz','ghz', 
 
example:
        wr1p5band = frequencyBand(500,750,401, 'ghz')
        
note: unit sets the property freqMultiplier, which is used 
to scale the frequency when f_scaled is referenced.
__ne__(self, other)
labelXAxis(self, ax=None)

Class methods defined here:
from_f(cls, f, *args, **kwargs) from __builtin__.type
alternative constructor from a frequency vector,
takes:
        f: frequency array (default in Hz) 
returns:
        mwavepy.Frequency object

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
center
f
returns a frequency vector  in Hz
f_scaled
returns a frequency vector in units of self.unit
multiplier
multiplier for formating axis
unit
The unit to format the frequency axis in. see formatedAxis
w
angular frequency in radians

Data and other attributes defined here:
multiplier_dict = {'ghz': 1000000000.0, 'hz': 1, 'mhz': 1000000.0}
unit_dict = {'ghz': 'GHz', 'hz': 'Hz', 'mhz': 'MHz'}

 
Functions
       
f_2_frequency(f)
convienience function
converts a frequency vector to a Frequency object 
 
!depricated, use classmethod from_f instead.

 
Data
        pi = 3.141592653589793