PetaVision  Alpha
Public Member Functions | Protected Member Functions | Protected Attributes
PV::InitRandomWeights Class Referenceabstract
Inheritance diagram for PV::InitRandomWeights:
PV::InitWeights PV::BaseObject PV::CheckpointerDataInterface PV::Observer PV::InitGaussianRandomWeights PV::InitUniformRandomWeights

InitWeights Parameters

List of parameters needed by InitWeights class

virtual void ioParam_weightInitType (enum ParamsIOFlag ioFlag)
 weightInitType: Specifies the type of weight initialization. More...
 
virtual void ioParam_initWeightsFile (enum ParamsIOFlag ioFlag)
 initWeightsFile: A path to a weight pvp file to use for initializing the weights, which overrides the usual method of initializing weights defined by the class being instantiated. If the weights file has fewer features than the connection being initialized, the weights file is used for the lower-indexed features and the calcWeights method is used for the rest. If null or empty, calcWeights() is used to initialize all the weights.
 
virtual void ioParam_frameNumber (enum ParamsIOFlag ioFlag)
 frameNumber: If initWeightsFile is set, the frameNumber parameter selects which frame of the pvp file to use. The default value is zero. Note that this parameter is zero-indexed: for example, if a pvp file has five frames, the allowable values of this parameter are 0 through 4, inclusive.
 
virtual void ioParam_useListOfArborFiles (enum ParamsIOFlag ioFlag)
 useListOfArborFiles is obsolete.
 
virtual void ioParam_combineWeightFiles (enum ParamsIOFlag ioFlag)
 combineWeightFiles is obsolete.
 
virtual void ioParam_numWeightFiles (enum ParamsIOFlag ioFlag)
 numWeightFiles is obsolete.
 

Public Member Functions

bool getDataStructuresAllocatedFlag () const
 
std::string const & getDescription () const
 
char const * getDescription_c () const
 
bool getInitialValuesSetFlag () const
 
bool getInitInfoCommunicatedFlag () const
 
MPIBlock const * getMPIBlock ()
 
char const * getName () const
 
std::string const & getObjectType () const
 
void ioParams (enum ParamsIOFlag ioFlag, bool printHeader, bool printFooter)
 
virtual int ioParamsFillGroup (enum ParamsIOFlag ioFlag) override
 
bool isUsingGPU () const
 
char const * lookupKeyword () const
 
void readParams ()
 
virtual Response::Status registerData (Checkpointer *checkpointer)
 
virtual Response::Status respond (std::shared_ptr< BaseMessage const > message) override
 
void writeParams ()
 

Protected Member Functions

virtual Response::Status allocateDataStructures ()
 
float calcDelta (int post, float dPost, float distHeadPreUnits)
 
virtual void calcWeights (int patchIndex, int arborId) override
 
virtual void calcWeights ()
 
float calcXDelta (int iPost)
 
float calcYDelta (int jPost)
 
virtual Response::Status cleanup ()
 
virtual Response::Status communicateInitInfo (std::shared_ptr< CommunicateInitInfoMessage const > message) override
 
virtual Response::Status copyInitialStateToGPU ()
 
int dataIndexToUnitCellIndex (int dataIndex, int *kx=nullptr, int *ky=nullptr, int *kf=nullptr)
 
void handleObsoleteFlag (std::string const &flagName)
 
int initialize (char const *name, HyPerCol *hc)
 
virtual Response::Status initializeState () override
 
virtual int initRNGs (bool isKernel) override
 
int kernelIndexCalculations (int patchIndex)
 
virtual Response::Status prepareCheckpointWrite ()
 
virtual Response::Status processCheckpointRead ()
 
virtual void randomWeights (float *patchDataStart, int patchIndex)=0
 
virtual Response::Status readStateFromCheckpoint (Checkpointer *checkpointer) override
 
virtual int readWeights (const char *filename, int frameNumber, double *timestampPtr=nullptr)
 
Response::Status respondAllocateData (std::shared_ptr< AllocateDataMessage const > message)
 
Response::Status respondCleanup (std::shared_ptr< CleanupMessage const > message)
 
Response::Status respondCommunicateInitInfo (std::shared_ptr< CommunicateInitInfoMessage const > message)
 
Response::Status respondCopyInitialStateToGPU (std::shared_ptr< CopyInitialStateToGPUMessage const > message)
 
Response::Status respondInitializeState (std::shared_ptr< InitializeStateMessage const > message)
 
Response::Status respondPrepareCheckpointWrite (std::shared_ptr< PrepareCheckpointWriteMessage const > message)
 
Response::Status respondProcessCheckpointRead (std::shared_ptr< ProcessCheckpointReadMessage const > message)
 
Response::Status respondReadStateFromCheckpoint (std::shared_ptr< ReadStateFromCheckpointMessage< Checkpointer > const > message)
 
Response::Status respondRegisterData (std::shared_ptr< RegisterDataMessage< Checkpointer > const > message)
 
Response::Status respondSetCudaDevice (std::shared_ptr< SetCudaDeviceMessage const > message)
 
virtual Response::Status setCudaDevice (std::shared_ptr< SetCudaDeviceMessage const > message)
 
void setDataStructuresAllocatedFlag ()
 
void setDescription ()
 
void setInitialValuesSetFlag ()
 
void setInitInfoCommunicatedFlag ()
 
int setName (char const *name)
 
virtual void setObjectType () override
 
int setParent (HyPerCol *hc)
 

Protected Attributes

std::string description
 
PVCuda::CudaDevice * mCudaDevice = nullptr
 
bool mDataStructuresAllocatedFlag = false
 
float mDxPost
 
float mDyPost
 
char * mFilename = nullptr
 
int mFrameNumber = 0
 
bool mInitialValuesSetFlag = false
 
bool mInitInfoCommunicatedFlag = false
 
std::string mObjectType
 
Random * mRandState = nullptr
 
bool mUsingGPUFlag = false
 
char * mWeightInitTypeString = nullptr
 
Weights * mWeights = nullptr
 
float mXDistHeadPreUnits
 
float mYDistHeadPreUnits
 
char * name = nullptr
 
HyPerCol * parent = nullptr
 

Detailed Description

Definition at line 16 of file InitRandomWeights.hpp.

Member Function Documentation

void PV::InitRandomWeights::calcWeights ( int  dataPatchIndex,
int  arborId 
)
overrideprotectedvirtual

Called by calcWeights(void), to calculate the weights in the given arbor and patch. Derived classes generally override this method.

Reimplemented from PV::InitWeights.

Definition at line 24 of file InitRandomWeights.cpp.

void PV::InitWeights::calcWeights ( void  )
protectedvirtualinherited

Called by initializeWeights, to calculate the weights in all arbors and all patches. The base implementation callse calcWeights(int, int) in a loop over arbors and patches

Reimplemented in PV::InitGauss2DWeights.

Definition at line 144 of file InitWeights.cpp.

bool PV::BaseObject::getDataStructuresAllocatedFlag ( ) const
inlineinherited

Get-method for mDataStructuresAllocatedFlag, which is false on initialization and then becomes true once setDataStructuresAllocatedFlag() is called.

Definition at line 102 of file BaseObject.hpp.

bool PV::BaseObject::getInitialValuesSetFlag ( ) const
inlineinherited

Get-method for mInitialValuesSetFlag, which is false on initialization and then becomes true once setInitialValuesSetFlag() is called.

Definition at line 108 of file BaseObject.hpp.

bool PV::BaseObject::getInitInfoCommunicatedFlag ( ) const
inlineinherited

Get-method for mInitInfoCommunicatedFlag, which is false on initialization and then becomes true once setInitInfoCommunicatedFlag() is called.

Definition at line 95 of file BaseObject.hpp.

void PV::InitWeights::ioParam_weightInitType ( enum ParamsIOFlag  ioFlag)
protectedvirtualinherited

weightInitType: Specifies the type of weight initialization.

This parameter is not used directly inside the InitWeights class, except to include the parameter in generated params files. Generally, instantiation should proceed by separately reading the WeightInitType and using the Factory::createByKeyword template to instantiate the function.

Definition at line 50 of file InitWeights.cpp.

void PV::BaseObject::ioParams ( enum ParamsIOFlag  ioFlag,
bool  printHeader,
bool  printFooter 
)
inherited

Method for reading or writing the params from group in the parent HyPerCol's parameters. The group from params is selected using the name of the connection.

If ioFlag is set to write, the printHeader and printFooter flags control whether a header and footer for the parameter group is produces. These flags are set to true for layers, connections, and probes; and set to false for weight initializers and normalizers. If ioFlag is set to read, the printHeader and printFooter flags are ignored.

Note that ioParams is not virtual. To add parameters in a derived class, override ioParamFillGroup.

Definition at line 74 of file BaseObject.cpp.

int PV::InitWeights::ioParamsFillGroup ( enum ParamsIOFlag  ioFlag)
overridevirtualinherited

The virtual method for reading parameters from the parent HyPerCol's parameters, and writing to the output params file.

Derived classes with additional parameters typically override ioParamsFillGroup to call the base class's ioParamsFillGroup method and then call ioParam_[parametername] for each of their parameters. The ioParam_[parametername] methods should call the parent HyPerCol's ioParamValue() and related methods, to ensure that all parameters that get read also get written to the outputParams-generated file.

Reimplemented from PV::BaseObject.

Reimplemented in PV::InitGauss2DWeights, PV::InitUniformWeights, PV::InitCocircWeights, PV::InitUniformRandomWeights, PV::InitGaussianRandomWeights, PV::InitOneToOneWeights, and PV::InitSpreadOverArborsWeights.

Definition at line 39 of file InitWeights.cpp.

bool PV::BaseObject::isUsingGPU ( ) const
inlineinherited

Returns true if the object requires the GPU; false otherwise. HyPerCol will not initialize the GPU unless one of the objects in its hierarchy returns true

Definition at line 116 of file BaseObject.hpp.

char const * PV::BaseObject::lookupKeyword ( ) const
inherited

Look up the keyword of the params group with the same name as the object.

Definition at line 42 of file BaseObject.cpp.

void PV::BaseObject::readParams ( )
inlineinherited

A method that reads the parameters for the group whose name matches the name of the object. It, along with writeParams(), is a wrapper around ioParams, so that readParams and writeParams automatically run through the same parameters in the same order.

Definition at line 62 of file BaseObject.hpp.

void PV::BaseObject::setDataStructuresAllocatedFlag ( )
inlineprotectedinherited

This method sets mDataStructuresAllocatedFlag to true.

Definition at line 175 of file BaseObject.hpp.

void PV::BaseObject::setInitialValuesSetFlag ( )
inlineprotectedinherited

This method sets the flag returned by getInitialValuesSetFlag to true.

Definition at line 180 of file BaseObject.hpp.

void PV::BaseObject::setInitInfoCommunicatedFlag ( )
inlineprotectedinherited

This method sets mInitInfoCommunicatedFlag to true.

Definition at line 170 of file BaseObject.hpp.

void PV::BaseObject::writeParams ( )
inlineinherited

A method that writes the parameters for the group whose name matches the name of the object. It, along with readParams(), is a wrapper around ioParams, so that readParams and writeParams automatically run through the same parameters in the same order.

Definition at line 69 of file BaseObject.hpp.

The documentation for this class was generated from the following files: