annotate trunk/carfac/carfac_output.h @ 684:49af9a8d5a53

Initial translation of SAI code to C++.

This only implements the simple (as opposed to the layered) SAI, as
implemented in SAI_Run.m.

//
//  carfac_output.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.
//
// *****************************************************************************
// Class: CARFACOutput
// *****************************************************************************
// The CARFACOutput object stores an array of EarOuput objects. It is meant as a
// container for the output generated by the CARFAC object's 'Run' and
// 'RunSegment' methods. Depending on the number of audio channels in the  input
// data, the CARFACOutput will have 1 or more EarOutput obects, each of which
// contains a set of two dimensional float arrays (FloatArray2d) representing
// the neural activation patterns (NAPs) generated by the CARFAC model.
//
// The 'InitOutput' method is used to initialize the arrays in each of the
// EarOutput sub-objects once the target data dimensions ears (n_ears), channels
// (n_ch) and timepoints (n_tp) are known.

#ifndef CARFAC_CARFAC_OUTPUT_H
#define CARFAC_CARFAC_OUTPUT_H

#include <deque>
#include <vector>
#include "carfac_common.h"
#include "ear.h"

class CARFACOutput {
 public:
  void Init(const int n_ears, const bool store_nap, const bool  store_nap_decim,
             const bool store_bm, const bool store_ohc, const bool store_agc);
  void StoreOutput(const std::vector<Ear>& ears);
  // Here we define several acessors for the data members.
  const std::deque<std::vector<FloatArray>>& nap() { return nap_; }
  const std::deque<std::vector<FloatArray>>& bm() { return bm_; }
  const std::deque<std::vector<FloatArray>>& nap_decim() { return nap_decim_; }
  const std::deque<std::vector<FloatArray>>& ohc() { return ohc_; }
  const std::deque<std::vector<FloatArray>>& agc() { return agc_; }

 private:
  int n_ears_;
  bool store_nap_;
  bool store_nap_decim_;
  bool store_bm_;
  bool store_ohc_;
  bool store_agc_;
  std::deque<std::vector<FloatArray>> nap_;
  std::deque<std::vector<FloatArray>> nap_decim_;
  std::deque<std::vector<FloatArray>> bm_;
  std::deque<std::vector<FloatArray>> ohc_;
  std::deque<std::vector<FloatArray>> agc_;
};

#endif  // CARFAC_CARFAC_OUTPUT_H