InitWeights.hpp

/*
 * InitWeights.hpp
 *
 *  Created on: Aug 5, 2011
 *      Author: kpeterson
 */

#ifndef INITWEIGHTS_HPP_
#define INITWEIGHTS_HPP_

#include "columns/BaseObject.hpp"
#include "components/WeightsPair.hpp"
#include "layers/HyPerLayer.hpp"

namespace PV {

class InitWeights : public BaseObject {
  protected:
   virtual void ioParam_weightInitType(enum ParamsIOFlag ioFlag);

   virtual void ioParam_initWeightsFile(enum ParamsIOFlag ioFlag);

   virtual void ioParam_frameNumber(enum ParamsIOFlag ioFlag);

   // useListOfArborFiles, combineWeightFiles, and numWeightFiles were marked obsolete July 13,
   // 2017.
   virtual void ioParam_useListOfArborFiles(enum ParamsIOFlag ioFlag);

   virtual void ioParam_combineWeightFiles(enum ParamsIOFlag ioFlag);

   virtual void ioParam_numWeightFiles(enum ParamsIOFlag ioFlag) {}
  public:
   InitWeights(char const *name, HyPerCol *hc);
   virtual ~InitWeights();

   virtual int ioParamsFillGroup(enum ParamsIOFlag ioFlag) override;

  protected:
   InitWeights();
   int initialize(const char *name, HyPerCol *hc);
   void handleObsoleteFlag(std::string const &flagName);

   virtual void setObjectType() override;

   virtual Response::Status
   communicateInitInfo(std::shared_ptr<CommunicateInitInfoMessage const> message) override;

   /*
    * initializeState checks initWeightsFile. If initWeightsFile is set, the weights are
    * loaded from the file. If it is not set, it calls calcWeights with no arguments.
    * Generally, derived classes should not override initializeState, but instead override
    * one or both of the calcWeights methods, in order to preserve the initWeightsFile behavior.
    */
   virtual Response::Status initializeState() override;

   virtual void calcWeights();

   virtual void calcWeights(int dataPatchIndex, int arborId);

   virtual int readWeights(const char *filename, int frameNumber, double *timestampPtr = nullptr);

   virtual int initRNGs(bool isKernel) { return PV_SUCCESS; }

   int
   dataIndexToUnitCellIndex(int dataIndex, int *kx = nullptr, int *ky = nullptr, int *kf = nullptr);
   int kernelIndexCalculations(int patchIndex);
   float calcYDelta(int jPost);
   float calcXDelta(int iPost);
   float calcDelta(int post, float dPost, float distHeadPreUnits);

  protected:
   Weights *mWeights = nullptr; // initializeWeights sets this to the WeightsPair's PreWeights.

   char *mWeightInitTypeString = nullptr;

   char *mFilename  = nullptr;
   int mFrameNumber = 0;
   float mDxPost;
   float mDyPost;
   float mXDistHeadPreUnits;
   float mYDistHeadPreUnits;

}; // class InitWeights

} /* namespace PV */
#endif /* INITWEIGHTS_HPP_ */