---

NeuralRegionManager Class Reference

#include <neuralregionmanager.h>

Collaboration diagram for NeuralRegionManager:

[legend]List of all members.

---

Detailed Description

Manages housekeeping such as plotting and analysis for a NeuralRegion.

Definition at line 19 of file neuralregionmanager.h.

Public Types
typedef Plot::PlotSpecification< NeuralRegion::MapBaseType, bStr, Scale::Linear<>, NeuralRegion::Table >	PlotSpec
	Table holding lists of items to plot.
typedef std::vector< PlotSpec * >	PlotSpecList
typedef PointerMap< PlotSpecList >	PlotSpecListTable
Public Methods
	NeuralRegionManager (NeuralRegion *region, ParamMap &params_, bool owns_params=true, const bool register_maps=true)
	Constructor.
void	map_add (const string &name, NeuralRegion::MapBaseType *map)
	Add the given map to the list of ones available, overwriting any old one with that name.
virtual PlotSpecList::const_iterator	plotspeclist_begin (const string &group) const
	Iterator for PlotSpecs.
virtual PlotSpecList::const_iterator	plotspeclist_end (const string &group) const
	Iterator for PlotSpecs.
PlotSpec *	define_plot (const string &group, cStr &plotname, cStr &strength, cStr &color="", cStr &confidence="")
	Define a new plot with the given named maps.
bool	add_maps_for_unit (PlotSpec::MatrixTable &maptable, const PlotSpec &spec, const int ui, const int uj) const
	Add maps for the given unit to the given MatrixTable, returning true on success.
bool	add_maps_for_unit (PlotSpec::MatrixTable &maptable, const string &weightname, const string &mapname, const PlotSpec &spec, const int ui, const int uj) const
Scale::Linear< double >	weight_scale (const PlotSpec &spec, const Weights &weights, int reference_count=-1) const
	Figure out the appropriate weight scale for the given unit.
NeuralRegion *	region ()
	Returns a pointer to the NeuralRegion managed by this object.
const NeuralRegion *	region () const
	Returns a const pointer to the NeuralRegion managed by this object.
InternalNeuralRegion *	internalregion ()
	If the region managed is an InternalNeuralRegion, returns a pointer of that type to the NeuralRegion managed by this object (otherwise 0).
const InternalNeuralRegion *	internalregion () const
	Const version of internalregion().
PlotSpec *	add_input (const string &name, NeuralRegionManager &upstream_manager, InternalNeuralRegion::WeightFunction &fn, NeuralRegion::Length size_scale=1.0)
	Declare that the given region gives input to this region.
int	default_ui () const
	Returns a default unit valid for this region.
int	default_uj () const
ParamMap &	param_map ()
const ParamMap &	param_map () const
Static Public Methods
void	message (Msg::MessageLevel m, const string &s)

---

Constructor & Destructor Documentation

NeuralRegionManager::NeuralRegionManager (  NeuralRegion *    region, ParamMap &    params_, bool    owns_params = true, const bool    register_maps = true )  [inline]

Constructor. If present, params_ should be allocated, as it will be deleted on destruction. If register_maps is true, all the maps defined by the region will be registered in alphabetical order to plot in the Activity plot_group, followed by a plot of the map Activity. Definition at line 33 of file neuralregionmanager.h. References NeuralRegion::backprojection(), NeuralRegion::const_activity(), define_plot(), NeuralRegion::is_internal(), NeuralRegion::is_plastic(), NeuralRegion::residual_activity(), ParameterMap< ParamT >::set_local(), HasTable< mat::MatrixInterface< Bounded::Magnitude > >::table(), HasTable< mat::MatrixInterface< Bounded::Magnitude > >::table_set(), and OwningPointer< ParamMap >::valueptr().

---

Member Function Documentation

PlotSpec* NeuralRegionManager::add_input (  const string &    name, NeuralRegionManager &    upstream_manager, InternalNeuralRegion::WeightFunction &    fn, NeuralRegion::Length    size_scale = 1.0 )  [inline]

Declare that the given region gives input to this region. The connections will have the given name. Accepts a unary function of size_scale to initialize the weights. Returns the PlotSpec defined for this input, if any, so that the parameters of the plot can be controlled externally. Definition at line 222 of file neuralregionmanager.h. References InternalNeuralRegion::add_input(), define_plot(), internalregion(), newPlotSpec(), and region().

PlotSpec* NeuralRegionManager::define_plot (  const string &    group, cStr &    plotname, cStr &    strength, cStr &    color = "", cStr &    confidence = "" )  [inline]

Define a new plot with the given named maps. Returns a pointer to the constructed specification. Definition at line 92 of file neuralregionmanager.h. Referenced by add_input(), and NeuralRegionManager().

void NeuralRegionManager::map_add (  const string &    name, NeuralRegion::MapBaseType *    map )  [inline]

Add the given map to the list of ones available, overwriting any old one with that name. The pointer should be allocated using new, since it will be deleted when this object is destroyed. Definition at line 66 of file neuralregionmanager.h. References NeuralRegion::const_activity(), mat::MatrixInterface< T >::ncols(), mat::MatrixInterface< T >::nrows(), and HasTable< mat::MatrixInterface< Bounded::Magnitude > >::table_set(). Referenced by StimulusParameterMapsForRegion< MapType, MapBaseType, ValuePointer >::register_maps().

Scale::Linear<double> NeuralRegionManager::weight_scale (  const PlotSpec &    spec, const Weights &    weights, int    reference_count = -1 )  const [inline]

Figure out the appropriate weight scale for the given unit. If the reference count is greater than zero, it will be used for count-based scale types instead of the actual count of the number of active units. Definition at line 134 of file neuralregionmanager.h. References WeightSet< MatrixT, BoundsT, MapBaseType, MapType >::bounds(), mat::elem(), Plot::PlotSpecification< Matrix, String, ScaleType, MatrixTableType, ParameterMapType >::lookup_param(), and WeightSet< MatrixT, BoundsT, MapBaseType, MapType >::matrix().

---

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

• neuralregionmanager.h

---