warpy.post_processing.probes.ProbePostProc Class Reference

Post processing utilities for probes. More...

Detailed Description

Post processing utilities for probes.

Public Member Functions
def	__init__ (self, pdset)
def	__repr__ (self)
def	plot (self, probe_name, y_fun, t_range=None, window=None, beta=None, **kwargs)
	Plots y evaluated data vs.
def	calc_fft (self, probe_name, y_fun, t_range=None, window='Hanning', beta=14, tau=1, freq_units=None, zero_pad=0)
	Calcs FFT of field.
def	average_fft (self)
	TODO Averages field values from several probes.

Public Attributes
	pdset

Constructor & Destructor Documentation

__init__()

def warpy.post_processing.probes.ProbePostProc.__init__	(		self,
			pdset
	)

Parameters

pdset

warpy.probe_dataset object.

Member Function Documentation

__repr__()

def warpy.post_processing.probes.ProbePostProc.__repr__

(

self

)

average_fft()

def warpy.post_processing.probes.ProbePostProc.average_fft

(

self

)

TODO Averages field values from several probes.

calc_fft()

def warpy.post_processing.probes.ProbePostProc.calc_fft	(		self,
			probe_name,
			y_fun,
			t_range = None,
			window = 'Hanning',
			beta = 14,
			tau = 1,
			freq_units = None,
			zero_pad = 0
	)

Calcs FFT of field.

Parameters

probe_name	String with probe file name.
y_fun	What function to call for y values.
t_range	List type object with min and max time value. Default None.
window	String with windowing option for FFT. Default 'Hanning'.
beta	Shaping function for Kaiser window. Default 14.
tau	Simulation time unit
freq_units	String with unit of frequency. Default None.
zero_pad	Size of zero padding as percentage of array size, ex .5=50%. Default 0.

Returns

spectrum, freqs, freq_units

plot()

def warpy.post_processing.probes.ProbePostProc.plot	(		self,
			probe_name,
			y_fun,
			t_range = None,
			window = None,
			beta = None,
		**	kwargs
	)

Plots y evaluated data vs.

time. Plot style parameters may be passed by keyword.

Parameters

probe_name	String with probe file name
y_fun	What function to call for y values
t_range	List type object with min and max time value
**kwargs	Keyword arguments for pyplot.plot()

Member Data Documentation

pdset

warpy.post_processing.probes.ProbePostProc.pdset

---

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

• tools/warpy/post_processing/probes.py