cocopp.readalign.MultiReader(list)
class documentationcocopp.readalign
(View In Hierarchy)
Known subclasses: cocopp.readalign.ArrayMultiReader, cocopp.readalign.HMultiReader, cocopp.readalign.VMultiReader
List of data arrays to be aligned. The main purpose of this class is to be used as a single container of the data arrays to be aligned by :py:meth:`alignData()` in the parent module. A data array is defined as an array where rows correspond to recordings at different moments of an experiment. Elements of these rows correspond to different measures. These data arrays can be aligned along the time or the function values for instance. This class is part abstract. Some methods have to be defined by inheriting classes depending on wanted alignment: * :py:meth:`isFinished()`, True when all the data is read. * :py:meth:`getInitialValue()`, returns the initial alignment value. * :py:meth:`newCurrentValue()`, returns the next alignment value. * :py:meth:`align()`, process all the elements of self to make them aligned. Some attributes have to be defined as well :py:attr:`idx`, the index of the column with alignment values in the data array, :py:attr:`idxData`, the index of the column with the actual data.
Method | __init__ | accepts a list of arrays or a MultiReader (i.e. a list of SingleReader ) as input data type |
Method | currentLine | Aggregates currentLines information. |
Method | currentValues | Gets the list of the current alignment values. |
Method | nextValues | Gets the list of the next alignment values. |
Class | SingleReader | Single data array reader class. |