link to homepage

Institute for Neuroscience and Medicine

Navigation and service


API documentation

Signal Class Reference

The signal store and IO. More...

#include <Signal.h>

Collaboration diagram for Signal:

List of all members.

Public Member Functions

 Signal ()
virtual ~Signal ()
 Signal (long size)
void DumpTo (string fname, bool normalize=true)
void ReadFrom (char *fname)
long GetSize ()
void InitRandGenerator (int val=1)

Public Attributes

Repository repository
 Signal repository.

Detailed Description

The signal store and IO.

Definition at line 48 of file Signal.h.


Constructor & Destructor Documentation

Signal::Signal (  )  [inline]

Default constructor

Definition at line 56 of file Signal.h.

Signal::~Signal (  )  [virtual]

Destructor

Definition at line 36 of file Signal.cpp.

References Repository::mx, Repository::my, Repository::mz, repository, and Repository::tp.

Signal::Signal ( long  size  ) 

Instatiate a signal object of given size

Parameters:
size Number of signal definition points

Definition at line 46 of file Signal.cpp.

References Repository::mx, Repository::my, Repository::mz, repository, Repository::size, and Repository::tp.


Member Function Documentation

void Signal::DumpTo ( string  fname,
bool  normalize = true 
)

Dump binary data to file

Parameters:
fname File name

Definition at line 84 of file Signal.cpp.

References World::instance(), Repository::mx, Repository::my, Repository::mz, repository, Repository::size, and Repository::tp.

Here is the call graph for this function:

long Signal::GetSize (  )  [inline]

Get the size of the signal.

Returns:
Size of this signa.

Definition at line 90 of file Signal.h.

void Signal::InitRandGenerator ( int  val = 1  )  [inline]

Initialize the randome number generator

Parameters:
val any integer

Definition at line 98 of file Signal.h.

void Signal::ReadFrom ( char *  fname  ) 

Read in binary data from file

Parameters:
fname File name

Definition at line 66 of file Signal.cpp.

References Repository::mx, Repository::my, Repository::mz, repository, Repository::size, and Repository::tp.


Member Data Documentation

Signal repository.

< random number generator

Definition at line 102 of file Signal.h.

Referenced by DumpTo(), ReadFrom(), Coil::Receive(), Signal(), and ~Signal().


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

Servicemeu