PetaVision  Alpha
 All Data Structures Namespaces Functions Variables
PV::AbstractNormProbe Class Referenceabstract

#include <AbstractNormProbe.hpp>

Inheritance diagram for PV::AbstractNormProbe:
PV::LayerProbe PV::BaseProbe PV::BaseObject PV::FirmThresholdCostFnProbe PV::L0NormProbe PV::L1NormProbe PV::L2NormProbe PV::FirmThresholdCostFnLCAProbe PV::L0NormLCAProbe PV::L1NormLCAProbe

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.
virtual void ioParam_coefficient (enum ParamsIOFlag ioFlag)
 coefficient: If energyProbe is set, the coefficient parameter specifies that ColumnEnergyProbe multiplies the result of this probe's getValues() method by coefficient when computing the error. More...

LayerProbe Parameters

List of parameters for the LayerProbe class

virtual void ioParam_targetName (enum ParamsIOFlag ioFlag)
 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

 AbstractNormProbe (const char *probeName, HyPerCol *hc)
virtual int allocateDataStructures ()
double getCoefficient ()
char const * getEnergyProbe ()
char const * getKeyword () const
HyPerLayergetMaskLayer ()
char const * getMaskLayerName ()
char const * getName () const
int getNumValues ()
HyPerColgetParent () const
HyPerLayergetTargetLayer ()
const char * getTargetName ()
double getValue (double timevalue, int index)
int getValues (double timevalue, double *valuesVector)
int getValues (double timevalue, std::vector< double > *valuesVector)
int ioParams (enum ParamsIOFlag ioFlag)
virtual bool needUpdate (double time, double dt)
virtual int outputStateWrapper (double timef, double dt)
virtual int writeTimer (std::ostream &stream)

Protected Member Functions

virtual int calcValues (double timeValue)
virtual int communicateInitInfo ()
double getLastUpdateTime ()
const char * getMessage ()
char const * getNormDescription ()
OutStreamgetOutputStream ()
bool getTextOutputFlag () const
virtual double getValueInternal (double timevalue, int index)=0
int getValues (double timevalue)
double * getValuesBuffer ()
int initAbstractNormProbe (const char *probeName, HyPerCol *hc)
int initialize (const char *probeName, HyPerCol *hc)
virtual int initMessage (const char *msg)
virtual int initNumValues ()
virtual int initOutputStream (const char *filename)
virtual int ioParamsFillGroup (enum ParamsIOFlag ioFlag)
bool isWritingToFile () const
bool maskHasSingleFeature ()
virtual bool needRecalc (double timevalue)
std::ostream & output ()
virtual int outputState (double timevalue)
virtual double referenceUpdateTime () const
int setName (char const *name)
virtual int setNormDescription ()
int setNormDescriptionToString (char const *s)
int setNumValues (int n)
int setParent (HyPerCol *hc)

Protected Attributes

double coefficient
char * energyProbe
char * name
char * targetName
bool triggerFlag
char * triggerLayerName
double triggerOffset

Private Member Functions

int initAbstractNormProbe_base ()

Private Attributes

char * maskLayerName
char * normDescription
bool singleFeatureMask
double timeLastComputed

Detailed Description

An abstract layer probe where getValue and getValues return a norm-like quantity where the quantity over the entire column is the sum of subquantities computed over each MPI process.

Derived classes must implement getValueInternal(double, int). Each MPI process should return its own contribution to the norm. getValues() and getValue() call getValueInternal and apply MPI_Allreduce to the result, so that getValueInternal() typically does not have to call any MPI processes.

Definition at line 25 of file AbstractNormProbe.hpp.

Member Function Documentation

int PV::BaseProbe::allocateDataStructures ( )

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 in PV::KernelProbe.

Definition at line 255 of file BaseProbe.cpp.

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

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 112 of file AbstractNormProbe.cpp.

int PV::AbstractNormProbe::communicateInitInfo ( )

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

Reimplemented in PV::FirmThresholdCostFnProbe, PV::FirmThresholdCostFnLCAProbe, PV::L0NormLCAProbe, and PV::L1NormLCAProbe.

Definition at line 57 of file AbstractNormProbe.cpp.

double PV::BaseProbe::getCoefficient ( )

Returns the coefficient if the energy probe is set.

Definition at line 101 of file BaseProbe.hpp.

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

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

Definition at line 96 of file BaseProbe.hpp.

double PV::BaseProbe::getLastUpdateTime ( )

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 289 of file BaseProbe.hpp.

HyPerLayer* PV::AbstractNormProbe::getMaskLayer ( )

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

Definition at line 33 of file AbstractNormProbe.hpp.

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

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

Definition at line 39 of file AbstractNormProbe.hpp.

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

Returns a pointer to the message parameter.

Definition at line 244 of file BaseProbe.hpp.

int PV::BaseProbe::getNumValues ( )

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 71 of file BaseProbe.hpp.

OutStream* PV::BaseProbe::getOutputStream ( )

Returns a pointer to the OutStream used by outputState.

Definition at line 255 of file BaseProbe.hpp.

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

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 91 of file BaseProbe.hpp.

bool PV::BaseProbe::getTextOutputFlag ( ) const

Returns the value of the textOutputFlag parameter

Definition at line 294 of file BaseProbe.hpp.

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

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 343 of file BaseProbe.cpp.

virtual double PV::AbstractNormProbe::getValueInternal ( double  timevalue,
int  index 
protectedpure virtual

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.

Implemented in PV::L2NormProbe, PV::FirmThresholdCostFnProbe, PV::L1NormProbe, and PV::L0NormProbe.

int PV::BaseProbe::getValues ( double  timevalue,
double *  valuesVector 

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 330 of file BaseProbe.cpp.

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

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 338 of file BaseProbe.cpp.

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

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

Definition at line 319 of file BaseProbe.cpp.

double* PV::BaseProbe::getValuesBuffer ( )

Returns a pointer to the buffer containing the probeValues.

Definition at line 282 of file BaseProbe.hpp.

int PV::LayerProbe::initialize ( const char *  probeName,
HyPerCol hc 

Definition at line 41 of file LayerProbe.cpp.

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

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

Definition at line 264 of file BaseProbe.cpp.

int PV::BaseProbe::initNumValues ( )

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::KernelProbe, PV::StatsProbe, and PV::PointLIFProbe.

Definition at line 197 of file BaseProbe.cpp.

void PV::BaseProbe::ioParam_coefficient ( enum ParamsIOFlag  ioFlag)

coefficient: If energyProbe is set, the coefficient parameter specifies that ColumnEnergyProbe multiplies the result of this probe's getValues() method by coefficient when computing the error.

Note that coefficient does not affect the value returned by the getValue() or getValues() method.

Reimplemented in PV::FirmThresholdCostFnLCAProbe, PV::L0NormLCAProbe, and PV::L1NormLCAProbe.

Definition at line 107 of file BaseProbe.cpp.

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

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.

bool PV::BaseProbe::isWritingToFile ( ) const

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

Definition at line 300 of file BaseProbe.hpp.

bool PV::AbstractNormProbe::maskHasSingleFeature ( )

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 111 of file AbstractNormProbe.hpp.

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

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 80 of file LayerProbe.cpp.

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

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.

Definition at line 291 of file BaseProbe.cpp.

std::ostream& PV::BaseProbe::output ( )

Returns a reference to the ostream that outputState writes to.

Definition at line 260 of file BaseProbe.hpp.

int PV::AbstractNormProbe::outputState ( double  timevalue)

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 121 of file AbstractNormProbe.cpp.

int PV::BaseProbe::outputStateWrapper ( double  timef,
double  dt 

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 357 of file BaseProbe.cpp.

double PV::LayerProbe::referenceUpdateTime ( ) const

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

Implements PV::BaseProbe.

Definition at line 84 of file LayerProbe.cpp.

int PV::AbstractNormProbe::setNormDescription ( )

Called during initialization, sets the member variable normDescription. This member variable is used by outputState() when printing the norm value. AbstractNormProbe::setNormDescription calls setNormDescriptionToString("norm") and can be overridden. setNormDescription() returns PV_SUCCESS or PV_FAILURE and on failure it sets errno.

Reimplemented in PV::FirmThresholdCostFnProbe, PV::L0NormProbe, PV::L1NormProbe, and PV::L2NormProbe.

Definition at line 103 of file AbstractNormProbe.cpp.

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

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 107 of file AbstractNormProbe.cpp.

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

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 201 of file BaseProbe.cpp.

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