annotate trunk/carfac/ihc_params.h @ 679:594b410c2aed

Sixth revision of Alex Brandmeyer's C++ implementation. Only small changes in response to Lyon's comments from r285. Note: I tried to use a consistent indentation with two spaces, but also preserving parenthetical structure to make reading the longer equations easier. Please advise if this is OK. Additional documentation and tests with non-standard parameter sets will be added in a subsequent revision.

//
//  ihc_params.h
//  CARFAC Open Source C++ Library
//
//  Created by Alex Brandmeyer on 5/10/13.
//
// This C++ file is part of an implementation of Lyon's cochlear model:
// "Cascade of Asymmetric Resonators with Fast-Acting Compression"
// to supplement Lyon's upcoming book "Human and Machine Hearing"
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef CARFAC_Open_Source_C__Library_IHCParams_h
#define CARFAC_Open_Source_C__Library_IHCParams_h

#include "carfac_common.h"

struct IHCParams {
  IHCParams() {
    just_half_wave_rectify_ = false;
    one_capacitor_ = true;
    tau_lpf_ = 0.000080;
    tau1_out_ = 0.0005;
    tau1_in_ = 0.010;
    tau2_out_ = 0.0025;
    tau2_in_ = 0.005;
    ac_corner_hz_ = 20.0;
  };
  bool just_half_wave_rectify_;
  bool one_capacitor_;
  FPType tau_lpf_;
  FPType tau1_out_;
  FPType tau1_in_;
  FPType tau2_out_;
  FPType tau2_in_;
  FPType ac_corner_hz_;
};

#endif