CATFilter.h

Go to the documentation of this file.

/// \file CATFilter.h
/// \brief Parent filtering class for one-dimensional filters.
/// \ingroup CAT
///
/// Copyright (c) 2003-2008 by Michael Ellison.
/// See COPYING.txt for the \ref gaslicense License (MIT License).
///
// $Author: mikeellison $
// $Date: 2008-01-19 19:19:35 -0600 (Sat, 19 Jan 2008) $
// $Revision:   $
// $NoKeywords: $

#ifndef _CATFilter_H_
#define _CATFilter_H_

#include "CATInternal.h"
#include "CATMathUtil.h"

/// \class CATFilter
/// \brief Parent filtering class for one-dimensional filters.
/// \ingroup CAT
///
/// The base class performs no filtering. Filters should be derived
/// from it to present a common interface.
class CATFilter
{
    public:
        CATFilter();
        virtual ~CATFilter();

        /// Filter() is the primary command for all derived classes,
        /// but it's now inlined for speed instead of being virtual.
        /// CATFloat32 Filter();

        /// GetLastFiltered() retrieves the last output value from the filter.
        ///
        /// \return CATFloat32 - last output from Filter() call.
        /// \sa Filter(), GetLastRaw()
        CATFloat32  GetLastFiltered();

        /// GetCount() retrieves the number of items filtered since the last
        /// reset (or since instantiation).
        ///
        /// \return CATUInt32 - number of filtered inputs
        /// \sa Reset()
        CATUInt32   GetCount();

        /// Reset() resets the filter and filter count.
        virtual void Reset();

    protected:
        CATFloat32 fLastFiltered;
};


#endif // _CATFilter_H_

---