ChannelFacet Class Reference

Base class for facets that can be held in a ChannelFacetMap. More...

#include <Channels/ChannelFacet.H>

Inheritance diagram for ChannelFacet:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~ChannelFacet ()
 Virtual destructor for safe inheritance.
virtual void writeTo (ParamMap &pmap) const =0
 Write our data out to a ParamMap.
virtual void readFrom (const ParamMap &pmap)=0
 Read our data back in from a ParamMap.

Protected Member Functions

 ChannelFacet ()
 Constructor is protected (base class should not be used on its own).

Detailed Description

Base class for facets that can be held in a ChannelFacetMap.

ChannelFacet provides a simple mechanism to add extra data and functions to the channels at runtime. Example usage is to add a set of weights for the different feature maps. The only default interface to the ChannelFacet is to provide readFrom() and writeTo() functions to dump the ChannelFacet data to a ParamMap. Because this base class is purely virtual, it cannot be directly implemented but will first need to be derived into an implementable class.

Definition at line 57 of file ChannelFacet.H.


Constructor & Destructor Documentation

ChannelFacet::ChannelFacet (  )  [protected]

Constructor is protected (base class should not be used on its own).

Definition at line 57 of file ChannelFacet.C.

ChannelFacet::~ChannelFacet (  )  [virtual]

Virtual destructor for safe inheritance.

Definition at line 60 of file ChannelFacet.C.


Member Function Documentation

virtual void ChannelFacet::readFrom ( const ParamMap pmap  )  [pure virtual]

Read our data back in from a ParamMap.

Implemented in ChannelFacetScalarSingle, and ChannelFacetScalarComplex.

virtual void ChannelFacet::writeTo ( ParamMap pmap  )  const [pure virtual]

Write our data out to a ParamMap.

Implemented in ChannelFacetScalarSingle, and ChannelFacetScalarComplex.


The documentation for this class was generated from the following files:
Generated on Sun May 8 08:20:46 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3