|
BTK Python wrapper
0.3dev.0
Python bindings for the Biomechanical ToolKit library (BTK)
|
Analog channel data along the time. More...
Public Member Functions | |
| def | Clone |
| def | GetData |
| def | GetDescription |
| def | GetFrameNumber |
| def | GetGain |
| def | GetLabel |
| def | GetOffset |
| def | GetScale |
| def | GetTimestamp |
| def | GetUnit |
| def | GetValue |
| def | GetValues |
| def | SetData |
| def | SetDataSlice |
| def | SetDescription |
| def | SetFrameNumber |
| def | SetGain |
| def | SetLabel |
| def | SetOffset |
| def | SetScale |
| def | SetUnit |
| def | SetValue |
| def | SetValues |
| def | Update |
Static Public Attributes | |
| PlusMinus0Dot05 = _btk.btkAnalog_PlusMinus0Dot05 | |
| PlusMinus0Dot1 = _btk.btkAnalog_PlusMinus0Dot1 | |
| PlusMinus0Dot25 = _btk.btkAnalog_PlusMinus0Dot25 | |
| PlusMinus0Dot5 = _btk.btkAnalog_PlusMinus0Dot5 | |
| PlusMinus1 = _btk.btkAnalog_PlusMinus1 | |
| PlusMinus10 = _btk.btkAnalog_PlusMinus10 | |
| PlusMinus1Dot25 = _btk.btkAnalog_PlusMinus1Dot25 | |
| PlusMinus2Dot5 = _btk.btkAnalog_PlusMinus2Dot5 | |
| PlusMinus5 = _btk.btkAnalog_PlusMinus5 | |
| Unknown = _btk.btkAnalog_Unknown | |
Analog channel data along the time.
An analog channel is defined as: - an array of double containing the samples (NumPy array); - a unit (string); - a scale (double); - an offset (integer); - a gain (integer). The gain has a limited range of possible values and are listed in the following enumeration: - btk.btkAnalog.Unknown: unknwon gain; - btk.btkAnalog.PlusMinus10: gain for the range +/- 10 volts; - btk.btkAnalog.PlusMinus5: gain for the range +/- 5 volts; - btk.btkAnalog.PlusMinus2Dot5: gain for the range +/- 2.5 volts; - btk.btkAnalog.PlusMinus1Dot25: gain for the range +/- 1.25 volts; - btk.btkAnalog.PlusMinus1: gain for the range +/- 1 volts;. Note: The informations associated (unit, scale, offset, gain) are useful for other classes/methods. For example, when you save an acquisition in a file, analog's data are generally unscaled and written as integer, then the scale and offset are important.
| def btk.btkAnalog.Clone | ( | self | ) |
Clone(self) -> btkAnalog Deep copy of the object.
| def btk.btkAnalog.GetData | ( | self | ) |
GetData(self) -> btkAnalogData Return the data of this analog channel
| def btk.btkAnalog.GetDescription | ( | self | ) |
GetDescription(self) -> std::string const & Returns the analog's description.
| def btk.btkAnalog.GetFrameNumber | ( | self | ) |
GetFrameNumber(self) -> int const Returns the number of frames.
| def btk.btkAnalog.GetGain | ( | self | ) |
GetGain(self) -> btkAnalog_impl::Gain const Returns the analog's gain.
| def btk.btkAnalog.GetLabel | ( | self | ) |
GetLabel(self) -> std::string const & Returns the analog's label.
| def btk.btkAnalog.GetOffset | ( | self | ) |
GetOffset(self) -> int const
| def btk.btkAnalog.GetScale | ( | self | ) |
GetScale(self) -> double const
| def btk.btkAnalog.GetTimestamp | ( | self | ) |
GetTimestamp(self) -> unsigned long Returns the timestamp of the object.
| def btk.btkAnalog.GetUnit | ( | self | ) |
GetUnit(self) -> std::string const & Returns the analog's unit.
| def btk.btkAnalog.GetValue | ( | self, | args | ) |
GetValue(self, idx) -> double Returns only one sample.
| def btk.btkAnalog.GetValues | ( | self | ) |
GetValues(self) -> array (NumPy) Returns the analog's samples. WARNING:You cannot set values using this method. Use the methods SetValues of SetValue for that.
| def btk.btkAnalog.SetData | ( | self, | args | ) |
SetData(self, btkAnalogData, parenting = true) SetData(self, btkAnalogData, parenting = true) Sets the data of this analog channel. By default, this object will take the parent of the data. Setting 'parenting' to false will unparent the old data, assign the new one, but doesn't set the point as its parent.
| def btk.btkAnalog.SetDataSlice | ( | self, | args | ) |
SetDataSlice(self, arg2, arg3)
| def btk.btkAnalog.SetDescription | ( | self, | args | ) |
SetDescription(self, string) Sets the analog's description.
| def btk.btkAnalog.SetFrameNumber | ( | self, | args | ) |
SetFrameNumber(self, int) Sets the number of frames.
| def btk.btkAnalog.SetGain | ( | self, | args | ) |
SetGain(self, int) Sets the analog's gain.
| def btk.btkAnalog.SetLabel | ( | self, | args | ) |
SetLabel(self, string) Sets the analog's label.
| def btk.btkAnalog.SetOffset | ( | self, | args | ) |
SetOffset(self, arg2)
| def btk.btkAnalog.SetScale | ( | self, | args | ) |
SetScale(self, arg2)
| def btk.btkAnalog.SetUnit | ( | self, | args | ) |
SetUnit(self, string) Sets the analog's unit.
| def btk.btkAnalog.SetValue | ( | self, | args | ) |
SetValue(self, int, double) Sets only one sample.
| def btk.btkAnalog.SetValues | ( | self, | args | ) |
SetValues(self, array) Sets the analog's samples.
| def btk.btkAnalog.Update | ( | self | ) |
Update(self) Updates the ProcessObject associated with this DataObject.
|
static |
Gain for the range +/- 0.05 volts.
|
static |
Gain for the range +/- 0.1 volts.
|
static |
Gain for the range +/- 0.25 volts.
|
static |
Gain for the range +/- 0.5 volts.
|
static |
Gain for the range +/- 1 volts.
|
static |
Gain for the range +/- 10 volts.
|
static |
Gain for the range +/- 1.25 volts.
|
static |
Gain for the range +/- 2.5 volts.
|
static |
Gain for the range +/- 5 volts.
|
static |
Unknown gain.
1.8.5