File MIES_WaveBuilder.ipf¶

WB Stimulus set creation

Constants for WB_GetControlWithDeltaIdx

The numeric values are row indizes in the waves returned by WB_GetControlWithDeltaWvs().

static const double WB_IDX_DURATION = 0¶

static const double WB_IDX_AMPLITUDE = 2¶

static const double WB_IDX_OFFSET = 4¶

static const double WB_IDX_SIN_CHIRP_SAW_FREQUENCY = 6¶

static const double WB_IDX_TRAIN_PULSE_DURATION = 8¶

static const double WB_IDX_PSC_EXP_RISE_TIME = 10¶

static const double WB_IDX_PSC_EXP_DECAY_TIME_1_2 = 12¶

static const double WB_IDX_PSC_EXP_DECAY_TIME_2_2 = 14¶

static const double WB_IDX_PSC_RATIO_DECAY_TIMES = 16¶

static const double WB_IDX_LOW_PASS_FILTER_CUT_OFF = 20¶

static const double WB_IDX_HIGH_PASS_FILTER_CUT_OFF = 22¶

static const double WB_IDX_CHIRP_END_FREQUENCY = 24¶

static const double WB_IDX_NOISE_FILTER_ORDER = 26¶

static const double WB_IDX_PT_FIRST_MIXED_FREQUENCY = 28¶

static const double WB_IDX_PT_LAST_MIXED_FREQUENCY = 30¶

static const double WB_IDX_NUMBER_OF_PULSES = 45¶

static const double WB_IDX_ITI = 99¶

Functions that build wave types

static variable WB_SquareSegment(SegmentParameters *pa)¶

static variable WB_RampSegment(SegmentParameters *pa)¶

variable WB_IsValidCutoffFrequency(variable freq)¶: Check if the given frequency is a valid setting for the noise epoch.

variable WB_IsValidScaledCutoffFrequency(variable freq)¶

Check if the given frequency is a valid setting for the noise epoch.

Requires a scaled frequency as input, see DisplayHelpTopic "FilterIIR"

static variable WB_NoiseSegment(SegmentParameters *pa)¶

static std::tuple<variable, variable> WB_TrigGetBoundsForInflectionPoints(SegmentParameters *pa, variable offset)¶

static variable WB_CheckTrigonometricSegmentParameters(SegmentParameters *pa)¶

static std::tuple<WaveDouble, WaveDouble> WB_TrigCalculateInflectionPoints(SegmentParameters *pa, variable k0, variable k1, variable k2, variable k3)¶

Calculate the x values where the trigonometric epoch has inflection points.

For zero offset, the inflection points coincide with the zero crossings/roots. In case nothing can be calculated the inflectionPoints wave has one NaN entry.

The formula without chirp can be solved for \(f(x) == 0\) as:

\[\begin{split}f(x) &= a \cdot \sin(k_0 \cdot x) \\ k_0 \cdot x &= c \cdot \pi \\ x &= \frac{c \cdot \pi}{k_0}\end{split}\]

And for cosine:

\[x = \frac{(c + \frac{1}{2}) \cdot \pi}{k_0}\]

With chirp and sine:

\[\begin{split}f(x) &= a \cdot \sin(k_2 \cdot e^{k_1 \cdot x}- k_3) \\ k_2 \cdot e^{k_1 \cdot x} - k_3 &= c \cdot \pi \\ e^{k_1 \cdot x} &= \frac{c \cdot \pi + k_3}{k_2} \\ k_1 \cdot x &= \ln\left(\frac{c \cdot \pi + k_3}{k_2}\right) \\ x &= \frac{1}{k_1} \cdot \ln\left(\frac{c \cdot \pi + k_3}{k_2}\right)\end{split}\]

And analogous for cosine:

\[x = \frac{1}{k_1} \cdot \ln\left(\frac{(c + \frac{1}{2}) \cdot \pi + k_3}{k_2}\right)\]

static std::tuple<WaveDouble, WaveDouble> WB_TrigSegment(SegmentParameters *pa)¶

static variable WB_SawToothSegment(SegmentParameters *pa)¶

static variable WB_CreatePulse(wave wv, variable pulseType, variable amplitude, variable first, variable last)¶

string WB_ToEpochTypeString(variable epochType)¶: Convert the numeric epoch type to a stringified version.

variable WB_ToEpochType(string epochTypeStr)¶: Convert the stringified epoch type to a numerical one.

string WB_GetWaveNoteEntry(string text, variable entryType, string key = defaultValue, variable sweep = defaultValue, variable epoch = defaultValue)¶

Query stimset wave note entries.

Format of the wave note:

The wave note version is tracked through STIMSET_NOTE_VERSION

Lines separated by \r (carriage return) in UTF-8 encoding. The lines hold Igor Pro style key value pairs in the form key = value; where value can contain any character except ; (semicolon).

Four types of entries can be distinguished:

Version: In the very first line (line 1)
Sweep specific entries have an epoch of nan: (line 2, 7)
Epoch specific: (line 3 - 6)
Stimset specific: (line 12)

Additional infos on selected entries: - ITI is in seconds - Flipping is done on a per stimset basis - Durations are in stimset build ms - Pulse Train Pulses are absolute pulse starting times in epoch build ms - Pulse To Pulse Length is in stimset build ms - Function params (encoded) contains the analysis function parameters. The values have the format described at GetWaveBuilderWaveTextParam(). - Inflection Points are in epoch build ms. For offset zero these coincide with the roots.

Added with version 10:

start and end indices for pulses in pulse trains (end index is part of the pulse)
length of each segment
inflection point positions (left side index)

Example:

Version = 2;
Sweep = 0;Epoch = nan;ITI = 1;
Sweep = 0;Epoch = 0;Type = Square pulse;Duration = 500;Amplitude = 0;
Sweep = 0;Epoch = 1;Type = Ramp;Duration = 150;Amplitude = 1;Offset = 0;
Sweep = 0;Epoch = 2;Type = Square pulse;Duration = 300;Amplitude = 0;
Sweep = 0;Epoch = 3;Type = Pulse Train;Duration = 960.005;Amplitude = 1;Offset = 0;Pulse Type = Square;Frequency = 20;Pulse To Pulse Length = 50;Pulse duration = 10;Number of pulses = 20;Mixed frequency = False;First mixed frequency = 0;Last mixed frequency = 0;Poisson distribution = False;Random seed = 0.963638;Pulse Train Pulses = 0,50,100,150,200,250,300,350,400,450,500,550,600,650,700,750,800,850,900,950,;Definition mode = Duration;
Sweep = 1;Epoch = nan;ITI = 2;
Sweep = 1;Epoch = 0;Type = Square pulse;Duration = 500;Amplitude = 0;
Sweep = 1;Epoch = 1;Type = Ramp;Duration = 150;Amplitude = 1;Offset = 0;
Sweep = 1;Epoch = 2;Type = Square pulse;Duration = 300;Amplitude = 0;
Sweep = 1;Epoch = 3;Type = Pulse Train;Duration = 960.005;Amplitude = 1;Offset = 0;Pulse Type = Square;Frequency = 20;Pulse To Pulse Length = 50;Pulse duration = 10;Number of pulses = 20;Mixed frequency = False;First mixed frequency = 0;Last mixed frequency = 0;Poisson distribution = False;Random seed = 0.963638;Pulse Train Pulses = 0,50,100,150,200,250,300,350,400,450,500,550,600,650,700,750,800,850,900,950,;Definition mode = Duration;
Stimset;Sweep Count = 2;Epoch Count = 4;Pre DAQ = ;Mid Sweep = ;Post Sweep = ;Post Set = ;Post DAQ = ;Pre Sweep = ;Generic = PSQ_Ramp;Pre Set = ;Function params (encoded)= NumberOfSpikes:variable=5,Elements:string=%20%3B%2C;Flip = 0;Random Seed = 0.963638;Wavebuilder Error = 0;Checksum = 65446509;

Parameters:

text – stimulus set wave note
entryType – one of StimsetWaveNoteEntryTypes
key – [optional] named entry to return, not required for VERSION_ENTRY
sweep – [optional] number of the sweep
epoch – [optional] number of the epoch

variable WB_GetWaveNoteEntryAsNumber(string text, variable entryType, string key = defaultValue, variable sweep = defaultValue, variable epoch = defaultValue)¶

wave WB_GetPulsesFromPTSweepEpoch(wave stimset, variable sweep, variable epoch, variable *pulseToPulseLength)¶

Return pulse information from a pulse train epoch.

Parameters:

stimset – [in] stimulus set
sweep – [in] sweep of the set
epoch – [in] epoch of the set
pulseToPulseLength – [out] pulse to pulse length [ms]

Returns:

pulse train starting times [ms]

wave WB_GetInflectionPoints(string stimNote, variable sweep, variable epoch)¶: Return the inflection points for trigonometric epochs.

static std::tuple<WaveDouble, WaveDouble, WaveDouble, variable> WB_PulseTrainSegment(SegmentParameters *pa, variable mode)¶

static variable WB_PSCSegment(SegmentParameters *pa)¶

static variable WB_CustomWaveSegment(SegmentParameters *pa, wave customWave)¶

static wave WB_FillWaveFromFormula(string formula, variable channelType, variable sweep)¶: Create a wave segment as combination of existing stim sets.

Functions

wave WB_CreateAndGetStimSet(string setName)¶

Return the stim set wave and create it permanently in the datafolder hierarchy.

Returns:: stimset wave ref or an invalid wave ref

string WB_GetParameterWaveName(string stimset, variable type, variable nwbFormat = defaultValue)¶

Return the name of one of the three stimset parameter waves.

Parameters:

stimset – name of stimset
type – indicate parameter wave (WP, WPT, or SegWvType), see ParameterWaveTypes
nwbFormat – [optional, defaults to false] nwbFormat has type as suffix

Returns:

name as string

wave WB_GetWaveParamForSet(string setName)¶

Return the wave WP for a stim set.

Returns:: valid/invalid wave reference

wave WB_GetWaveTextParamForSet(string setName)¶

Return the wave WPT for a stim set.

Returns:: valid/invalid wave reference

wave WB_GetSegWvTypeForSet(string setName)¶

Return the wave SegmentWvType for a stim set.

Returns:: valid/invalid wave reference

static variable WB_StimsetNeedsUpdate(string setName)¶

Check if stimset needs to be created.

Stimset is recreated

if one of the parameter waves was modified
the custom wave that was used to build the stimset was modified

Returns:: 1 if stimset needs to be recreated, 0 otherwise

static variable WB_StimsetHasLatestNoteVersion(string setName)¶: Check if the stimset wave note has the latest version.

static variable WB_ParameterWvsNewerThanStim(string setName)¶

Check if parameter waves’ are newer than the saved stimset.

Parameters:: setName – string containing name of stimset
Returns:: 1 if Parameter waves were modified, 0 otherwise

variable WB_GetStimsetChecksum(wave stimset, string setName, variable dataAcqOrTP)¶

Return a checksum of the stimsets and its parameter waves.

Uses the entry from the stimset wave note if available.

static variable WB_CalculateStimsetChecksum(wave stimset, string setName)¶: Calculcate the checksum of the stimsets and its parameter waves.

variable WB_GetLastModStimSet(string setName)¶

Get modification date of saved stimset wave.

Parameters:: setName – string containing name of stimset
Returns:: date of last modification as double precision Igor date/time value

wave WB_GetStimSetForWaveBuilder()¶: Return the current stimset wave for the wavebuilder.

static wave WB_GetStimSet(string setName = defaultValue)¶

Return the stim set wave.

As opposed to WB_CreateAndGetStimSet this function returns a free wave only

Parameters:: setName – [optional, defaults to WaveBuilderPanel GUI settings] name of the set
Returns:: free wave with the stim set, invalid wave ref if the WP* parameter waves could not be found.

static wave WB_GetControlWithDeltaIdx()¶

Return a free wave with indizes referencing the values with delta values.

Indizes are into WP

and reference the entry with the value itself.

Constants are defined at

ControlDeltaIndizes.

File MIES_WaveBuilder.ipf¶

Table of Contents

Previous topic

Next topic