aug_vec Class Reference
Augmented vector class used to combine many operators into a matrix of operators. More...
Public Member Functions | |
| def | __init__ |
| Constructor form a data container. | |
| def | __str__ |
| wrapper method to data_container.__str__ | |
| def | __repr__ |
| def | __getitem__ |
| If index is a string: Returns an item from one of the dictionaries. | |
| def | __setitem__ |
| Sets an item in the vector dictionary. | |
| def | getSpace |
| returns a Space object that contains all of the information about this vector | |
| def | __getslice__ |
| Returns a numarray array from index i to j from the binary file. | |
| def | __setslice__ |
| Writes a numarray array from index i to j to the binary file corresponding to the data_container. | |
| def | __add__ |
| vec1.__add__(vec2) <==> vec1 + vec2 | |
| def | __radd__ |
| vec1.__radd__(vec2) <==> vec2 + vec1 vec2 may be a scalar or a vector | |
| def | __neg__ |
| vec1.__neg__() <==> -vec1 | |
| def | __sub__ |
| vec1.__sub__(vec2) <==> vec1 - vec2 vec2 may be a scalar or a vector | |
| def | __rsub__ |
| vec1.__rsub__(vec2) <==> vec2 - vec1 vec2 may be a scalar or a vector | |
| def | __div__ |
| vec1.__div__(vec2) <==> vec1 / vec2 vec2 may be a scalar or a vector | |
| def | __rdiv__ |
| vec1.__rdiv__(vec2) <==> vec2 / vec1 vec2 may be a scalar or a vector | |
| def | __mul__ |
| vec1.__mul__(vec2) <==> vec1 * vec2 vec2 may be a scalar or a vector | |
| def | __rmul__ |
| vec1.__rmul__(vec2) <==> vec2 * vec | |
| def | __pow__ |
| vec1.__pow__(vec2) <==> vec1 ** vec2 vec2 may be a scalar or a vector | |
| def | __abs__ |
| Vector.__abs__(vec2) <==> abs(vec1) vec2 may be a scalar or a vector. | |
| def | rms |
| Returns the root mean square. | |
| def | max |
| Returns the maximum value. | |
| def | min |
| Returns the minimum value. | |
| def | mean |
| Returns the mean value. | |
| def | var |
| Returns the variance. | |
| def | sdt |
| Returns the root. | |
| def | norm |
| Returns the lval norm of the vector. | |
| def | real |
| Returns a vector containing the real component of a complex vector. | |
| def | imag |
| Returns a vector containing the imaginary component of a complex vector. | |
| def | thr |
| Returns a thresholded vector. | |
| def | noise |
| Returns vector with added added random noise. | |
| def | sort |
| Returns a vector with a sorted data set. | |
| def | orderstat |
| Returns the ith order statistic of the vector (ith smallest element), i.e. | |
| def | adj |
| adjose a dataset | |
| def | setName |
| Set the name of all of the vectors in this aug_vec instance. | |
Detailed Description
Augmented vector class used to combine many operators into a matrix of operators.Definition at line 182 of file Aug_matrix.py.
Member Function Documentation
| def __init__ | ( | self, | ||
| container | ||||
| ) |
Constructor form a data container.
data - must be a data_container.
Reimplemented from Vector.
Definition at line 183 of file Aug_matrix.py.
| def __str__ | ( | self | ) |
wrapper method to data_container.__str__
Reimplemented from ADI.
Definition at line 187 of file Aug_matrix.py.
| def __repr__ | ( | self | ) |
| def __getitem__ | ( | self, | ||
| index | ||||
| ) |
If index is a string: Returns an item from one of the dictionaries.
Checks the vector dictionary first. If index is a number: Returns a number at index from the binary file.
Reimplemented from Vector.
Definition at line 198 of file Aug_matrix.py.
| def __setitem__ | ( | self, | ||
| index, | ||||
| item | ||||
| ) |
Sets an item in the vector dictionary.
Reimplemented from Vector.
Definition at line 205 of file Aug_matrix.py.
| def getSpace | ( | self | ) |
returns a Space object that contains all of the information about this vector
Reimplemented from Vector.
Definition at line 216 of file Aug_matrix.py.
| def __getslice__ | ( | self, | ||
| start, | ||||
| stop, | ||||
step = 1 | ||||
| ) |
Returns a numarray array from index i to j from the binary file.
If j is less than i or i is greater than the length of the vector, returns a numarray array of zero elements. Otherwise it behaves like a list.
Definition at line 226 of file Aug_matrix.py.
| def __setslice__ | ( | self, | ||
| i, | ||||
| j, | ||||
| data | ||||
| ) |
Writes a numarray array from index i to j to the binary file corresponding to the data_container.
Reimplemented from Vector.
Definition at line 234 of file Aug_matrix.py.
| def __add__ | ( | self, | ||
| other | ||||
| ) |
vec1.__add__(vec2) <==> vec1 + vec2
Reimplemented from Vector.
Definition at line 244 of file Aug_matrix.py.
| def __radd__ | ( | self, | ||
| other | ||||
| ) |
vec1.__radd__(vec2) <==> vec2 + vec1 vec2 may be a scalar or a vector
Reimplemented from Vector.
Definition at line 258 of file Aug_matrix.py.
| def __neg__ | ( | self | ) |
| def __sub__ | ( | self, | ||
| other | ||||
| ) |
vec1.__sub__(vec2) <==> vec1 - vec2 vec2 may be a scalar or a vector
Reimplemented from Vector.
Definition at line 276 of file Aug_matrix.py.
| def __rsub__ | ( | self, | ||
| other | ||||
| ) |
vec1.__rsub__(vec2) <==> vec2 - vec1 vec2 may be a scalar or a vector
Reimplemented from Vector.
Definition at line 289 of file Aug_matrix.py.
| def __div__ | ( | self, | ||
| other | ||||
| ) |
vec1.__div__(vec2) <==> vec1 / vec2 vec2 may be a scalar or a vector
Reimplemented from Vector.
Definition at line 298 of file Aug_matrix.py.
| def __rdiv__ | ( | self, | ||
| other | ||||
| ) |
vec1.__rdiv__(vec2) <==> vec2 / vec1 vec2 may be a scalar or a vector
Reimplemented from Vector.
Definition at line 311 of file Aug_matrix.py.
| def __mul__ | ( | self, | ||
| other | ||||
| ) |
vec1.__mul__(vec2) <==> vec1 * vec2 vec2 may be a scalar or a vector
Reimplemented from Vector.
Definition at line 321 of file Aug_matrix.py.
| def __rmul__ | ( | self, | ||
| other | ||||
| ) |
vec1.__rmul__(vec2) <==> vec2 * vec
Reimplemented from Vector.
Definition at line 332 of file Aug_matrix.py.
| def __pow__ | ( | self, | ||
| other | ||||
| ) |
vec1.__pow__(vec2) <==> vec1 ** vec2 vec2 may be a scalar or a vector
Reimplemented from Vector.
Definition at line 342 of file Aug_matrix.py.
| def __abs__ | ( | self | ) |
Vector.__abs__(vec2) <==> abs(vec1) vec2 may be a scalar or a vector.
Reimplemented from Vector.
Definition at line 354 of file Aug_matrix.py.
| def rms | ( | self | ) |
Returns the root mean square.
Reimplemented from Vector.
Definition at line 359 of file Aug_matrix.py.
| def max | ( | self | ) |
| def min | ( | self | ) |
| def mean | ( | self | ) |
| def var | ( | self | ) |
| def sdt | ( | self | ) |
| def norm | ( | self, | ||
lval = 2 | ||||
| ) |
Returns the lval norm of the vector.
Reimplemented from Vector.
Definition at line 390 of file Aug_matrix.py.
| def real | ( | self | ) |
Returns a vector containing the real component of a complex vector.
Definition at line 399 of file Aug_matrix.py.
| def imag | ( | self | ) |
Returns a vector containing the imaginary component of a complex vector.
Definition at line 407 of file Aug_matrix.py.
| def thr | ( | self, | ||
| obj, | ||||
mode = 'soft' | ||||
| ) |
Returns a thresholded vector.
obj - may be a scalar or a vector. mode - may be 'soft', 'hard' or 'nng'
Reimplemented from Vector.
Definition at line 417 of file Aug_matrix.py.
| def noise | ( | self, | ||
mean = 0 | ||||
| ) |
Returns vector with added added random noise.
mean - noise mean
Definition at line 438 of file Aug_matrix.py.
| def sort | ( | self, | ||
ascmode = False, |
||||
memsize = None | ||||
| ) |
Returns a vector with a sorted data set.
Reimplemented from Vector.
Definition at line 446 of file Aug_matrix.py.
| def orderstat | ( | self, | ||
| i | ||||
| ) |
Returns the ith order statistic of the vector (ith smallest element), i.e.
i=0 is smallest, i=1 second smallest, etc.) Negative indexing starts with the largest element, i.e. i=-1 is largest, i=-2 second largest, etc.
Reimplemented from Vector.
Definition at line 455 of file Aug_matrix.py.
| def adj | ( | self, | ||
a1 = 1, |
||||
a2 = 2, |
||||
memsize = 100 | ||||
| ) |
| def setName | ( | self, | ||
| name, | ||||
path = None | ||||
| ) |
The documentation for this class was generated from the following file:
- /Users/sean/workspace/SLIMpy3/slimpy_base/User/AumentedMatrix/Aug_matrix.py
