PatchSize.hpp

/*
 * PatchSize.hpp
 *
 *  Created on: Jan 5, 2018
 *      Author: Pete Schultz
 */

#ifndef PATCHSIZE_HPP_
#define PATCHSIZE_HPP_

#include "columns/BaseObject.hpp"
#include "components/ConnectionData.hpp"

namespace PV {

class PatchSize : public BaseObject {
  protected:
   virtual void ioParam_nxp(enum ParamsIOFlag ioFlag);

   virtual void ioParam_nyp(enum ParamsIOFlag ioFlag);

   virtual void ioParam_nfp(enum ParamsIOFlag ioFlag);
 // end of PatchSize parameters

  public:
   PatchSize(char const *name, HyPerCol *hc);

   virtual ~PatchSize();

   int getPatchSizeX() const { return mPatchSizeX; }
   int getPatchSizeY() const { return mPatchSizeY; }
   int getPatchSizeF() const { return mPatchSizeF; }
   ConnectionData *getConnectionData() const { return mConnectionData; }

   static int calcPostPatchSize(int prePatchSize, int numNeuronsPre, int numNeuronsPost);

  protected:
   PatchSize() {}

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

   virtual void setObjectType() override;

   int ioParamsFillGroup(enum ParamsIOFlag ioFlag) override;

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

  protected:
   int mPatchSizeX = 1;
   int mPatchSizeY = 1;
   int mPatchSizeF = -1;

   ConnectionData *mConnectionData = nullptr;
   bool mWarnDefaultNfp            = true;
   // Whether to print a warning if the default nfp is used.
   // Derived classes can set to false if no warning is necessary.
};

} // namespace PV

#endif // PATCHSIZE_HPP_