name: Constant : public AlgorithmBase

synopsis:

g++ [flags ...] file ... -l /isip/tools/lib/$ISIP_BINARY/lib_algo.a

#include <Constant.h>

Constant(ALGORITHM algorithm = DEF_ALGORITHM, IMPLEMENTATION implementation = DEF_IMPLEMENTATION);
Constant(const Constant& arg);
boolean assign(const Constant& arg);
boolean setAlgorithm(ALGORITHM type);
boolean setDataType(AlgorithmData::DATA_TYPE type);
quick start:

Constant cons;
Vector <CircularBuffer <AlgorithmData>> in;
Vector <AlgorithmData> out;
cons.apply(output, input);
description:

The Constant class is used to write (or read) constants from a file. This is a very important class for implementation of recipes that require multiple passes through the data (e.g., cepstral mean subtraction). For example, the constant class can be combined with the Statistics class to compute and save the average value of a signal. This constant can then be read in a subsequent stage of processing using the same class, and used in the next pass of calculations.

The Constant class supports all data types currently supported in the
AlgorithmData class. The table below is provided for reference purposes:


The output (or input) filename is set by the user using the setFilenamemethod. The object is written using an object-specific I/O method (e.g., VECTOR_FLOAT uses the class VectorFloat's I/O methods).

The main use of this class is in isip_transform's recipe processing code. Users need not use this class - they can use the standard object I/O methods directly in their code.

dependencies:

public constants:

error codes:

protected data:

required public methods:

class-specific public methods:

private methods:

examples:

notes: