flatmax@674: 
flatmax@598: // Author Matt Flax <flatmax@>
flatmax@597: //
flatmax@597: // This C++ file is part of an implementation of Lyon's cochlear model:
flatmax@597: // "Cascade of Asymmetric Resonators with Fast-Acting Compression"
flatmax@597: // to supplement Lyon's upcoming book "Human and Machine Hearing"
flatmax@597: //
flatmax@597: // Licensed under the Apache License, Version 2.0 (the "License");
flatmax@597: // you may not use this file except in compliance with the License.
flatmax@597: // You may obtain a copy of the License at
flatmax@597: //
flatmax@597: //     http://www.apache.org/licenses/LICENSE-2.0
flatmax@597: //
flatmax@597: // Unless required by applicable law or agreed to in writing, software
flatmax@597: // distributed under the License is distributed on an "AS IS" BASIS,
flatmax@597: // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
flatmax@597: // See the License for the specific language governing permissions and
flatmax@597: // limitations under the License.
flatmax@597: #ifndef CARPARAMS_H_
flatmax@597: #define CARPARAMS_H_
flatmax@597: 
flatmax@597: #include "Parameters.H"
flatmax@597: 
flatmax@598: class CAR; // required for decleration as a friend
flatmax@598: class Ear;
flatmax@598: 
flatmax@597: /**
flatmax@597:     \author {Matt Flax <flatmax\@>}
flatmax@597:     \date 2013.02.08
flatmax@597: 
flatmax@597: Parameters for the Cascaded Auditory Resonators
flatmax@597: */
flatmax@597: class CARParam : public Parameters {
flatmax@597:     FP_TYPE velocity_scale; ///< for the velocity nonlinearity
flatmax@597:     FP_TYPE v_offset; ///<  offset gives a quadratic part
flatmax@597:     FP_TYPE min_zeta; ///<  minimum damping factor in mid-freq channels
flatmax@597:     FP_TYPE max_zeta; ///<  maximum damping factor in mid-freq channels
flatmax@597:     FP_TYPE first_pole_theta; ///< Dick, whats this ?
flatmax@597:     FP_TYPE zero_ratio; ///<  how far zero is above pole
flatmax@597:     FP_TYPE high_f_damping_compression; ///<  0 to 1 to compress zeta
flatmax@597:     FP_TYPE ERB_per_step; ///<  assume G&M's ERB formula
flatmax@597:     FP_TYPE min_pole_Hz; ///< Dick, whats this ?
flatmax@597:     FP_TYPE ERB_break_freq; ///<  Greenwood map's break freq.
flatmax@597:     FP_TYPE ERB_Q; ///<  Glasberg and Moore's high-cf ratio
flatmax@597: 
flatmax@597: public:
flatmax@597: 
flatmax@597:     /// Constructor with default parameter values
flatmax@597:     CARParam(FP_TYPE velocity_scale_=0.1, FP_TYPE v_offset_=0.04, FP_TYPE min_zeta_=0.10, FP_TYPE max_zeta_=0.35,
flatmax@597:              FP_TYPE first_pole_theta_=0.85*M_PI, FP_TYPE zero_ratio_=sqrt(2.), FP_TYPE high_f_damping_compression_=0.5,
flatmax@597:              FP_TYPE ERB_per_step_=0.5, FP_TYPE min_pole_Hz_=30., FP_TYPE ERB_break_freq_=165.3,
flatmax@597:              FP_TYPE ERB_Q_=1000./(24.7*4.37));
flatmax@597:     virtual ~CARParam(); ///< Destructor
flatmax@598: 
flatmax@598:     friend class CAR;
flatmax@598:     friend class Ear;
flatmax@597: };
flatmax@597: 
flatmax@597: #endif // CARPARAMS_H_