CLAM::SpectrumProduct Class Reference
#include <SpectrumProduct.hxx>
Detailed Description
This class performs the product of two Spectrum processing data objects.Its primary use will be to allow frecuency domain filtering, by taking the frecuency response as one of its inputs. (It implements the funcionality provided in the old CCLAMApplyFDFilter class).
It Allows any possible attribute configuration in its inputs and in its output, but it performs faster when prototype configuration of the data is specified using SetPrototypes(...), in certain situations:
- When all the inputs and the outputs have a common attribute (not the BPF), and the same scale.
- When one of the inputs has just a BPF attribute, and both the other input and the output have a common (non-BPF) attribute with the same scale in both objects.
- In other cases, at least a vector conversion will be executed in one of the involved processing data objects. In some bad situations two conversions might be needed.
- Todo:
- Possible optimisations (which require more states):
- Implement direct product routines with inputs/outpust in different formats, and add the corresponding prototype states.
- Expand the state space to avoid checking if the attribute to be used in the computation is instantiated in each of the objects. Right now the same state is used when the three objects have a common attribute, and when a common attribute is to be used, but some of the objects lack it (and need format conversion).
The BPFxBPF product is being thought. If both BPFs have the same range and point possition, the way to go is obvious, but in other situations it is not so simple. Whe should probably merge both BPFs, into a new BPF.
Definition at line 69 of file SpectrumProduct.hxx.
Public Member Functions | |
| SpectrumProduct (const Config &c=Config()) | |
| virtual | ~SpectrumProduct () |
| bool | Do () |
| Supervised mode execution method (using ports). | |
| bool | Do (Spectrum &in1, Spectrum &in2, Spectrum &out) |
| bool | SetPrototypes (const Spectrum &in1, const Spectrum &in2, const Spectrum &out) |
| Change the internal type state. | |
| bool | SetPrototypes () |
| bool | UnsetPrototypes () |
| bool | MayDisableExecution () const |
Public Attributes | |
| InPort< Spectrum > | mInput1 |
| InPort< Spectrum > | mInput2 |
| OutPort< Spectrum > | mOutput |
Constructor & Destructor Documentation
| CLAM::SpectrumProduct::~SpectrumProduct | ( | ) | [virtual] |
Definition at line 51 of file SpectrumProduct.cxx.
Member Function Documentation
| bool CLAM::SpectrumProduct::Do | ( | ) | [virtual] |
Supervised mode execution method (using ports).
- Returns:
- A boolean telling whether it has been output
Implements CLAM::Processing.
Definition at line 103 of file SpectrumProduct.cxx.
References CLAM_DEBUG_ASSERT, CLAM::Spectrum::GetSize(), mInput1, mInput2, mOutput, and CLAM::Spectrum::SetSize().
Definition at line 55 of file SpectrumProduct.cxx.
References CLAM_ASSERT, CLAM_DEBUG_ASSERT, and CLAM::Processing::IsRunning().
| bool CLAM::SpectrumProduct::SetPrototypes | ( | const Spectrum & | in1, | |
| const Spectrum & | in2, | |||
| const Spectrum & | out | |||
| ) |
Change the internal type state.
Apart from prototype configuration, the Size, Scale and SpectralRange attributes of each Spectrum are also checked.
Definition at line 124 of file SpectrumProduct.cxx.
References CLAM::SpecTypeFlags::bComplex, CLAM::SpecTypeFlags::bMagPhase, CLAM::SpecTypeFlags::bMagPhaseBPF, CLAM::SpecTypeFlags::bPolar, CLAM_ASSERT, CLAM::EScale::eLinear, CLAM::EScale::eLog, CLAM::Spectrum::GetConfig(), CLAM::Spectrum::GetSize(), and CLAM::Spectrum::GetType().
| bool CLAM::SpectrumProduct::SetPrototypes | ( | ) |
| bool CLAM::SpectrumProduct::UnsetPrototypes | ( | ) |
Definition at line 316 of file SpectrumProduct.cxx.
| bool CLAM::SpectrumProduct::MayDisableExecution | ( | ) | const [inline] |
Definition at line 136 of file SpectrumProduct.hxx.
Member Data Documentation
The documentation for this class was generated from the following files:
