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