File MIES_TestPulse.ipf¶

TP Basic Testpulse related functionality

Functions

variable TP_IsValidBaselineFraction(variable value)¶

Check if the value is a valid baseline fraction.

Comment in for debugging of TP_TSAnalysis

For visualising the evaluation ranges from the returned DFREF:

Duplicate/O dfr:data, root:data
Duplicate/O dfr:colors, root:colors

ModifyGraph zColor(data)={colors,*,*,Rainbow,1}

static variable TP_CalculateTestPulseLength(variable pulseDuration, variable baselineFrac)¶

Return the total length of a single testpulse with baseline.

Static on purpose as all users during DAQ/TP should prefer GetTPSettingsCalculated()

Parameters:

pulseDuration – duration of the high portion of the testpulse in points or time
baselineFrac – fraction, not percentage, of the baseline

variable TP_CalculateBaselineFraction(variable pulseDuration, variable totalLength)¶

Inverse function of TP_CalculateTestPulseLength.

Can be used when reconstructing the baseline fraction from epoch information.

variable TP_StoreTP(string device, wave TPWave, variable tpMarker, string hsList)¶

Stores the given TP wave.

The stored test pulse waves will have column dimension labels in the format HS_X.

Parameters:

device – device
TPWave – reference to wave holding the TP data, see GetOscilloscopeWave()
tpMarker – unique number for this set of TPs from all TP channels
hsList – list of headstage numbers in the same order as the columns of TPWave

wave TP_GetStoredTPs(string device, variable tpMarker, variable number)¶

Return a number of consecutive test pulses ending with the TP identified by tpMarker.

The wave reference wave will have as many columns as active headstages were used.

variable TP_SplitStoredTestPulseWave(string device)¶: Split the stored testpulse wave reference wave into single waves for easier handling.

variable TP_ROAnalysis(dfref dfr, variable err, string errmsg)¶

Receives data from the async function TP_TSAnalysis(), buffers partial results and puts complete results back to main thread, results are base line level, steady state resistance, instantaneous resistance and their positions collected results for all channels of a measurement are send to TP_RecordTP(), DQ_ApplyAutoBias() when complete.

Parameters:

dfr – output data folder from ASYNC frame work with results from workloads associated with this registered function The output parameter in the data folder follow the definition as created in TP_TSAnalysis()
err – error code of TP_TSAnalysis() function
errmsg – error message of TP_TSAnalysis() function

static wave TP_CreateOverrideResults(string device, variable type)¶

static wave TP_GetTPWaveForAutoTP(string device, variable marker)¶

Return a 2D wave with two testpulses concatenated.

Rows:

TPs

Columns:

Active headstages

static variable TP_AutoBaseline(string device, variable headstage, wave TPResults, wave TPs)¶

static std::tuple<variable, variable, variable> TP_AutoFitBaseline(wave data, variable pulseLengthMS)¶

Fit the tail of the first TP with an expontential and return it’s time constant.

///
///        +----+        +----+
///        |    |        |    |
///        |    |        |    |
///        |    |        |    |
///        |    |        |    |
///    ----+    +--------+    +----
///
///             <-------->
///            Fitting range
///
///    <------------>
///        One TP
///
///        <---->
///        Pulse
///
///

@param data          input data
@param pulseLengthMS length of the pulse (high part) of the testpulse [ms]

@retval result       One of @ref TPBaselineFitResults
@retval tau          time constant of the decay [ms]
@retval baseline     baseline length of one pulse (same as the fitting range) [ms]

static variable TP_AutoAmplitudeAndBaseline(string device, wave TPResults, variable marker)¶

Automatically tune the Testpulse amplitude and baseline.

Decision logic flowchart:

variable TP_AutoTPActive(string device)¶

static variable TP_AutoTPTurnOff(string device, wave autoTPEnable, variable headstage, variable QC)¶

static variable TP_AutoDisableIfFinished(string device, wave TPStorage)¶: Disable Auto TP if it passed TP_AUTO_TP_CONSECUTIVE_PASSES times in a row.

variable TP_AutoTPGenerateNewCycleID(string device, variable headstage = defaultValue, variable first = defaultValue, variable last = defaultValue)¶

Generate new auto TP cycle IDs.

This is required everytime we lock a device or toggle Auto TP for a headstage

Parameters:

device – device
headstage – [optional, default to all headstages] only update it for a specific headstage
first – [optional, default to all headstages] only update the range [first, last]
last – [optional, default to all headstages] only update the range [first, last]

wave TP_GetValuesFromTPStorage(wave TPStorage, variable headstage, string entry, variable numReqEntries, variable options = defaultValue)¶

Return the last numReqEntries non-NaN values from layer entry of headstage

Parameters:

TPStorage – TP results wave, see GetTPStorage()
headstage – Headstage
entry – Name of the value to search
numReqEntries – Number of entries to return, supports integer values and inf
options – [optional, default to nothing] One of TPStorageQueryingOptions

dfref TP_TSAnalysis(dfref dfrInp)¶

This function analyses a TP data set. It is called by the ASYNC frame work in an own thread. currently six properties are determined.

Parameters:: dfrInp – input data folder from the ASYNC framework, parameter input order therein follows the setup in TP_SendToAnalysis()

static variable TP_CalculateAverage(wave TPResultsBuffer, wave TPResults)¶: Calculates running average [box average] for all entries and all headstages.

static variable TP_RecordTP(string device, wave TPResults, variable now, variable tpMarker)¶

Records values from TPResults into TPStorage at defined intervals.

Used for analysis of TP over time.

static variable TP_FitResistance(wave TPStorage, variable startRow, variable endRow, variable headstage)¶: Threadsafe wrapper for performing CurveFits on the TPStorage wave.

static variable TP_AnalyzeTP(string device, WaveOrNull TPStorage, variable endRow)¶

Determine the slope of the steady state resistance over a user defined window (in seconds)

Parameters:

device – locked device string
TPStorage – test pulse storage wave
endRow – last valid row index in TPStorage

variable TP_StopTestPulseOnAllDevices()¶: Stop running background testpulse on all locked devices.

variable TP_StopTestPulseFast(string device)¶

File MIES_TestPulse.ipf¶

Table of Contents

Previous topic

Next topic