tomwalters@397: /*! tomwalters@397: * \file tomwalters@397: * \brief General definition for frequency scale management tomwalters@397: * tomwalters@397: * \author Willem van Engen tomwalters@397: * \date created 2006/09/26 tomwalters@397: * \version \$Id: Scale.h 576 2008-05-29 12:51:16Z tom $ tomwalters@397: */ tomwalters@397: /* (c) 2006, University of Cambridge, Medical Research Council tomwalters@397: * http://www.pdn.cam.ac.uk/groups/cnbh/aimmanual tomwalters@397: */ tomwalters@397: #ifndef __MODULE_SCALE_H__ tomwalters@397: #define __MODULE_SCALE_H__ tomwalters@397: tom@400: namespace aimc { tomwalters@397: tomwalters@397: /*! tomwalters@397: * \class Scale "Modules/Scale/Scale.h" tomwalters@397: * \brief General class for frequency scale management tomwalters@397: * tomwalters@397: * This class tomwalters@397: * - Converts between a linear and specified scale tomwalters@397: * - Creates filterbank signals based on that scale tomwalters@397: * - Creates any of the children filterbanks with Scale::Create. tomwalters@397: * To create a new scale, all you need to do is override ToLinear() and tomwalters@397: * FromLinear(). See existing scales like ScaleERB for example: tomwalters@397: */ tomwalters@397: class Scale; tomwalters@397: class Scale { tomwalters@397: public: tomwalters@398: //! \brief A list of possible scales tomwalters@398: enum ScaleType { tomwalters@398: SCALE_LINEAR, SCALE_ERB, SCALE_LOG, SCALE_LOGSCALED tomwalters@398: }; tomwalters@398: /*! \brief Create a new scale based on type tomwalters@398: * \param iType Scale type to create tomwalters@398: * \param min Bottom frequency tomwalters@398: * \param max Top frequency tomwalters@398: * \param density Density of distribution on the scale (scale-dependent) tomwalters@398: * \return Newly created scale, to be freed by the caller. tomwalters@398: * tomwalters@398: * This is on purpose no virtual function, always use it Scale::Create(). tomwalters@398: * \todo Split into scaling and filterbank creation parts. tomwalters@398: * Maybe even a separate ScaleMaker that implements Create(). tomwalters@398: */ tomwalters@398: static Scale *Create(ScaleType iType, unsigned int min, unsigned int max, float density); tomwalters@397: tomwalters@398: /*! \overload tomwalters@398: * This function is for scaling-only Scales, you must not create a SignalBank tomwalters@397: * with the returned Scale. tomwalters@398: */ tomwalters@398: static Scale *Create(ScaleType iType); tomwalters@397: tomwalters@398: /*! \brief Create a new Scale tomwalters@398: * \param min Bottom frequency tomwalters@398: * \param max Top frequency tomwalters@398: * \param density Density of distribution on the scale (scale-dependent) tomwalters@398: */ tomwalters@398: Scale(unsigned int min, unsigned int max, float density) { tomwalters@398: m_iMin = min; tomwalters@398: m_iMax = max; tomwalters@398: m_fDensity = density; tomwalters@398: m_sName = NULL; tomwalters@398: }; tomwalters@397: tomwalters@398: virtual ~Scale() { }; tomwalters@397: tomwalters@398: /*! \brief Create an exact copy of this Scale tomwalters@398: * \return A newly created Scale, to be freed by the caller. tomwalters@398: */ tomwalters@398: virtual Scale *Clone(); tomwalters@397: tomwalters@398: //! \return this Signal's ScaleType tomwalters@398: ScaleType getType() { return m_iType; }; tomwalters@398: //! \return this Signal's name tomwalters@398: const char *getName() { return m_sName; }; tomwalters@397: tomwalters@398: /*! \brief Scale a frequency from linear to this scale tomwalters@398: * \param fFreq Frequency to scale tomwalters@398: * \return Scaled frequency tomwalters@398: */ tomwalters@398: virtual float FromLinear(float fFreq) = 0; tomwalters@397: tomwalters@398: /*! \brief Scale a frequency from this scale to linear tomwalters@398: * \param fFreq Scaled frequency to scale back tomwalters@398: * \return Linear frequency tomwalters@398: */ tomwalters@398: virtual float ToLinear(float fFreq) = 0; tomwalters@397: tomwalters@398: /*! \brief Scale from [fMin..fMax] to [-0.5..0.5] tomwalters@398: * \param fVal Value to scale, must be within [fMin..fMax] tomwalters@398: * \return Float in [-0.5..0.5] according to this scale tomwalters@398: * \sa FromLinearScaledExtrema tomwalters@398: * tomwalters@398: * This is mainly for displaying any value on a scale and to make sure tomwalters@398: * that it fits in on screen. Don't use this for any real maths! tomwalters@398: * tomwalters@398: * The default implementation assumes that the scale is monotonic, so the tomwalters@398: * FromLinear(fMin) and FromLinear(fMax) are scale's output boundaries. tomwalters@398: * tomwalters@398: * fMin and fMax are set by FromLinearScaledExtrema. Do not use this before tomwalters@398: * calling that. tomwalters@398: */ tomwalters@398: float FromLinearScaled(float fVal); tomwalters@398: /*! \brief Update the FromLinearScaled min/max values tomwalters@398: * \param fMin Minimum value to be input tomwalters@398: * \param fMax Maxmimum value to be input tomwalters@398: * \sa FromLinearScaled tomwalters@398: */ tomwalters@398: void FromLinearScaledExtrema(float fMin, float fMax); tomwalters@398: /*! \overload tomwalters@398: * \brief Copy min/max values from another Scale tomwalters@398: * \param pScale Scale from which to copy min/max values, must not be NULL tomwalters@398: */ tomwalters@398: void FromLinearScaledExtrema(Scale *pScale); tomwalters@397: tomwalters@397: protected: tomwalters@398: //! \brief Bottom frequency tomwalters@398: unsigned int m_iMin; tomwalters@398: //! \brief Top frequency tomwalters@398: unsigned int m_iMax; tomwalters@398: //! \brief Density of distribution on the scale (scale-dependent) tomwalters@398: float m_fDensity; tomwalters@398: //! \brief The type of this scale, used by Clone(); set this in children. tomwalters@398: ScaleType m_iType; tomwalters@398: //! \brief The name of this scale; set this in children. tomwalters@398: const char *m_sName; tomwalters@397: tomwalters@398: /*! \brief Minimum value for scaling as input tomwalters@398: * \sa FromLinearScaled(), FromLinearScaledExtrema() */ tomwalters@398: float m_fMin; tomwalters@398: /*! \brief Maximum value for scaling as input tomwalters@398: * \sa FromLinearScaled(), FromLinearScaledExtrema() */ tomwalters@398: float m_fMax; tomwalters@398: //! \brief Value used in FromLinearScaled tomwalters@398: float m_fScaledCurHalfSum; tomwalters@398: //! \brief Value used in FromLinearScaled tomwalters@398: float m_fScaledCurDiff; tomwalters@397: }; tom@400: } // namespace aimc tomwalters@397: #endif /* __MODULE_SCALE_H__ */