NormalizeContrastZeroMean.hpp

/*
 * NormalizeContrastZeroMean.hpp
 *
 *  Created on: Apr 8, 2013
 *      Author: pschultz
 */

#ifndef NORMALIZECONTRASTZEROMEAN_HPP_
#define NORMALIZECONTRASTZEROMEAN_HPP_

#include "NormalizeBase.hpp"

namespace PV {

class NormalizeContrastZeroMean : public PV::NormalizeBase {
   // Member functions
  public:
   NormalizeContrastZeroMean(const char *name, HyPerCol *hc);
   virtual ~NormalizeContrastZeroMean();

   virtual int ioParamsFillGroup(enum ParamsIOFlag ioFlag) override;
   virtual int normalizeWeights() override;

  protected:
   NormalizeContrastZeroMean();
   int initialize(const char *name, HyPerCol *hc);

   virtual void ioParam_minSumTolerated(enum ParamsIOFlag ioFlag);
   virtual void ioParam_normalizeFromPostPerspective(enum ParamsIOFlag ioFlag);

   static void subtractOffsetAndNormalize(
         float *dataStartPatch,
         int weightsPerPatch,
         float offset,
         float normalizer);
   int accumulateSumAndSumSquared(
         float *dataPatchStart,
         int weights_in_patch,
         float *sum,
         float *sumsq);

  private:
   int initialize_base();

   // Member variables
  protected:
   float minSumTolerated; // Error if abs(sum(weights)) in any patch is less than this amount.
}; // class NormalizeContrastZeroMean

} /* namespace PV */
#endif /* NORMALIZECONTRASTZEROMEAN_HPP_ */