#include <FirmThresholdCostFnLCAProbe.hpp>

Inheritance diagram for PV::FirmThresholdCostFnLCAProbe:

AbstractNormProbe Parameters
List of parameters needed from the AbstractNormProbe class
virtual void	ioParam_maskLayerName (enum ParamsIOFlag ioFlag)
	maskLayerName: Specifies a masking layer to use when calculating the norm. When blank (the default), masking is not used. More...

BaseProbe Parameters
List of parameters for the BaseProbe class
virtual void	ioParam_message (enum ParamsIOFlag ioFlag)
	message: A string parameter that is typically included in the lines output by the outputState method

virtual void	ioParam_textOutputFlag (enum ParamsIOFlag ioFlag)
	textOutputFlag: A boolean parameter that sets whether to generate an output file. Defaults to true.

virtual void	ioParam_probeOutputFile (enum ParamsIOFlag ioFlag)
	probeOutputFile: If textOutputFlag is true, probeOutputFile specifies the name of the file that the outputState method writes to. If blank, the output is sent to the output stream.

virtual void	ioParam_triggerFlag (enum ParamsIOFlag ioFlag)
	triggerFlag: If false, the needUpdate method always returns true, so that outputState is called every timestep. If true, the needUpdate method uses triggerLayerName and triggerOffset to determine if the probe should be triggered.

virtual void	ioParam_triggerLayerName (enum ParamsIOFlag ioFlag)
	triggerLayerName: If triggerFlag is true, triggerLayerName specifies the layer to check for triggering.

virtual void	ioParam_triggerOffset (enum ParamsIOFlag ioFlag)
	triggerOffset: If triggerFlag is true, triggerOffset specifies the time interval before the triggerLayer's nextUpdate time that needUpdate() returns true.

virtual void	ioParam_energyProbe (enum ParamsIOFlag ioFlag)
	energyProbe: If nonblank, specifies the name of a ColumnEnergyProbe that this probe contributes an energy term to.

FirmThresholdCostFnProbe Parameters
List of parameters for the FirmThresholdCostFnProbe class
virtual void	ioParam_VThresh (enum ParamsIOFlag ioFlag)
	VThresh: The threshold where the transfer function returns 0 if \|V\|<VThresh. If the target layer is an ANNLayer or one of its subclasses, the default is the target layer's VThresh; otherwise, the default is zero.

virtual void	ioParam_VWidth (enum ParamsIOFlag ioFlag)
	VWidth: The width of the interval over which the transfer function changes from hard to soft threshold. If the target layer is an ANNLayer or one of its subclasses, the default is the target layer's VWidth; otherwise, the default is zero.

LayerProbe Parameters
List of parameters for the LayerProbe class
virtual void	ioParam_targetName (enum ParamsIOFlag ioFlag) override
	targetName: the name of the layer to attach the probe to. In LayerProbes, targetLayer can be used in the params file instead of targetName. LayerProbe looks for targetLayer first and then targetName.

Public Member Functions
	FirmThresholdCostFnLCAProbe (const char name, HyPerCol hc)

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

double	getCoefficient ()

bool	getDataStructuresAllocatedFlag () const

std::string const &	getDescription () const

char const *	getDescription_c () const

char const *	getEnergyProbe ()

bool	getInitialValuesSetFlag () const

bool	getInitInfoCommunicatedFlag () const

double	getLastUpdateTime ()

HyPerLayer *	getMaskLayer ()

char const *	getMaskLayerName ()

MPIBlock const *	getMPIBlock ()

char const *	getName () const

int	getNumValues ()

std::string const &	getObjectType () const

HyPerLayer *	getTargetLayer ()

const char *	getTargetName ()

double	getValue (double timevalue, int index)

void	getValues (double timevalue, double *valuesVector)

void	getValues (double timevalue, std::vector< double > *valuesVector)

void	ioParams (enum ParamsIOFlag ioFlag, bool printHeader, bool printFooter)

bool	isUsingGPU () const

char const *	lookupKeyword () const

virtual Response::Status	outputStateWrapper (double timef, double dt)

void	readParams ()

virtual Response::Status	registerData (Checkpointer *checkpointer) override

virtual Response::Status	respond (std::shared_ptr< BaseMessage const > message) override

void	writeParams ()

virtual int	writeTimer (PrintStream &stream)

Protected Member Functions
virtual Response::Status	allocateDataStructures ()

virtual void	calcValues (double timeValue) override

virtual Response::Status	cleanup ()

virtual Response::Status	copyInitialStateToGPU ()

const char *	getMessage ()

char const *	getNormDescription ()

char const *	getProbeOutputFilename ()

bool	getTextOutputFlag () const

virtual double	getValueInternal (double timevalue, int index) override

void	getValues (double timevalue)

double *	getValuesBuffer ()

int	initFirmThresholdCostFnLCAProbe (const char name, HyPerCol hc)

int	initialize (const char name, HyPerCol hc)

virtual Response::Status	initializeState ()

virtual int	initMessage (const char *msg)

virtual void	initNumValues ()

virtual void	initOutputStreams (const char filename, Checkpointer checkpointer)

virtual void	ioParam_coefficient (enum ParamsIOFlag ioFlag) override

virtual int	ioParamsFillGroup (enum ParamsIOFlag ioFlag) override

bool	isWritingToFile () const

bool	maskHasSingleFeature ()

virtual bool	needRecalc (double timevalue) override

virtual bool	needUpdate (double time, double dt)

PrintStream &	output (int b)

virtual Response::Status	outputState (double timevalue) override

virtual Response::Status	prepareCheckpointWrite ()

virtual Response::Status	processCheckpointRead ()

virtual Response::Status	readStateFromCheckpoint (Checkpointer *checkpointer) override

virtual double	referenceUpdateTime () const override

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 int	setNormDescription () override

int	setNormDescriptionToString (char const *s)

void	setNumValues (int n)

virtual void	setObjectType () override

int	setParent (HyPerCol *hc)

Protected Attributes
double	coefficient

std::string	description

char *	energyProbe

PVCuda::CudaDevice *	mCudaDevice = nullptr

bool	mInitialValuesSetFlag = false

std::string	mObjectType

std::vector< PrintStream * >	mOutputStreams

bool	mUsingGPUFlag = false

char *	name = nullptr

HyPerCol *	parent = nullptr

HyPerLayer *	targetLayer

char *	targetName

bool	triggerFlag

HyPerLayer *	triggerLayer

char *	triggerLayerName

double	triggerOffset

float	VThresh

float	VWidth

Private Member Functions
int	initialize_base ()

Detailed Description

A special case of FirmThresholdCostFnProbe, to be used when the target layer is an LCA layer with a hard-threshold transfer function. The corresponding cost function is the norm measured by FirmThresholdCostFnProbe, with coefficient Vth, where Vth is the target LCA layer's VThresh.

Definition at line 24 of file FirmThresholdCostFnLCAProbe.hpp.

Member Function Documentation

void PV::AbstractNormProbe::calcValues ( double timeValue )

overrideprotectedvirtualinherited

Computes the norms. Each MPI process calls getValueInternal to compute its own contribution to the norms, and then calcValues calls MPI_Allreduce.

Implements PV::BaseProbe.

Reimplemented in PV::L2NormProbe.

Definition at line 136 of file AbstractNormProbe.cpp.

Response::Status PV::FirmThresholdCostFnLCAProbe::communicateInitInfo ( std::shared_ptr< CommunicateInitInfoMessage const > message )

overridevirtual

Calls LayerProbe::communicateInitInfo to set up the targetLayer and attach the probe; and then checks the masking layer if masking is used.

Reimplemented from PV::FirmThresholdCostFnProbe.

Definition at line 20 of file FirmThresholdCostFnLCAProbe.cpp.

double PV::BaseProbe::getCoefficient ( )

inlineinherited

Returns the coefficient if the energy probe is set.

Definition at line 95 of file BaseProbe.hpp.

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.

char const* PV::BaseProbe::getEnergyProbe ( )

inlineinherited

Returns the name of the energy probe the probe is attached to (null if not attached to an energy probe)

Definition at line 90 of file BaseProbe.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.

double PV::BaseProbe::getLastUpdateTime ( )

inlineinherited

Returns the time that calcValues was last called. BaseProbe updates the last update time in getValues() and getValue(), based on the result of needRecalc.

Definition at line 102 of file BaseProbe.hpp.

HyPerLayer* PV::AbstractNormProbe::getMaskLayer ( )

inlineinherited

Returns a pointer to the masking layer. Returns NULL if masking is not used.

Definition at line 37 of file AbstractNormProbe.hpp.

char const* PV::AbstractNormProbe::getMaskLayerName ( )

inlineinherited

Returns the name of the masking layer, as given by the params. maskLayerName is not set in params, it returns NULL.

Definition at line 43 of file AbstractNormProbe.hpp.

const char* PV::BaseProbe::getMessage ( )

inlineprotectedinherited

Returns a pointer to the message parameter.

Definition at line 280 of file BaseProbe.hpp.

int PV::BaseProbe::getNumValues ( )

inlineinherited

Returns the number of value indices the probe can compute (typically the value of the parent HyPerCol's nBatch parameter). BaseProbe::getNumValues() returns the parent HyPerCol's getNBatch(), which can be overridden. Probes derived from BaseProbe can set numValues to zero or a negative number to indicate that getValues() and getNumValues() are not fully implemented for that probe.

Definition at line 61 of file BaseProbe.hpp.

char const* PV::BaseProbe::getProbeOutputFilename ( )

inlineprotectedinherited

Returns the probeOutputFilename parameter

Definition at line 314 of file BaseProbe.hpp.

const char* PV::BaseProbe::getTargetName ( )

inlineinherited

Returns the name of the targetName parameter for this probe. LayerProbe uses targetName to specify the layer to attach to; BaseConnectionProbe uses it to specify the connection to attach to.

Definition at line 83 of file BaseProbe.hpp.

bool PV::BaseProbe::getTextOutputFlag ( ) const

inlineprotectedinherited

Returns the value of the textOutputFlag parameter

Definition at line 324 of file BaseProbe.hpp.

double PV::BaseProbe::getValue	(	double	timevalue,
		int	index
	)

inherited

getValue() is meant for situations where the caller needs one value that would be returned by getValues(), not the whole buffer. getValue() returns a signaling NaN if index is out of bounds. If index is valid, getValue() calls calcValues() if needRecalc() returns true, and then returns probeValues[index]. Derived classes should not override or hide this method. Instead, they should override calcValues.

Definition at line 346 of file BaseProbe.cpp.

double PV::FirmThresholdCostFnProbe::getValueInternal	(	double	timevalue,
		int	index
	)

overrideprotectedvirtualinherited

getValueInternal(double, index) is a pure virtual function called by calcValues(). The index refers to the layer's batch element index.

Typically, getValueInternal should compute the contribution to the norm from its own MPI process. Then calcValues calls MPI_Allreduce.

Implements PV::AbstractNormProbe.

Definition at line 81 of file FirmThresholdCostFnProbe.cpp.

void PV::BaseProbe::getValues	(	double	timevalue,
		double *	valuesVector
	)

inherited

getValues(double timevalue, double * values) sets the buffer 'values' with the probe's calculated values. It assumes that the values buffer is large enough to hold getNumValues() double-precision values. If 'values' is NULL, the values are still updated internally if needed, but those values are not returned. Internally, getValues() calls calcValues() if needRecalc() is true. It then copies the probeValues buffer to the input argument buffer 'values'. Derived classes should not override or hide this method. Instead, they should override calcValues.

Definition at line 336 of file BaseProbe.cpp.

void PV::BaseProbe::getValues	(	double	timevalue,
		std::vector< double > *	valuesVector
	)

inherited

getValues(double timevalue, vector<double> * valuesVector) is a wrapper around getValues(double, double *) that uses C++ vectors. It resizes valuesVector to size getNumValues() and then fills the vector with the values returned by getValues.

Definition at line 341 of file BaseProbe.cpp.

void PV::BaseProbe::getValues ( double timevalue )

protectedinherited

If needRecalc() returns true, getValues(double) updates the probeValues buffer (by calling calcValues) and sets lastUpdateTime to the timevalue input argument.

Definition at line 329 of file BaseProbe.cpp.

double* PV::BaseProbe::getValuesBuffer ( )

inlineprotectedinherited

Returns a pointer to the buffer containing the probeValues.

Definition at line 319 of file BaseProbe.hpp.

int PV::BaseProbe::initMessage ( const char * msg )

protectedvirtualinherited

The method called by BaseProbe::initialize() to set the message used by the probe's outputState method.

Definition at line 282 of file BaseProbe.cpp.

void PV::BaseProbe::initNumValues ( )

protectedvirtualinherited

initNumValues is called by initialize. BaseProbe::initNumValues sets numValues to the parent HyPerCol's getNBatch(). Derived classes can override initNumValues to initialize numValues to a different value.

Reimplemented in PV::PointProbe, PV::StatsProbe, PV::KernelProbe, and PV::PointLIFProbe.

Definition at line 219 of file BaseProbe.cpp.

void PV::BaseProbe::initOutputStreams	(	const char *	filename,
		Checkpointer *	checkpointer
	)

protectedvirtualinherited

Called by registerData. If the MPIBlock row index and column index are zero, this method sets a vector of PrintStreams whose size is the local batch width. If probeOutputFile is being used, the elements of the vector are FileStreams with filenames based on probeOutputFile: the global batch index will be inserted in the probeOutputFile before the extension (or at the end if there is no extension). If the MPIBlock row and column indices are not both zero, the vector of PrintStreams will be empty - these processes should communicate with the row=0,column=0 as needed.

Reimplemented in PV::ColProbe, PV::BaseConnectionProbe, and PV::PointProbe.

Definition at line 174 of file BaseProbe.cpp.

virtual void PV::FirmThresholdCostFnLCAProbe::ioParam_coefficient ( enum ParamsIOFlag ioFlag )

inlineoverrideprotectedvirtual

FirmThresholdCostFnLCAProbe does not read coefficient from params, but computes it from VThresh of the target layer.

Reimplemented from PV::BaseProbe.

Definition at line 41 of file FirmThresholdCostFnLCAProbe.hpp.

void PV::AbstractNormProbe::ioParam_maskLayerName ( enum ParamsIOFlag ioFlag )

protectedvirtualinherited

maskLayerName: Specifies a masking layer to use when calculating the norm. When blank (the default), masking is not used.

The motivation for maskLayerName is to use a layer of ones and zeros to mask out do-not-care regions when computing the norm. Note that for reasons of computation speed, it is up to derived classes to take masking into account when implementing getValueInternal(). The maskLayerName must refer to a layer in the HyPerCol with the same nxScale and nyScale as the probe's targetLayer, and have either the same number of features or a single feature.

Definition at line 53 of file AbstractNormProbe.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::FirmThresholdCostFnProbe::ioParamsFillGroup ( enum ParamsIOFlag ioFlag )

overrideprotectedvirtualinherited

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::AbstractNormProbe.

Definition at line 34 of file FirmThresholdCostFnProbe.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.

bool PV::BaseProbe::isWritingToFile ( ) const

inlineprotectedinherited

Returns true if a probeOutputFile is being used. Otherwise, returns false (indicating output is going to getOutputStream().

Definition at line 330 of file BaseProbe.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.

bool PV::AbstractNormProbe::maskHasSingleFeature ( )

inlineprotectedinherited

Returns true if masking is used and the layer has multiple features but the masking layer has a single feature. In this case it is expected that the single masking feature will be applied to all layer features. Not reliable until communicateInitInfo() has been called.

Definition at line 123 of file AbstractNormProbe.hpp.

bool PV::LayerProbe::needRecalc ( double timevalue )

overrideprotectedvirtualinherited

Implements the needRecalc method. Returns true if the target layer's getLastUpdateTime method is greater than the probe's lastUpdateTime member variable.

Implements PV::BaseProbe.

Reimplemented in PV::StatsProbe.

Definition at line 77 of file LayerProbe.cpp.

bool PV::BaseProbe::needUpdate	(	double	time,
		double	dt
	)

protectedvirtualinherited

If there is a triggering layer, needUpdate returns true when the triggering layer's nextUpdateTime, modified by the probe's triggerOffset parameter, occurs; otherwise false. If there is not a triggering layer, needUpdate always returns true. This behavior can be overridden if a probe uses some criterion other than triggering to choose when output its state.

Reimplemented in PV::AdaptiveTimeScaleProbe.

Definition at line 313 of file BaseProbe.cpp.

PrintStream& PV::BaseProbe::output ( int b )

inlineprotectedinherited

Returns a reference to the PrintStream for the given batch element

Definition at line 291 of file BaseProbe.hpp.

Response::Status PV::AbstractNormProbe::outputState ( double timevalue )

overrideprotectedvirtualinherited

Implements the outputState method required by classes derived from BaseProbe. Prints to the outputFile the probe message, timestamp, number of neurons, and norm value for each batch element.

Implements PV::BaseProbe.

Definition at line 150 of file AbstractNormProbe.cpp.

Response::Status PV::BaseProbe::outputStateWrapper	(	double	timef,
		double	dt
	)

virtualinherited

The public interface for calling the outputState method. BaseConnection::outputStateWrapper calls outputState() if needUpdate() returns true. This behavior is intended to be general, but the method can be overridden if needed.

Definition at line 358 of file BaseProbe.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.

double PV::LayerProbe::referenceUpdateTime ( ) const

overrideprotectedvirtualinherited

Implements the referenceUpdateTime method. Returns the last update time of the target layer.

Implements PV::BaseProbe.

Definition at line 81 of file LayerProbe.cpp.

Response::Status PV::BaseProbe::registerData ( Checkpointer * checkpointer )

overridevirtualinherited

Called during HyPerCol::run, during the allocateDataStructures stage. BaseProbe::allocateDataStructures sets up the output stream. Derived classes that override this method should make sure to call this method in their own allocateDataStructures methods.

Reimplemented from PV::CheckpointerDataInterface.

Reimplemented in PV::AdaptiveTimeScaleProbe, PV::BaseConnectionProbe, and PV::StatsProbe.

Definition at line 320 of file BaseProbe.cpp.

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.

int PV::FirmThresholdCostFnProbe::setNormDescription ( )

overrideprotectedvirtualinherited

Overrides AbstractNormProbe::setNormDescription() to set normDescription to "Cost function". Return values and errno are set by a call to setNormDescriptionToString.

Reimplemented from PV::AbstractNormProbe.

Definition at line 51 of file FirmThresholdCostFnProbe.cpp.

int PV::AbstractNormProbe::setNormDescriptionToString ( char const * s )

protectedinherited

A generic method for setNormDescription() implementations to call. It frees normDescription if it has already been set, and then copies the string in the input argument to the normDescription member variable. It returns PV_SUCCESS or PV_FAILURE; on failure it sets errno.

Definition at line 131 of file AbstractNormProbe.cpp.

void PV::BaseProbe::setNumValues ( int n )

protectedinherited

Sets the numValues member variable (returned by getNumValues()) and reallocates the probeValues member variable to hold numValues double-precision values. If the reallocation fails, the probeValues buffer is left unchanged, errno is set (by a realloc() call), and PV_FAILURE is returned. Otherwise, PV_SUCCESS is returned.

Definition at line 221 of file BaseProbe.cpp.

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:

OpenPV/src/probes/FirmThresholdCostFnLCAProbe.hpp
OpenPV/src/probes/FirmThresholdCostFnLCAProbe.cpp

AbstractNormProbe Parameters

BaseProbe Parameters

FirmThresholdCostFnProbe Parameters

LayerProbe Parameters

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Function Documentation