CSIM: Preprocessor Class Reference
Preprocessor Class Reference#include <preprocessor.h>
Inheritance diagram for Preprocessor:
List of all members.
Detailed Description
Base class of all preprocessors that can be applied to the filtered input of a readout. Examples are normalizers, PCA and linear transformations.
Public Member Functions
Protected Attributes
-
map< string, double * > params
- A map storing pointers to the parameters.
-
int nInputRows
- Number of rows for input vectors.
-
double dInputRows
- Dummy for parameter setting.
-
int nOutputRows
- Number of rows for output vectors.
-
double dOutputRows
- Dummy for parameter setting.
Constructor & Destructor Documentation
Preprocessor::Preprocessor |
( |
unsigned int |
in_rows, |
|
|
unsigned int |
out_rows |
|
) |
|
|
|
Constructs a new preprocessor object. - Parameters:
-
| in_rows | Number of rows in each input vector. |
| out_rows | Number of rows in each output vector. |
|
Member Function Documentation
virtual double* Preprocessor::exportRepresentation |
( |
int * |
rep_length |
) |
[pure virtual] |
|
virtual string Preprocessor::getFormatDescription |
( |
|
) |
[pure virtual] |
|
int Preprocessor::getInputRows |
( |
|
) |
[inline] |
|
|
Returns the number of input rows. |
int Preprocessor::getOutputRows |
( |
|
) |
[inline] |
|
|
Returns the number of output rows. |
double Preprocessor::getParameter |
( |
string |
name |
) |
[virtual] |
|
|
Returns the current value of a parameter. - Parameters:
-
| name | Name of the parameter. |
- Returns:
- The value of the parameter.
|
virtual int Preprocessor::importRepresentation |
( |
const double * |
rep, |
|
|
int |
rep_length |
|
) |
[pure virtual] |
|
virtual int Preprocessor::process |
( |
const double * |
S, |
|
|
double * |
X |
|
) |
[pure virtual] |
|
virtual void Preprocessor::reset |
( |
|
) |
[pure virtual] |
|
void Preprocessor::setParameter |
( |
string |
name, |
|
|
double |
value |
|
) |
[virtual] |
|
|
Sets a parameter of the preprocessor function. - Parameters:
-
| name | Name of the parameter. |
| value | Value to set for the parameter. |
|
int Preprocessor::updateInternal |
( |
|
) |
[virtual] |
|
|
This function is called after parameters are updated.
Reimplemented from csimClass. |
list< string > Preprocessor::validParameters |
( |
void |
|
) |
[virtual] |
|
|
Returns the names of the valid parameters. - Returns:
- A string list indicating the valid parameter names.
|
|