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

Class SampleData

source code

object --+
         |
        SampleData

Data from a sample-set

Instance Methods [hide private]
 
__init__(self, fName, name, index, col0, data)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
__repr__(self)
repr(x)
source code
 
line(self)
Get the line of the sample
source code
 
time(self)
Get the time of the sample (as a string)
source code
 
isVector(self)
Is this vector or scalar data?
source code
 
range(self, component=None)
Range of the data
source code
 
domain(self)
Range of the data domain
source code
 
component(self, component=None)
Return the data as a number of single scalars.
source code

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, fName, name, index, col0, data)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Parameters:
  • fName - Name of the file
  • name - Name of the value
  • index - Index of the data in the file
  • col0 - Values that identify the data (the location)
  • data - The actual data
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