alexbrandmeyer@609: //
alexbrandmeyer@609: //  carfac_output.h
alexbrandmeyer@609: //  CARFAC Open Source C++ Library
alexbrandmeyer@609: //
alexbrandmeyer@609: //  Created by Alex Brandmeyer on 5/10/13.
alexbrandmeyer@609: //
alexbrandmeyer@609: // This C++ file is part of an implementation of Lyon's cochlear model:
alexbrandmeyer@609: // "Cascade of Asymmetric Resonators with Fast-Acting Compression"
alexbrandmeyer@609: // to supplement Lyon's upcoming book "Human and Machine Hearing"
alexbrandmeyer@609: //
alexbrandmeyer@609: // Licensed under the Apache License, Version 2.0 (the "License");
alexbrandmeyer@609: // you may not use this file except in compliance with the License.
alexbrandmeyer@609: // You may obtain a copy of the License at
alexbrandmeyer@609: //
alexbrandmeyer@609: //     http://www.apache.org/licenses/LICENSE-2.0
alexbrandmeyer@609: //
alexbrandmeyer@609: // Unless required by applicable law or agreed to in writing, software
alexbrandmeyer@609: // distributed under the License is distributed on an "AS IS" BASIS,
alexbrandmeyer@609: // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
alexbrandmeyer@609: // See the License for the specific language governing permissions and
alexbrandmeyer@609: // limitations under the License.
alexbrandmeyer@609: //
alexbrandmeyer@609: // *****************************************************************************
alexbrandmeyer@609: // Class: CARFACOutput
alexbrandmeyer@609: // *****************************************************************************
alexbrandmeyer@609: // The CARFACOutput object stores an array of EarOuput objects. It is meant as a
alexbrandmeyer@609: // container for the output generated by the CARFAC object's 'Run' and
alexbrandmeyer@609: // 'RunSegment' methods. Depending on the number of audio channels in the  input
alexbrandmeyer@609: // data, the CARFACOutput will have 1 or more EarOutput obects, each of which
alexbrandmeyer@609: // contains a set of two dimensional float arrays (FloatArray2d) representing
alexbrandmeyer@609: // the neural activation patterns (NAPs) generated by the CARFAC model.
alexbrandmeyer@609: //
alexbrandmeyer@609: // The 'InitOutput' method is used to initialize the arrays in each of the
alexbrandmeyer@609: // EarOutput sub-objects once the target data dimensions ears (n_ears), channels
alexbrandmeyer@609: // (n_ch) and timepoints (n_tp) are known.
alexbrandmeyer@609: 
alexbrandmeyer@609: #ifndef CARFAC_Open_Source_C__Library_carfac_output_h
alexbrandmeyer@609: #define CARFAC_Open_Source_C__Library_carfac_output_h
alexbrandmeyer@609: 
alexbrandmeyer@609: #include "ear_output.h"
alexbrandmeyer@609: 
alexbrandmeyer@611: class CARFACOutput {
alexbrandmeyer@611:  public:
alexbrandmeyer@626:   void InitOutput(const int n_ears, const int n_ch,
alexbrandmeyer@626:                   const int32_t n_timepoints);
alexbrandmeyer@626:   void StoreNAPOutput(const int32_t timepoint, const int ear,
alexbrandmeyer@626:                       const FloatArray& nap);
alexbrandmeyer@626:   void StoreBMOutput(const int32_t timepoint, const int ear,
alexbrandmeyer@626:                      const FloatArray& bm);
alexbrandmeyer@626:   void StoreOHCOutput(const int32_t timepoint, const int ear,
alexbrandmeyer@626:                       const FloatArray& ohc);
alexbrandmeyer@626:   void StoreAGCOutput(const int32_t timepoint, const int ear,
alexbrandmeyer@626:                       const FloatArray& agc);
alexbrandmeyer@626: 
alexbrandmeyer@611:  private:
alexbrandmeyer@609:   int n_ears_;
alexbrandmeyer@611:   std::vector<EarOutput> ears_;
alexbrandmeyer@609: };
alexbrandmeyer@609: 
alexbrandmeyer@610: #endif