Image Component Library (ICL)
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Types | Public Member Functions | Public Attributes
icl::math::SOM::Neuron Struct Reference

SOM internal Neuron struct. More...

#include <SOM.h>

List of all members.

Public Types

typedef utils::SmartPtr< float > vector_type

Public Member Functions

 Neuron ()
 create a null neuron
 Neuron (vector_type gridpos, vector_type prototype, unsigned int griddim, unsigned int datadim)
 create a new neurons with given pointers and dimensions
bool isNull () const
 returns whether this neuron is already initialized (i.e. has valid pointers)

Public Attributes

vector_type gridpos
 grid position vector of dim "griddim"
vector_type prototype
 prototype vector of dim "datadim"
unsigned int griddim
 grid dimension
unsigned int datadim
 prototype dimension
void * meta
 meta-data storage pointer

Detailed Description

SOM internal Neuron struct.

The SOM Neuron struct is defined by grid-location vector and prototype vector. In addition, each neuron has a void* meta, that can be used to associate some meta-data with a certain neuron (Note,the pointer meta is not released automatically).


Member Typedef Documentation


Constructor & Destructor Documentation

create a null neuron

icl::math::SOM::Neuron::Neuron ( vector_type  gridpos,
vector_type  prototype,
unsigned int  griddim,
unsigned int  datadim 
)

create a new neurons with given pointers and dimensions

If the deepCopyData flag is set to true, internally new prototype and gridpos pointers are allocated and filled with the given pointer's data. Otherwise, the ownership of the given pointers is passed to the this neuron.


Member Function Documentation

bool icl::math::SOM::Neuron::isNull ( ) const [inline]

returns whether this neuron is already initialized (i.e. has valid pointers)


Member Data Documentation

prototype dimension

grid dimension

grid position vector of dim "griddim"

meta-data storage pointer

prototype vector of dim "datadim"


The documentation for this struct was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines