Package MDSplus :: Module compound :: Class Signal
[frames | no frames]

Type Signal

object --+        
         |        
      Data --+    
             |    
      Compound --+
                 |
                Signal


A Signal is used to describe a measurement, usually time dependent, and associated the data with its independent axis (Dimensions). When Signals are indexed using s[idx], the index is resolved using the dimension of the signal
Method Summary
Signal __getitem__(self, idx)
Subscripting <==> signal[subscript].
Data dim_of(self, idx)
Return the signals dimension
Data getDimensionAt(self, idx)
Return the dimension of the signal
tuple getDimensions(self)
Return all the dimensions of the signal
Data getRaw(self)
Get the raw field
Data getValue(self)
Get the value field
None setDimensionAt(self, idx, value)
Set the dimension
None setDimensions(self, value)
Set all the dimensions of a signal
None setRaw(self, value)
Set the raw field
None setValue(self, value)
Set the value field
    Inherited from Compound
  __init__(self, *args, **params)
MDSplus compound data.
  __getattr__(self, name, *args)
  __setattr__(self, name, value)
  __setitem__(self, num, value)
Data,None getArgumentAt(self, idx)
Return argument at index idx (indexes start at 0)
Data,None getArguments(self)
Return arguments
Data getDescAt(self, idx)
Return descriptor with index idx (first descriptor is 0)
tuple,None getDescs(self)
Return descriptors or None if no descriptors
int getNumDescs(self)
Return number of descriptors
  setArgumentAt(self, idx, value)
Set argument at index idx (indexes start at 0)
  setArguments(self, args)
Set arguments
  setDescAt(self, n, value)
Set descriptor at index idx (indexes start at 0)
  setDescs(self, args)
Set descriptors
    Inherited from Data
Data __abs__(self)
Absolute value: x.__abs__() <==> abs(x)
Data __add__(self, y)
Add: x.__add__(y) <==> x+y
Data __and__(self, y)
And: x.__and__(y) <==> x&y
Data __div__(self, y)
Divide: x.__div__(y) <==> x/y
Bool __eq__(self, y)
Equals: x.__eq__(y) <==> x==y
Data __float__(self)
Float: x.__float__() <==> float(x)
Data __floordiv__(self, y)
Floordiv: x.__floordiv__(y) <==> x//y
Bool __ge__(self, y)
Greater or equal: x.__ge__(y) <==> x>=y
Bool __gt__(self, y)
Greater than: x.__gt__(y) <==> x>y
int __int__(self)
Integer: x.__int__() <==> int(x)
Data __invert__(self)
Binary not: x.__invert__() <==> ~x
Bool __le__(self, y)
Less than or equal: x.__le__(y) <==> x<=y
Data __len__(self)
Length: x.__len__() <==> len(x)
long __long__(self)
Convert this object to python long
Data __lshift__(self, y)
Lrft binary shift: x.__lshift__(y) <==> x<<y
Bool __lt__(self, y)
Less than: x.__lt__(y) <==> x<y
Data __mod__(self, y)
Modulus: x.__mod__(y) <==> x%y
Data __mul__(self, y)
Multiply: x.__mul__(y) <==> x*y
Data __ne__(self, y)
Not equal: x.__ne__(y) <==> x!=y
Data __neg__(self)
Negation: x.__neg__() <==> -x
Bool __nonzero__(self)
Not equal 0: x.__nonzero__() <==> x != 0
Data __or__(self, y)
Or: x.__or__(y) <==> x|y
Data __pos__(self)
Unary plus: x.__pos__() <==> +x
Data __radd__(self, y)
Reverse add: x.__radd__(y) <==> y+x
Data __rdiv__(self, y)
Reverse divide: x.__rdiv__(y) <==> y/x
string __repr__(self)
Return string representation
Data __rfloordiv__(self, y)
x.__rfloordiv__(y) <==> y//x
Data __rlshift__(self, y)
Reverse left binary shift: x.__rlshift__(y) <==> y<<x
Data __rmod__(self, y)
Reverse modulus: x.__rmod__(y) <==> y%x
Data __rmul__(self, y)
Multiply: x.__mul__(y) <==> x*y
Data __ror__(self, y)
Or: x.__or__(y) <==> x|y
Data __rrshift__(self, y)
Reverse right binary shift: x.__rrshift__(y) <==> y>>x
Data __rshift__(self, y)
Right binary shift: x.__rshift__(y) <==> x>>y
Data __rsub__(self, y)
Reverse subtract: x.__rsub__(y) <==> y-x
Data __rxor__(self, y)
Reverse xor: x.__rxor__(y) <==> y^x
string __str__(self)
Return string representation
Data __sub__(self, y)
Subtract: x.__sub__(y) <==> x-y
Data __xor__(self, y)
Xor: x.__xor__(y) <==> x^y
Bool bool(self)
Return boolean
Bool compare(self, value)
Compare this data with argument
Data compile(expr, *args)
Static method (routine in C++) which compiles the expression (via TdiCompile()) and returns the object instance correspondind to the compiled expression. (Static method)
Scalar,Array data(self)
Return primitimive value of the data.
string decompile(self)
Return string representation
Data deserialize(data)
Return Data from serialized buffer. (Static method)
Data evaluate(self)
Return the result of TDI evaluate(this).
Data execute(expr, *args)
Execute and expression inserting optional arguments into the expression before evaluating (Static method)
Int8 getByte(self)
Convert this data into a byte.
Int8Array getByteArray(self)
Convert this data into a byte array.
Float64 getDouble(self)
Convert this data into a float64.
Data getError(self)
Get the error field.
Float32 getFloat(self)
Convert this data into a float32.
Data getHelp(self)
Returns the result of TDI GET_HELP(this).
Int32 getInt(self)
Convert this data into a int.
Int32Array getIntArray(self)
Convert this data into a int array.
Int64 getLong(self)
Convert this data into a long.
Int64Array getLongArray(self)
Convert this data into a long array.
Int32Array getShape(self)
Get the array dimensions as an integer array.
Int16 getShort(self)
Convert this data into a short.
Int16Array getShortArray(self)
Convert this data into a short array.
String getString(self)
Convert this data into a STRING.
Data getTdiVar(tdivarname)
Get value of tdi public variable (Static method)
Data getUnits(self)
Return the TDI evaluation of UNITS_OF(this).
Data makeData(value)
Return MDSplus data class from value. (Static method)
Bool mayHaveChanged(self)
return true if the represented data could have been changed since the last time this method has been called.
Data pop_dollar_value(self)
Pop $value for expression evaluation
None push_dollar_value(self)
Set $value for expression evaluation
Data raw_of(self)
Return raw part of object
Uint8Array serialize(self)
Return Uint8Array binary representation.
None setError(self, error)
Set the Error field for this Data instance.
None setHelp(self, help)
Set the Help field for this Data instance.
Data setTdiVar(self, tdivarname)
Set tdi public variable with this data
None setUnits(self, units)
Set units
Float32Array sind(self)
Return sin() of data assuming data is in degrees
Data units_of(self)
Return units part of the object
Data value_of(self)
Return value part of object
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle

Property Summary
  dims
    Inherited from Data
  descriptor
  error
  help
  units
  validation

Class Variable Summary
type __metaclass__ = MDSplus.compound.MetaClass
tuple fields = ('value', 'raw')

Instance Method Details

__getitem__(self, idx)
(Indexing operator)

Subscripting <==> signal[subscript]. Uses the dimension information for subscripting
Parameters:
idx - index or Range used for subscripting the signal based on the signals dimensions
           (type=Data)
Returns:
Signal
Overrides:
MDSplus.compound.Compound.__getitem__

dim_of(self, idx=0)

Return the signals dimension
Returns:
Data
Overrides:
MDSplus.mdsdata.Data.getDimensionAt

getDimensionAt(self, idx=0)

Return the dimension of the signal
Parameters:
idx - The index of the desired dimension. Indexes start at 0. 0=default
           (type=int)
Returns:
Data
Overrides:
MDSplus.mdsdata.Data.getDimensionAt

getDimensions(self)

Return all the dimensions of the signal
Returns:
tuple

getRaw(self)

Get the raw field
Returns:
Data

getValue(self)

Get the value field
Returns:
Data

setDimensionAt(self, idx, value)

Set the dimension
Parameters:
idx - The index into the dimensions of the signal.
Returns:
None

setDimensions(self, value)

Set all the dimensions of a signal
Parameters:
value - The dimensions
           (type=tuple)
Returns:
None

setRaw(self, value)

Set the raw field
Parameters:
value
           (type=Data)
Returns:
None

setValue(self, value)

Set the value field
Parameters:
value
           (type=Data)
Returns:
None

Class Variable Details

fields

Type:
tuple
Value:
('value', 'raw')                                                       

Generated by Epydoc 2.1 on Wed Aug 18 13:35:31 2010 http://epydoc.sf.net