flatmax@632: 
flatmax@593: // Author Matt Flax <flatmax@>
flatmax@592: //
flatmax@592: // This C++ file is part of an implementation of Lyon's cochlear model:
flatmax@592: // "Cascade of Asymmetric Resonators with Fast-Acting Compression"
flatmax@592: // to supplement Lyon's upcoming book "Human and Machine Hearing"
flatmax@592: //
flatmax@592: // Licensed under the Apache License, Version 2.0 (the "License");
flatmax@592: // you may not use this file except in compliance with the License.
flatmax@592: // You may obtain a copy of the License at
flatmax@592: //
flatmax@592: //     http://www.apache.org/licenses/LICENSE-2.0
flatmax@592: //
flatmax@592: // Unless required by applicable law or agreed to in writing, software
flatmax@592: // distributed under the License is distributed on an "AS IS" BASIS,
flatmax@592: // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
flatmax@592: // See the License for the specific language governing permissions and
flatmax@592: // limitations under the License.
flatmax@592: #ifndef CAR_H_
flatmax@592: #define CAR_H_
flatmax@592: 
flatmax@592: #include "EarComponent.H" // includes the various {CAR, IHC, AGC} {Coeff, Param, State} .H files
flatmax@592: 
flatmax@593: class Ear;
flatmax@593: 
flatmax@592: /**
flatmax@592:     \author {Matt Flax <flatmax\@>}
flatmax@592:     \date 2013.02.08
flatmax@592: 
flatmax@592: Cascade of asymmetric resonators (CAR).
flatmax@592: */
flatmax@592: class CAR : public EarComponent<CARCoeff, CARParam, CARState> {
flatmax@593:     Array<FP_TYPE, Dynamic,1> pole_freqs; ///< The vector of pole frequencies used in filter design and variable estimation
flatmax@593: 
flatmax@593:     protected:
flatmax@593: 
flatmax@593:     /** Method to design the auditory filter coefficients
flatmax@593:     \param fs The sample rate in Hz
flatmax@601:     \param n_ch The number of channels. The CAR.coeff are one row per channel
flatmax@593:     */
flatmax@593:     void designFilters(FP_TYPE fs, int n_ch);
flatmax@593: 
flatmax@593:     /** Return the stage gain g needed to get unity gain at DC
flatmax@593:     \param relative_undamping Dick whats this ?
flatmax@593:     \return The stage gain required to obtain 0 dB at DC.
flatmax@593:     */
flatmax@593:     Array<FP_TYPE, Dynamic, 1> stageG(Array<FP_TYPE, Dynamic, 1> &relative_undamping);
flatmax@593: 
flatmax@592:     public:
flatmax@592:         CAR();
flatmax@592:         virtual ~CAR();
flatmax@593: 
flatmax@593:     friend class Ear;
flatmax@592: };
flatmax@592: 
flatmax@592: #endif // CAR_H_