Electric Field Measurement Relacs Plugins  0.9.8
Public Member Functions | List of all members
CalibEField Class Reference

#include <calibefield.h>

Inheritance diagram for CalibEField:
Inheritance graph
[legend]
Collaboration diagram for CalibEField:
Collaboration graph
[legend]

Public Member Functions

 CalibEField (void)
 
 ~CalibEField (void)
 
virtual int main (void)
 
void saveData (const MapD &intensities, const base::LinearAttenuate *latt)
 
void plotGain (const MapD &gainamplitudes, double targetintensity)
 
void plotIntensities (const MapD &intensities, double targetintensity, double maxx)
 
int analyze (const InData &eodtrace, double duration, double beatfrequency, bool usecontrast, double mincontrast, double maxcontrast, double minamplitude, double maxamplitude, double intensity, bool fish, double &amplitude)
 
- Public Member Functions inherited from ConfigDialog
 ConfigDialog (const string &configident="", int configgroup=0, const string &name="", const string &author="", const string &version="", const string &date=__DATE__)
 
virtual ~ConfigDialog (void)
 
string name (void) const
 
virtual void setName (const string &name)
 
string author (void) const
 
virtual void setAuthor (const string &author)
 
string version (void) const
 
virtual void setVersion (const string &version)
 
string date (void) const
 
virtual void setDate (const string &date)
 
virtual OptWidgetdialogOptions (OptDialog *od, string *tabhotkeys=0)
 
virtual void dialogButtons (OptDialog *od)
 
virtual void dialogEmptyMessage (OptDialog *od)
 
int dialogSelectMask (void) const
 
void setDialogSelectMask (int mask)
 
void addDialogSelectMask (int mask)
 
int dialogReadOnlyMask (void) const
 
void setDialogReadOnlyMask (int mask)
 
void addDialogReadOnlyMask (int mask)
 
int dialogStyle (void) const
 
void setDialogStyle (int style)
 
void addDialogStyle (int style)
 
string dialogCaption (void) const
 
void setDialogCaption (const string &caption)
 
bool dialogHeader (void) const
 
void setDialogHeader (bool d)
 
string headerBackgroundColor (void) const
 
void setHeaderBackgroundColor (const string &color)
 
string headerForegroundColor (void) const
 
void setHeaderForegroundColor (const string &color)
 
string headerImageFile (void) const
 
void setHeaderImageFile (const string &file)
 
virtual void dialogHeaderWidget (OptDialog *od)
 
bool dialogHelp (void) const
 
void setDialogHelp (bool d)
 
string helpCaption (void) const
 
void setHelpCaption (const string &caption)
 
string helpPath (int inx=0) const
 
int helpPathes (void) const
 
void clearHelpPathes (void)
 
void setHelpPath (const string &path)
 
void addHelpPath (const string &path)
 
virtual string helpFileName (void) const
 
bool dialogOpen (void) const
 
bool helpOpen (void) const
 
QWidget * mainWidget (void)
 
virtual void setMainWidget (QWidget *widget)
 
void lock () const
 
void unlock () const
 
bool tryLock (int timeout=1)
 
QMutex * mutex (void)
 
- Public Member Functions inherited from ConfigClass
 ConfigClass (const string &ident, int group=0, int mode=0xffff, int selectmask=0)
 
 ConfigClass (const ConfigClass &C)
 
virtual ~ConfigClass (void)
 
const string & configIdent (void) const
 
void setConfigIdent (const string &ident)
 
int configGroup (void) const
 
void setConfigGroup (int group)
 
int configMode (void) const
 
void setConfigMode (int mode)
 
void addConfigMode (int mode)
 
void delConfigMode (int mode)
 
int configSelectMask (void) const
 
void setConfigSelectMask (int mask)
 
void addConfig (void)
 
void readConfig (void)
 
virtual void readConfig (StrQueue &sq)
 
virtual void saveConfig (ofstream &str)
 
virtual int configSize (void) const
 
virtual void config (void)
 
virtual void preConfig (void)
 
- Public Member Functions inherited from Traces
 Traces (void)
 
- Public Member Functions inherited from StandardTraces
 StandardTraces (void)
 
- Public Member Functions inherited from EODTools
 EODTools (void)
 
double eodThreshold (const InData &data, double tbegin, double tend, double contrast=0.2)
 
void eodPeaks (const InData &data, double tbegin, double tend, double threshold, EventData &peaks)
 
void eodTroughs (const InData &data, double tbegin, double tend, double threshold, EventData &troughs)
 
void eodPeaksTroughs (const InData &data, double tbegin, double tend, double threshold, EventData &peaks, EventData &troughs)
 
double meanPeaks (const InData &data, double tbegin, double tend, double threshold)
 
double meanTroughs (const InData &data, double tbegin, double tend, double threshold)
 
double eodAmplitude (const InData &data, double tbegin, double tend)
 
void beatAmplitudes (const InData &eodd, double tbegin, double tend, double period, double contrast, double &uppermean, double &upperampl, double &lowermean, double &lowerampl)
 
double beatAmplitude (const InData &eodd, double tbegin, double tend, double period, double contrast=0.2)
 
double beatContrast (const InData &eodd, double tbegin, double tend, double period, double contrast=0.2)
 

Additional Inherited Members

- Public Types inherited from ConfigClass
enum  Action
 
- Public Slots inherited from ConfigDialog
virtual void dialog (void)
 
virtual void help (void)
 
virtual void notifyDialog (const Options &opt)
 
- Signals inherited from ConfigDialog
void dialogAccepted (void)
 
void dialogAction (int r)
 
void dialogClosed (int r)
 
- Static Public Member Functions inherited from ConfigClass
static void setConfigureClasses (ConfigureClasses *cfg)
 
- Static Public Member Functions inherited from Traces
static void initialize (const RELACSPlugin *rp, const InList &data, const EventList &events)
 
- Protected Slots inherited from ConfigDialog
void notificationFromDialog (const Parameter &p)
 
virtual void dClosed (int r)
 
virtual void hClosed (int r)
 
- Protected Member Functions inherited from ConfigDialog
void setDialogOpen (bool open=true)
 
void setHelpOpen (bool open=true)
 
- Static Protected Member Functions inherited from StandardTraces
static void clearIndices (int *traceindices, int n=-1)
 
static void initStandardTraces (const InList &data, int *ntraces, int *traceindices, const string *names, string &namelist, bool alpha=false)
 
static void initStandardEventTraces (const InList &data, const EventList &events, int *ntraces, int *traceindices, int *eventindices, const string *tracenames, const string *eventnames, string &tracenamelist, string &eventnamelist, bool alpha=false)
 
static void initStandardOutputs (const RELACSPlugin *rp, int *ntraces, int *traceindices, const string *names, string &namelist, bool alpha=false)
 
- Protected Attributes inherited from ConfigDialog
Options DialogOptions
 
- Static Protected Attributes inherited from Traces
static int EODTrace = -1
 
static int EODEvents = -1
 
static int ChirpEvents = -1
 
static int LocalEODTraces = 0
 
static int LocalEODTrace [MaxTraces] = { -1, -1, -1, -1 }
 
static int LocalEODEvents [MaxTraces] = { -1, -1, -1, -1 }
 
static int LocalChirpEvents [MaxTraces] = { -1, -1, -1, -1 }
 
static int LocalBeatPeakEvents [MaxTraces] = { -1, -1, -1, -1 }
 
static int LocalBeatTroughEvents [MaxTraces] = { -1, -1, -1, -1 }
 
static int FishEODTanks = 0
 
static int FishEODTraces [MaxTraces] = { 0, 0, 0, 0 }
 
static int FishEODTrace [MaxTraces][MaxTraces] = { { -1, -1, -1, -1 }, { -1, -1, -1, -1 } }
 
static int FishEODEvents [MaxTraces][MaxTraces] = { { -1, -1, -1, -1 }, { -1, -1, -1, -1 } }
 
static int FishChirpEvents [MaxTraces][MaxTraces] = { { -1, -1, -1, -1 }, { -1, -1, -1, -1 } }
 
static int GlobalEField = -1
 
static int GlobalAMEField = -1
 
static int LocalEFields = 0
 
static int LocalEField [MaxTraces] = { -1, -1, -1, -1 }
 
static int LocalAMEFields = 0
 
static int LocalAMEField [MaxTraces] = { -1, -1, -1, -1 }
 
static int FishEFields = 0
 
static int FishEField [MaxTraces] = { -1, -1, -1, -1 }
 
static int EFields = 0
 
static int EField [2 *MaxTraces] = { -1, -1, -1, -1 }
 
static int GlobalEFieldTrace = -1
 
static int GlobalEFieldEvents = -1
 
static int LocalEFieldTraces = 0
 
static int LocalEFieldTrace [MaxTraces] = { -1, -1, -1, -1 }
 
static int LocalEFieldEvents [MaxTraces] = { -1, -1, -1, -1 }
 
static int FishEFieldTraces = 0
 
static int FishEFieldTrace [MaxTraces] = { -1, -1, -1, -1 }
 
static int FishEFieldEvents [MaxTraces] = { -1, -1, -1, -1 }
 
- Static Protected Attributes inherited from StandardTraces
static const int MaxTraces
 

Detailed Description

[RePro] Calibrates an attenuator for electric field stimuli.

Author
Jan Benda
Version
2.2 (Nov 30, 2013)
Note
Intensity for attenuation is interpreted as 0.5 * p-p amplitude
Calibration non-sine EODs has an offset!
Options
  • reset=false: Reset calibration? (boolean)
  • resetval=0.1: Reset gain factor to (number)
  • am=false: Calibrate amplitude modulation? (boolean)
  • beatfreq=20Hz: Beat frequency to be used when fish EOD present (number)
  • frequency=600Hz: Stimulus frequency to be used when no fish EOD is present (number)
  • duration=400ms: Duration of stimulus (number)
  • pause=0ms: Pause (number)
  • amplsel=contrast: Calibrate for (string)
  • targetcontrast=20%: Target contrast to be tested first (number)
  • mincontrast=10%: Minimum contrast (number)
  • maxcontrast=25%: Maximum contrast (number)
  • targetamplitude=1mV/cm: Target contrast to be tested first (number)
  • minamplitude=0.5mV/cm: Minimum amplitude (number)
  • maxamplitude=2mV/cm: Maximum amplitude (number)
  • numintensities=10: Number of intensities (amplitudes) to be measured (integer)
Files
  • calibrate.dat : the calibration data (measured versus requested stimulus intensity).
Plots
The plot shows the measured versus the requested stimulus intensity (red circles). The yellow line is a fit of a straight line to the data. In case of a successful calibration this line should coincide with the blue line. The horizontal white line is the target intensity.
Requirements
  • An EOD recording (GlobalEOD, LocalEOD, FishEOD), that is to be calibrated, and corresponding events.

Constructor & Destructor Documentation

CalibEField ( void  )
~CalibEField ( void  )

Member Function Documentation

int main ( void  )
virtual
void saveData ( const MapD intensities,
const base::LinearAttenuate *  latt 
)
void plotGain ( const MapD gainamplitudes,
double  targetintensity 
)
void plotIntensities ( const MapD intensities,
double  targetintensity,
double  maxx 
)
int analyze ( const InData eodtrace,
double  duration,
double  beatfrequency,
bool  usecontrast,
double  mincontrast,
double  maxcontrast,
double  minamplitude,
double  maxamplitude,
double  intensity,
bool  fish,
double &  amplitude 
)

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