changes

Packages/MIES/MIES_Constants.ipf

@@ -2311,3 +2311,10 @@ Constant SUTTER_MAX_MAX_TP_PULSES = 10000
 Constant INVALID_SWEEP_NUMBER = -1
 
 StrConstant PERCENT_F_MAX_PREC = "%.15f"
+
+// If this constant with dimLabels is changed the following functions should be verified:
+//
+// TP_TSAnalysis
+// GetTPResultAsyncBuffer
+// GetTPResults (reuses same dimlabels partially)
+StrConstant TP_ANALYSIS_DATA_LABELS = "BASELINE;STEADYSTATERES;INSTANTRES;ELEVATED_SS;ELEVATED_INST;NOW;HEADSTAGE;MARKER;NUMBER_OF_TP_CHANNELS;TIMESTAMP;TIMESTAMPUTC;CLAMPMODE;CLAMPAMP;BASELINEFRAC;CYCLEID;TPLENGTHPOINTSADC;PULSELENGTHPOINTSADC;PULSESTARTPOINTSADC;SAMPLINGINTERVALADC;TPLENGTHPOINTSDAC;PULSELENGTHPOINTSDAC;PULSESTARTPOINTSDAC;SAMPLINGINTERVALDAC;"

Packages/MIES/MIES_MiesUtilities_Conversion.ipf

@@ -270,3 +270,15 @@ Function MapAnaFuncToConstant(anaFunc)
 #endif
 	endswitch
 End
+
+/// @brief returns the unit string for the AD channel depending in clampmode
+Function/S GetADChannelUnit(variable clampMode)
+
+	return SelectString(clampMode == V_CLAMP_MODE, "mV", "pA")
+End
+
+/// @brief returns the unit string for the DA channel depending in clampmode
+Function/S GetDAChannelUnit(variable clampMode)
+
+	return SelectString(clampMode == V_CLAMP_MODE, "pA", "mV")
+End

Packages/MIES/MIES_Oscilloscope.ipf

@@ -479,7 +479,7 @@ Function SCOPE_UpdateOscilloscopeData(device, dataAcqOrTP, [chunk, fifoPos, devi
 
 	STRUCT TPAnalysisInput tpInput
 	variable i, j
-	variable tpChannels, numADCs, numDACs, tpLengthPoints, tpStart, tpEnd, tpStartPos
+	variable tpChannels, numADCs, numDACs, tpLengthPointsADC, tpStart, tpEnd, tpStartPos
 	variable TPChanIndex, saveTP, clampAmp
 	variable headstage, fifoLatest, channelIndex
 	string hsList
@@ -530,10 +530,10 @@ Function SCOPE_UpdateOscilloscopeData(device, dataAcqOrTP, [chunk, fifoPos, devi
 		WAVE TPSettings     = GetTPSettings(device)
 		WAVE TPSettingsCalc = GetTPSettingsCalculated(device)
 
-		tpLengthPoints = (dataAcqOrTP == TEST_PULSE_MODE) ? TPSettingsCalc[%totalLengthPointsTP_ADC] : TPSettingsCalc[%totalLengthPointsDAQ_ADC]
+		tpLengthPointsADC = (dataAcqOrTP == TEST_PULSE_MODE) ? TPSettingsCalc[%totalLengthPointsTP_ADC] : TPSettingsCalc[%totalLengthPointsDAQ_ADC]
 
 		// use a 'virtual' end position for fifoLatest for TP Mode since the input data contains one TP only
-		fifoLatest = (dataAcqOrTP == TEST_PULSE_MODE) ? tpLengthPoints : fifoPos
+		fifoLatest = (dataAcqOrTP == TEST_PULSE_MODE) ? tpLengthPointsADC : fifoPos
 
 		WAVE ADCs   = GetADCListFromConfig(config)
 		WAVE DACs   = GetDACListFromConfig(config)
@@ -544,33 +544,40 @@ Function SCOPE_UpdateOscilloscopeData(device, dataAcqOrTP, [chunk, fifoPos, devi
 		numADCs = DimSize(ADCs, ROWS)
 
 		// note: currently this works for multiplier = 1 only, see DC_PlaceDataInDAQDataWave
-		Make/FREE/N=(tpLengthPoints) channelData
+		Make/FREE/N=(tpLengthPointsADC) channelData
 		WAVE tpInput.data = channelData
 
-		tpInput.device         = device
-		tpInput.duration       = (dataAcqOrTP == TEST_PULSE_MODE) ? TPSettingsCalc[%pulseLengthPointsTP_ADC] : TPSettingsCalc[%pulseLengthPointsDAQ_ADC]
-		tpInput.baselineFrac   = TPSettingsCalc[%baselineFrac]
-		tpInput.tpLengthPoints = tpLengthPoints
-		tpInput.readTimeStamp  = ticks * TICKS_TO_SECONDS
-		tpInput.activeADCs     = tpChannels
-
-		tpStart = trunc(fifoPosGlobal / tpLengthPoints)
-		tpEnd   = trunc(fifoLatest / tpLengthPoints)
+		tpInput.device               = device
+		tpInput.tpLengthPointsADC    = tpLengthPointsADC
+		tpInput.pulseLengthPointsADC = (dataAcqOrTP == TEST_PULSE_MODE) ? TPSettingsCalc[%pulseLengthPointsTP_ADC] : TPSettingsCalc[%pulseLengthPointsDAQ_ADC]
+		tpInput.pulseStartPointsADC  = (dataAcqOrTP == TEST_PULSE_MODE) ? TPSettingsCalc[%pulseStartPointsTP_ADC] : TPSettingsCalc[%pulseStartPointsDAQ_ADC]
+		tpInput.samplingIntervalADC  = DimDelta(scaledDataWave[numDACs], ROWS)
+		tpInput.tpLengthPointsDAC    = (dataAcqOrTP == TEST_PULSE_MODE) ? TPSettingsCalc[%totalLengthPointsTP] : TPSettingsCalc[%totalLengthPointsDAQ]
+		tpInput.pulseLengthPointsDAC = (dataAcqOrTP == TEST_PULSE_MODE) ? TPSettingsCalc[%pulseLengthPointsTP] : TPSettingsCalc[%pulseLengthPointsDAQ]
+		tpInput.pulseStartPointsDAC  = (dataAcqOrTP == TEST_PULSE_MODE) ? TPSettingsCalc[%pulseStartPointsTP] : TPSettingsCalc[%pulseStartPointsDAQ]
+		tpInput.samplingIntervalDAC  = DimDelta(scaledDataWave[0], ROWS)
+		tpInput.baselineFrac         = TPSettingsCalc[%baselineFrac]
+		tpInput.readTimeStamp        = ticks * TICKS_TO_SECONDS
+		tpInput.activeADCs           = tpChannels
+		tpInput.cycleId              = ROVAR(GetTestpulseCycleID(device))
+
+		tpStart = trunc(fifoPosGlobal / tpLengthPointsADC)
+		tpEnd   = trunc(fifoLatest / tpLengthPointsADC)
 		ASSERT(tpStart <= tpEnd, "New fifopos is smaller than previous fifopos")
 		Make/FREE/D/N=(tpEnd - tpStart) tpMarker
 		NewRandomSeed()
 		tpMarker[] = GetUniqueInteger()
 
 		DEBUGPRINT("tpChannels: ", var = tpChannels)
-		DEBUGPRINT("tpLength: ", var = tpLengthPoints)
+		DEBUGPRINT("tpLength: ", var = tpLengthPointsADC)
 
 		for(i = tpStart; i < tpEnd; i += 1)
 
 			tpInput.measurementMarker = tpMarker[i - tpStart]
-			tpStartPos                = i * tpLengthPoints
+			tpStartPos                = i * tpLengthPointsADC
 
 			if(saveTP)
-				Make/FREE/N=(tpLengthPoints, tpChannels) StoreTPWave
+				Make/FREE/N=(tpLengthPointsADC, tpChannels) StoreTPWave
 				for(j = 0; j < tpChannels; j += 1)
 					WAVE scaledChannel = scaledDataWave[numDACs + j]
 					Multithread StoreTPWave[][j] = scaledChannel[tpStartPos + p]
@@ -626,7 +633,7 @@ Function SCOPE_UpdateOscilloscopeData(device, dataAcqOrTP, [chunk, fifoPos, devi
 		endfor
 
 		if(dataAcqOrTP == DATA_ACQUISITION_MODE && tpEnd > tpStart)
-			tpStartPos = (tpEnd - 1) * tpLengthPoints
+			tpStartPos = (tpEnd - 1) * tpLengthPointsADC
 			if(DAG_GetNumericalValue(device, "check_settings_show_power"))
 				WAVE tpOsciForPowerSpectrum = GetScaledTPTempWave(device)
 				Make/FREE/D/N=(numADCs) tpColumns

Packages/MIES/MIES_Publish.ipf

@@ -645,3 +645,87 @@ Function PUB_AccessResistanceSmoke(string device, variable sweepNo, variable hea
 
 	PUB_Publish(jsonID, ANALYSIS_FUNCTION_AR)
 End
+
+threadsafe static Function PUB_AddTPResultEntry(variable jsonId, string path, variable value, string unit)
+
+	JSON_AddTreeObject(jsonID, path)
+	JSON_AddVariable(jsonID, path + "/value", value)
+	if(!IsEmpty(unit))
+		JSON_AddString(jsonID, path + "/unit", unit)
+	endif
+End
+
+threadsafe Function PUB_TPResult(STRUCT TPZMQData &tpzmq)
+
+	string path
+	variable jsonId = JSON_New()
+	string   adUnit = GetADChannelUnit(tpzmq.clampMode)
+	string   daUnit = GetDAChannelUnit(tpzmq.clampMode)
+
+	path = "properties"
+	JSON_AddTreeObject(jsonID, path)
+	JSON_AddVariable(jsonID, path + "/tp marker", tpzmq.marker)
+	JSON_AddString(jsonID, path + "/device", tpzmq.device)
+	JSON_AddVariable(jsonID, path + "/headstage", tpzmq.headstage)
+	JSON_AddVariable(jsonID, path + "/clamp mode", tpzmq.clampMode)
+
+	PUB_AddTPResultEntry(jsonId, path + "/time of tp acquisition", tpzmq.now, "s")
+	PUB_AddTPResultEntry(jsonId, path + "/clamp amplitude", tpzmq.clampAmp, daUnit)
+	PUB_AddTPResultEntry(jsonId, path + "/tp length ADC", tpzmq.tpLengthPointsADC, "points")
+	PUB_AddTPResultEntry(jsonId, path + "/pulse duration ADC", tpzmq.pulseLengthPointsADC, "points")
+	PUB_AddTPResultEntry(jsonId, path + "/pulse start point ADC", tpzmq.pulseStartPointsADC, "point")
+	PUB_AddTPResultEntry(jsonId, path + "/sample interval ADC", tpzmq.samplingIntervalADC, "ms")
+	PUB_AddTPResultEntry(jsonId, path + "/tp length DAC", tpzmq.tpLengthPointsDAC, "points")
+	PUB_AddTPResultEntry(jsonId, path + "/pulse duration DAC", tpzmq.pulseLengthPointsDAC, "points")
+	PUB_AddTPResultEntry(jsonId, path + "/pulse start point DAC", tpzmq.pulseStartPointsDAC, "point")
+	PUB_AddTPResultEntry(jsonId, path + "/sample interval DAC", tpzmq.samplingIntervalDAC, "ms")
+	PUB_AddTPResultEntry(jsonId, path + "/baseline fraction", tpzmq.baselineFrac * ONE_TO_PERCENT, "%")
+	PUB_AddTPResultEntry(jsonId, path + "/timestamp", tpzmq.timeStamp, "s")
+	PUB_AddTPResultEntry(jsonId, path + "/timestampUTC", tpzmq.timeStampUTC, "s")
+	PUB_AddTPResultEntry(jsonId, path + "/tp cycle id", tpzmq.cycleId, "")
+
+	path = "results"
+	JSON_AddTreeObject(jsonID, path)
+	PUB_AddTPResultEntry(jsonId, path + "/average baseline steady state", tpzmq.avgBaselineSS, adUnit)
+	PUB_AddTPResultEntry(jsonId, path + "/average tp steady state", tpzmq.avgTPSS, adUnit)
+	PUB_AddTPResultEntry(jsonId, path + "/instantaneous", tpzmq.instVal, adUnit)
+	PUB_AddTPResultEntry(jsonId, path + "/steady state resistance", tpzmq.resistanceSS, "MΩ")
+	PUB_AddTPResultEntry(jsonId, path + "/instantaneous resistance", tpzmq.resistanceInst, "MΩ")
+
+	PUB_Publish(jsonID, ZMQ_FILTER_TPRESULT_NOW, releaseJSON = 0)
+	if(PUB_CheckPublishingTime(ZMQ_FILTER_TPRESULT_1S, 1))
+		PUB_Publish(jsonID, ZMQ_FILTER_TPRESULT_1S, releaseJSON = 0)
+	endif
+	if(PUB_CheckPublishingTime(ZMQ_FILTER_TPRESULT_5S, 5))
+		PUB_Publish(jsonID, ZMQ_FILTER_TPRESULT_5S, releaseJSON = 0)
+	endif
+	if(PUB_CheckPublishingTime(ZMQ_FILTER_TPRESULT_10S, 10))
+		PUB_Publish(jsonID, ZMQ_FILTER_TPRESULT_10S, releaseJSON = 0)
+	endif
+	JSON_Release(jsonID)
+End
+
+/// @brief Updates the publishing timestamp in the TUFXOP storage and returns 1 if an update is due (0 otherwise)
+threadsafe static Function PUB_CheckPublishingTime(string pubFilter, variable period)
+
+	variable curTime
+
+	TUFXOP_AcquireLock/N=(pubFilter)
+	TUFXOP_GetStorage/Z/Q/N=(pubFilter) lastUpdated
+	if(V_flag)
+		TUFXOP_Init/N=(pubFilter)
+		TUFXOP_GetStorage/Z/N=(pubFilter) lastUpdated
+		Make/FREE/D dTime = {DateTime}
+		lastUpdated[0] = dTime
+	endif
+	curTime = DateTime
+	WAVE lastTime = lastUpdated[0]
+	if(lastTime[0] + period > curTime)
+		lastTime[0] = curTime + period
+		TUFXOP_ReleaseLock/N=(pubFilter)
+		return 1
+	endif
+	TUFXOP_ReleaseLock/N=(pubFilter)
+
+	return 0
+End

Packages/MIES/MIES_Structures.ipf

@@ -306,16 +306,50 @@ Structure TPAnalysisInput
 	WAVE data
 	variable clampAmp
 	variable clampMode
-	variable duration // [points]
+	variable tpLengthPointsADC
+	variable pulseLengthPointsADC
+	variable pulseStartPointsADC
+	variable samplingIntervalADC
+	variable tpLengthPointsDAC
+	variable pulseLengthPointsDAC
+	variable pulseStartPointsDAC
+	variable samplingIntervalDAC
 	variable baselineFrac
-	variable tpLengthPoints
 	variable readTimeStamp
 	variable hsIndex
 	string device
 	variable measurementMarker
 	variable activeADCs
 	variable timeStamp
 	variable timeStampUTC
+	variable cycleId
+EndStructure
+
+/// @brief Helper structure for TP data transfer to zeromq
+Structure TPZMQData
+	variable marker
+	string device
+	variable headstage
+	variable now
+	variable clampMode
+	variable clampAmp
+	variable tpLengthPointsADC
+	variable pulseLengthPointsADC
+	variable pulseStartPointsADC
+	variable samplingIntervalADC
+	variable tpLengthPointsDAC
+	variable pulseLengthPointsDAC
+	variable pulseStartPointsDAC
+	variable samplingIntervalDAC
+	variable baselineFrac
+	variable timeStamp
+	variable timeStampUTC
+	variable cycleId
+	variable avgBaselineSS
+	variable avgTPSS
+	variable instVal
+	variable resistanceSS
+	variable resistanceInst
 EndStructure
 
 /// @brief Helper structure for GetPlotArea()

Packages/MIES/MIES_SweepFormula.ipf

@@ -3027,9 +3027,9 @@ static Function/WAVE SF_OperationTPImpl(string graph, WAVE/WAVE mode, WAVE/Z sel
 
 			// Assemble TP data
 			WAVE tpInput.data = SF_AverageTPFromSweep(epochMatches, sweepData)
-			tpInput.tpLengthPoints = DimSize(tpInput.data, ROWS)
-			tpInput.duration       = (str2num(epochTPPulse[0][EPOCH_COL_ENDTIME]) - str2num(epochTPPulse[0][EPOCH_COL_STARTTIME])) * ONE_TO_MILLI / DimDelta(sweepData, ROWS)
-			tpInput.baselineFrac   = TP_CalculateBaselineFraction(tpInput.duration, tpInput.duration + 2 * tpBaseLinePoints)
+			tpInput.tpLengthPointsADC    = DimSize(tpInput.data, ROWS)
+			tpInput.pulseLengthPointsADC = (str2num(epochTPPulse[0][EPOCH_COL_ENDTIME]) - str2num(epochTPPulse[0][EPOCH_COL_STARTTIME])) * ONE_TO_MILLI / DimDelta(sweepData, ROWS)
+			tpInput.baselineFrac         = TP_CalculateBaselineFraction(tpInput.pulseLengthPointsADC, tpInput.pulseLengthPointsADC + 2 * tpBaseLinePoints)
 
 			[WAVE settings, settingsIndex] = GetLastSettingChannel(numericalValues, textualValues, sweepNo, CLAMPMODE_ENTRY_KEY, dacChannelNr, XOP_CHANNEL_TYPE_DAC, DATA_ACQUISITION_MODE)
 			SFH_ASSERT(WaveExists(settings), "Failed to retrieve TP Clamp Mode from LBN")