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

#include <ColProbe.hpp>

Inheritance diagram for PV::ColProbe:
PV::BaseProbe PV::BaseObject PV::ColumnEnergyProbe PV::QuotientColProbe

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

Public Member Functions

 ColProbe (const char *probeName, HyPerCol *hc)
 
virtual ~ColProbe ()
 
virtual int allocateDataStructures ()
 
virtual int communicateInitInfo ()
 
double getCoefficient ()
 
char const * getEnergyProbe ()
 
char const * getKeyword () const
 
char const * getName () const
 
int getNumValues ()
 
HyPerColgetParent () const
 
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 outputState (double timed)
 
virtual int outputStateWrapper (double timef, double dt)
 
virtual int writeTimer (std::ostream &stream)
 

Protected Member Functions

 ColProbe ()
 
virtual int calcValues (double timevalue)=0
 
double getLastUpdateTime ()
 
const char * getMessage ()
 
OutStreamgetOutputStream ()
 
bool getTextOutputFlag () const
 
int getValues (double timevalue)
 
double * getValuesBuffer ()
 
int initialize (const char *probeName, HyPerCol *hc)
 
virtual int initMessage (const char *msg)
 
virtual int initNumValues ()
 
virtual int initOutputStream (const char *filename)
 
virtual void ioParam_targetName (enum ParamsIOFlag ioFlag)
 targetName: ColProbe overrides targetName since the only possible target is the parent HyPerCol. On reading, it sets targetName. Parameters are neither read nor written by this method.
 
virtual int ioParamsFillGroup (enum ParamsIOFlag ioFlag)
 
bool isWritingToFile () const
 
virtual bool needRecalc (double timevalue)=0
 
std::ostream & output ()
 
virtual int outputHeader ()
 
virtual double referenceUpdateTime () const =0
 
int setName (char const *name)
 
int setNumValues (int n)
 
int setParent (HyPerCol *hc)
 

Protected Attributes

double coefficient
 
char * energyProbe
 
char * name
 
OutStreamoutputStream
 
HyPerColparent
 
char * targetName
 
bool triggerFlag
 
HyPerLayertriggerLayer
 
char * triggerLayerName
 
double triggerOffset
 

Private Member Functions

int initialize_base ()
 

Detailed Description

ColProbe is the base class for probes that are attached to the column as a whole, as opposed to an individual layer or connection. Derived classes must implement the needRecalc and calcValues methods.

The original motivation for ColProbe was for computing total energy of a sparse-coding hierarchy. In this situation, the energy is a sum of contributions from the residual layer and the sparse representation layer, and we need the energy for each element of the batch. The getValues() method would compute the energy for each element of the batch. The getValue() method returns the energy for a single batch element.

A HyPerCol object with dtAdaptFlag set to true and dtAdaptController set to a ColProbe uses a ColProbe::getValues() call to compute the timeScaleTrue buffer.

Definition at line 33 of file ColProbe.hpp.

Constructor & Destructor Documentation

PV::ColProbe::ColProbe ( const char *  probeName,
HyPerCol hc 
)

Public constructor for the ColProbe class.

Definition at line 19 of file ColProbe.cpp.

PV::ColProbe::~ColProbe ( )
virtual

Destructor for the ColumnEnergyProbe class.

Definition at line 24 of file ColProbe.cpp.

PV::ColProbe::ColProbe ( )
protected

The constructor without arguments should be used by derived classes.

Definition at line 13 of file ColProbe.cpp.

Member Function Documentation

int PV::BaseProbe::allocateDataStructures ( )
virtualinherited

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.

virtual int PV::BaseProbe::calcValues ( double  timevalue)
protectedpure virtualinherited

A pure virtual method to calculate the values of the probe. calcValues() can assume that needRecalc() has been called and returned true. It should write the computed values into the buffer of member variable 'probeValues'.

Implemented in PV::QuotientColProbe, PV::AbstractNormProbe, PV::ColumnEnergyProbe, PV::PointProbe, PV::StatsProbe, PV::L2NormProbe, PV::KernelProbe, and PV::PointLIFProbe.

int PV::ColProbe::communicateInitInfo ( )
virtual

Calls BaseProbe::communicateInitInfo (which sets up any triggering or attaching to an energy probe) and then attaches to the parent HyPerCol by calling parent->insertProbe().

Implements PV::BaseProbe.

Reimplemented in PV::QuotientColProbe.

Definition at line 56 of file ColProbe.cpp.

double PV::BaseProbe::getCoefficient ( )
inlineinherited

Returns the coefficient if the energy probe is set.

Definition at line 101 of file BaseProbe.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 96 of file BaseProbe.hpp.

double PV::BaseProbe::getLastUpdateTime ( )
inlineprotectedinherited

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.

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

Returns a pointer to the message parameter.

Definition at line 244 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 71 of file BaseProbe.hpp.

OutStream* PV::BaseProbe::getOutputStream ( )
inlineprotectedinherited

Returns a pointer to the OutStream used by outputState.

Definition at line 255 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 91 of file BaseProbe.hpp.

bool PV::BaseProbe::getTextOutputFlag ( ) const
inlineprotectedinherited

Returns the value of the textOutputFlag parameter

Definition at line 294 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 343 of file BaseProbe.cpp.

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

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

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

double* PV::BaseProbe::getValuesBuffer ( )
inlineprotectedinherited

Returns a pointer to the buffer containing the probeValues.

Definition at line 282 of file BaseProbe.hpp.

int PV::ColProbe::initialize ( const char *  probeName,
HyPerCol hc 
)
protected

Reads the parameters and performs initializations that do not depend on other param groups. It is called by the public constructor and should be called by the initializer of any derived classes.

Definition at line 32 of file ColProbe.cpp.

int PV::ColProbe::initialize_base ( )
private

Initializes member variables to safe values (e.g. pointers are set to NULL). It is called by both the public and protected constructors, and should not otherwise be called.

Definition at line 27 of file ColProbe.cpp.

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

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

Definition at line 197 of file BaseProbe.cpp.

int PV::ColProbe::initOutputStream ( const char *  filename)
protectedvirtual

Calls BaseProbe::initOutputStream and then calls outputHeader()

Reimplemented from PV::BaseProbe.

Definition at line 48 of file ColProbe.cpp.

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

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.

int PV::ColProbe::ioParamsFillGroup ( enum ParamsIOFlag  ioFlag)
protectedvirtual

Reads parameters from the params file/writes parameters to the output params file. If a derived class introduces a new parameter, its ioParamsFillGroup method should call an ioParam_ method for that parameter. If a derived class eliminates a a parameter of the base class, or changes the dependencies of a parameter, it should override the ioParam_ method for that parameter. The derived class's ioParamsFillGroup method should call its base class's ioParamsFillGroup method.

Reimplemented from PV::BaseProbe.

Reimplemented in PV::QuotientColProbe.

Definition at line 37 of file ColProbe.cpp.

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

virtual bool PV::BaseProbe::needRecalc ( double  timevalue)
protectedpure virtualinherited

A pure virtual method for that should return true if the quantities being measured by the probe have changed since the last time the quantities were calculated. Typically, an implementation of needRecalc() will check the lastUpdateTime of the object being probed, and return true if that value is greater than the lastUpdateTime member variable. needRecalc() is called by getValues(double) (and hence by getValue() and the other flavors of getValues). Note that there is a single needRecalc that applies to all getNumValues() quantities.

Implemented in PV::QuotientColProbe, PV::ColumnEnergyProbe, PV::LayerProbe, PV::StatsProbe, and PV::BaseHyPerConnProbe.

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

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 ( )
inlineprotectedinherited

Returns a reference to the ostream that outputState writes to.

Definition at line 260 of file BaseProbe.hpp.

virtual int PV::ColProbe::outputHeader ( )
inlineprotectedvirtual

Called by initialize_stream after opening the stream member variable. Derived classes can override this method to write header data to the output file.

Reimplemented in PV::QuotientColProbe, and PV::ColumnEnergyProbe.

Definition at line 99 of file ColProbe.hpp.

virtual int PV::ColProbe::outputState ( double  timed)
inlinevirtual

The virtual method for outputting the quantities measured by the ColProbe. Derived classes should override this method. Typically, outputState will fprintf to outputstream->fp, where stream is the BaseProbe member variable.

Implements PV::BaseProbe.

Reimplemented in PV::QuotientColProbe, and PV::ColumnEnergyProbe.

Definition at line 56 of file ColProbe.hpp.

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

virtual double PV::BaseProbe::referenceUpdateTime ( ) const
protectedpure virtualinherited

A pure virtual method that should return the simulation time for the values that calcValues() would compute if it were called instead. The reason that this time might be different from the simuluation time at which referenceUpdate was called, is that calcValues might be called either before or after the update of whatever object the probe is attached to.

The getValues() method calls this function after calling calcValues(), and stores the result in the lastUpdateTime member variable. Typically, the implementation of needRecalc() will return true if lastUpdateTime is less than the value returned by referenceUpdateTime, and false otherwise.

Implemented in PV::QuotientColProbe, PV::ColumnEnergyProbe, PV::LayerProbe, and PV::BaseHyPerConnProbe.

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


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