Package PyFoam :: Package RunDictionary :: Module SampleDirectory :: Class SampleData
[hide private]
[frames] | no frames]

Class SampleData

source code


Data from a sample-set

Instance Methods [hide private]
 
__call__(self, scaleX=1.0, scaleData=1, offsetData=0, offsetX=0)
Return the data as SpreadsheetData-object
source code
 
__init__(self, fName, name, line, index, coord, data, note='', scale=(1, 1), offset=(0, 0))
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
__repr__(self)
repr(x)
source code
 
component(self, component=None)
Return the data as a number of single scalars.
source code
 
domain(self)
Range of the data domain
source code
 
isVector(self)
Is this vector or scalar data?
source code
 
line(self)
Get the line of the sample
source code
 
range(self, component=None)
Range of the data
source code
 
time(self)
Get the time of the sample (as a string)
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, fName, name, line, index, coord, data, note='', scale=(1, 1), offset=(0, 0))
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Parameters:
  • fName - Name of the file
  • name - Name of the value
  • index - Index of the data in the file
  • coord - Values that identify the data (the location)
  • data - The actual data
  • scale - pair of factors with which the data is scaled when being plotted
  • offset - pair of offsets
Overrides: object.__init__

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)

component(self, component=None)

source code 

Return the data as a number of single scalars.

Parameters:
  • component - If None for vectors the absolute value is taken. else the number of the component