File MIES_ForeignFunctionInterface.ipf

FFI ACQ4/ZeroMQ accessible functions

Functions

wave FFI_ReturnTPValues()

Function to return Peak Resistance, Steady State Resistance to ACQ4 (Neurophysiology Acquisition and Analysis System. See http://acq4.org/ for more details)

The function will pull the values (PeakResistance, SteadyStateResistance, and TimeStamp) out of the TP storage wave and put them in a 3x8 wave, in a designated location where ACQ4 can then find them

wave FFI_GetAvailableMessageFilters()

Return a text wave with all available message filters for Publisher/Subscriber ZeroMQ sockets.

See also ZeroMQMessageFilters.

Description of all messages:

Name

Description

Publish function

:cpp:var:ZeroMQ_HEARTBEAT

Every 5s for alive check

None

:cpp:var:PRESSURE_STATE_FILTER

Every pressure method change

:cpp:func:PUB_PressureMethodChange

:cpp:var:PRESSURE_SEALED_FILTER

Pressure seal reached

:cpp:func:PUB_PressureSealedState

:cpp:var:PRESSURE_BREAKIN_FILTER

Pressure breakin

:cpp:func:PUB_PressureBreakin

:cpp:var:AUTO_TP_FILTER

Auto TP has finished

:cpp:func:PUB_AutoTPResult

:cpp:var:AMPLIFIER_CLAMP_MODE_FILTER

Clamp mode has changed

:cpp:func:PUB_ClampModeChange

:cpp:var:AMPLIFIER_AUTO_BRIDGE_BALANCE

Amplifier auto bridge balance was activated

:cpp:func:PUB_AutoBridgeBalance

:cpp:var:ANALYSIS_FUNCTION_PB

Pipette in bath analysis function has finished

:cpp:func:PUB_PipetteInBath

:cpp:var:ANALYSIS_FUNCTION_SE

Seal evaluation analysis function has finished

:cpp:func:PUB_SealEvaluation

:cpp:var:ANALYSIS_FUNCTION_VM

True resting memb. potential function is finished

:cpp:func:PUB_TrueRestingMembranePotential

:cpp:var:DAQ_TP_STATE_CHANGE_FILTER

Data acquisition/Test pulse started or stopped

:cpp:func:PUB_DAQStateChange

:cpp:var:ANALYSIS_FUNCTION_AR

Access resistance smoke ana. function has finished

:cpp:func:PUB_AccessResistanceSmoke

:cpp:var:ZMQ_FILTER_TPRESULT_NOW

TP evaluation result (all TPs)

:cpp:func:PUB_TPResult

:cpp:var:ZMQ_FILTER_TPRESULT_1s

TP evaluation result (every 1s)

:cpp:func:PUB_TPResult

:cpp:var:ZMQ_FILTER_TPRESULT_5s

TP evaluation result (every 5s)

:cpp:func:PUB_TPResult

:cpp:var:ZMQ_FILTER_TPRESULT_10s

TP evaluation result (every 10s)

:cpp:func:PUB_TPResult

:cpp:var:ZMQ_FILTER_TPRESULT_NOW_WITH_DATA

TP evaluation result with AD data (all TPs)

:cpp:func:PUB_TPResult

:cpp:var:CONFIG_FINISHED_FILTER

JSON configuration for panel has finished

:cpp:func:PUB_ConfigurationFinished

:cpp:var:AMPLIFIER_SET_VALUE

Amplifier setting was changed through MIES

:cpp:func:PUB_AmplifierSettingChange

:cpp:var:TESTPULSE_SET_VALUE_FILTER

Testpulse setting change

:cpp:func:PUB_TPSettingChange

variable FFI_SetCellElectrodeName(string device, variable headstage, string name)

Set the headstage/cell electrode name.

wave FFI_QueryLogbook(string device, variable logbookType, variable sweepNo, string setting, variable entrySourceType)

Query logbook entries from devices.

This allows to query labnotebook/results entries from associated channels.

See also

GetLockedDevices()

Parameters:
Returns:

Numerical/Textual wave with LABNOTEBOOK_LAYER_COUNT rows or a null wave reference if nothing could be found

wave FFI_QueryLogbookUniqueSetting(string device, variable logbookType, string setting)

Return all unique logbook entries from devices.

See also

GetLockedDevices()

Parameters:

  • device – Name of the hardware device panel,

  • logbookType – One of LBT_LABNOTEBOOK or LBT_RESULTS

  • setting – Name of the entry

Returns:

Numerical/Textual 1D wave or a null wave reference if nothing could be found

variable FFI_SaveDataFolderToHDF5(string filepath, string datafolder)

Save the given permanent Igor Pro datafolder in the HDF5 format into filepath

static variable FFI_SaveDataFolderToHDF5Impl(string filepath, WaveText datafolders)
wave FFI_GetSweepBrowserTitles()

Return the titles of all sweep browser windows.

variable FFI_SavePSXDataFolderToHDF5(string filepath, string winTitle)

Save the psx data of the sweepbrowser with title wintTitle in the HDF5 format into filepath

static variable FFI_TP_DeviceSelectable(string device)

Return 1 if the device can be selected (exists/available), 0 otherwise.

Parameters:

device – [in] Device title, e.g. “ITC1600_Dev_0”

Returns:

1 if selectable, 0 otherwise

std::tuple<variable, string> FFI_StartTestPulse(string device)

Start the test pulse for a device unless it is already running.

Parameters:

device – [in] Device title, e.g. “ITC1600_Dev_0”

Returns:

0 = started now, 1 = already running (ignored), -1 = device unavailable

std::tuple<variable, string> FFI_StopTestPulse(string device)

Stop the test pulse for a device unless it is already stopped.

Parameters:

device – [in] Device title, e.g. “ITC1600_Dev_0”

Returns:

0 = stopped now, 1 = already stopped (ignored), -1 = device unavailable

std::tuple<variable, string> FFI_TestPulseMD(string device, variable action)

Unified API entry point to start or stop the test pulse.

Parameters:

  • device – [in] Device title, e.g. “ITC1600_Dev_0”

  • action – [in] 1 to start, 0 to stop

Returns:

Pass-through of API_StartTestPulse()/API_StopTestPulse() return codes

variable FFI_TestPulseMDSingleResult(string device, variable action)