warpy.dataset.ProbeField Class Reference

Represents a single probe variablefield. More...

Detailed Description

Represents a single probe variablefield.

Public Member Functions
def	__init__ (self, probe_file, vname, name, time, dtype_, shape, components=None, location=None)
def	__repr__ (self)
def	read_data (self)
	Reads the raw data for this field from hdf5 file.

Public Attributes
	probe_file
	vname
	name
	time
	components
	dtype
	shape
	location

Constructor & Destructor Documentation

__init__()

def warpy.dataset.ProbeField.__init__	(		self,
			probe_file,
			vname,
			name,
			time,
			dtype_,
			shape,
			components = None,
			location = None
	)

Parameters

probe_file	Probe file name.
vname	Variable name.
name	Field name.
time	List giving probe readout times.
dtype_	List of datatypes per component.
shape	List of shapes for each component.
components	List of components (ie x, y, z). Default None
location	Coordinates of probe location. Optional.

Member Function Documentation

__repr__()

def warpy.dataset.ProbeField.__repr__

(

self

)

read_data()

def warpy.dataset.ProbeField.read_data

(

self

)

Reads the raw data for this field from hdf5 file.

Member Data Documentation

components

warpy.dataset.ProbeField.components

dtype

warpy.dataset.ProbeField.dtype

location

warpy.dataset.ProbeField.location

name

warpy.dataset.ProbeField.name

probe_file

warpy.dataset.ProbeField.probe_file

shape

warpy.dataset.ProbeField.shape

time

warpy.dataset.ProbeField.time

vname

warpy.dataset.ProbeField.vname

---

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

• tools/warpy/dataset.py