Merge pull request #1050 from AllenInstitute/feature/1050-add-more-ttl-entries

Add "Set cycle count" LBN entry for TTL channels

Author: t-b

Packages/MIES/MIES_DataConfigurator.ipf

@@ -1751,6 +1751,7 @@ static Function DC_ITC_MakeTTLWave(panelTitle, rackNo)
 	string stimSetWaveNote = ""
 	string stimSetchecksum = ""
 	string stimSetLength = ""
+	string setCycleCounts = ""
 
 	WAVE statusTTLFiltered = DC_GetFilteredChannelState(panelTitle, DATA_ACQUISITION_MODE, CHANNEL_TYPE_TTL)
 
@@ -1786,6 +1787,7 @@ static Function DC_ITC_MakeTTLWave(panelTitle, rackNo)
 		if(!statusTTLFiltered[i])
 			if(i >= first && i <= last)
 				setSweepCounts = AddListItem("", setSweepCounts, ";", inf)
+				setCycleCounts = AddListItem("", setCycleCounts, ";", inf)
 			endif
 
 			indexingEndStimset = AddListItem("", indexingEndStimset, ";", inf)
@@ -1814,17 +1816,20 @@ static Function DC_ITC_MakeTTLWave(panelTitle, rackNo)
 			bit = 2^(i - first)
 			MultiThread TTLWave[0, lastIdx] += bit * TTLStimSet[p][col]
 			setSweepCounts = AddListItem(num2str(col), setSweepCounts, ";", inf)
+			setCycleCounts = AddListItem(num2str(setCycleCount), setCycleCounts, ";", inf)
 		endif
 	endfor
 
 	if(rackNo == RACK_ZERO)
 		sweepDataLNB[0][%$"TTL rack zero bits"][INDEP_HEADSTAGE]                = bits
 		sweepDataTxTLNB[0][%$"TTL rack zero stim sets"][INDEP_HEADSTAGE]        = listOfSets
 		sweepDataTxTLNB[0][%$"TTL rack zero set sweep counts"][INDEP_HEADSTAGE] = setSweepCounts
+		sweepDataTxTLNB[0][%$"TTL rack zero set cycle counts"][INDEP_HEADSTAGE] = setCycleCounts
 	else
 		sweepDataLNB[0][%$"TTL rack one bits"][INDEP_HEADSTAGE]                = bits
 		sweepDataTxTLNB[0][%$"TTL rack one stim sets"][INDEP_HEADSTAGE]        = listOfSets
 		sweepDataTxTLNB[0][%$"TTL rack one set sweep counts"][INDEP_HEADSTAGE] = setSweepCounts
+		sweepDataTxTLNB[0][%$"TTL rack one set cycle counts"][INDEP_HEADSTAGE] = setCycleCounts
 	endif
 
 	sweepDataTxTLNB[0][%$"TTL Indexing End stimset"][INDEP_HEADSTAGE] = indexingEndStimset
@@ -1845,6 +1850,7 @@ static Function DC_NI_MakeTTLWave(panelTitle)
 	string stimSetWaveNote = ""
 	string stimSetChecksum = ""
 	string stimSetLength = ""
+	string setCycleCounts = ""
 
 	WAVE statusTTLFiltered = DC_GetFilteredChannelState(panelTitle, DATA_ACQUISITION_MODE, CHANNEL_TYPE_TTL)
 	WAVE/T allSetNames = DAG_GetChannelTextual(panelTitle, CHANNEL_TYPE_TTL, CHANNEL_CONTROL_WAVE)
@@ -1858,6 +1864,7 @@ static Function DC_NI_MakeTTLWave(panelTitle)
 		if(!statusTTLFiltered[i])
 			listOfSets = AddListItem("", listOfSets, ";", inf)
 			setSweepCounts = AddListItem("", setSweepCounts, ";", inf)
+			setCycleCounts = AddListItem("", setCycleCounts, ";", inf)
 			channels = AddListItem("", channels, ";", inf)
 			indexingEndStimset = AddListItem("", indexingEndStimset, ";", inf)
 			stimSetWaveNote = AddListItem("", stimSetWaveNote, ";", inf)
@@ -1875,6 +1882,7 @@ static Function DC_NI_MakeTTLWave(panelTitle)
 
 		listOfSets = AddListItem(set, listOfSets, ";", inf)
 		setSweepCounts = AddListItem(num2str(col), setSweepCounts, ";", inf)
+		setCycleCounts = AddListItem(num2str(setCycleCount), setCycleCounts, ";", inf)
 		channels = AddListItem(num2str(i), channels, ";", inf)
 		indexingEndStimset = AddListItem(allSetNamesIndexingEnd[i], indexingEndStimset, ";", inf)
 		stimSetWaveNote = AddListItem(URLEncode(note(TTLStimSet)), stimSetWaveNote, ";", inf)
@@ -1889,6 +1897,7 @@ static Function DC_NI_MakeTTLWave(panelTitle)
 	sweepDataTxTLNB[0][%$"TTL channels"][INDEP_HEADSTAGE]             = channels
 	sweepDataTxTLNB[0][%$"TTL stim sets"][INDEP_HEADSTAGE]            = listOfSets
 	sweepDataTxTLNB[0][%$"TTL set sweep counts"][INDEP_HEADSTAGE]     = setSweepCounts
+	sweepDataTxTLNB[0][%$"TTL set cycle counts"][INDEP_HEADSTAGE]     = setCycleCounts
 	sweepDataTxTLNB[0][%$"TTL Indexing End stimset"][INDEP_HEADSTAGE] = indexingEndStimset
 	sweepDataTxTLNB[0][%$"TTL Stimset wave note"][INDEP_HEADSTAGE]    = stimSetWaveNote
 	sweepDataTxTLNB[0][%$"TTL Stim Wave Checksum"][INDEP_HEADSTAGE]   = stimSetChecksum

Packages/MIES/MIES_WaveDataFolderGetters.ipf

@@ -2223,6 +2223,9 @@ End
 /// - 36: TTL Stim Wave Checksum (hardware agnostic) URL-encoded payload, see [URL-encoding](https://en.wikipedia.org/wiki/Percent-encoding)
 ///                                                  for background information, same string list formatting
 /// - 37: TTL Stim set length (hardware agnostic), same string list formatting
+/// - 38: TTL rack zero set cycle counts (ITC hardware)
+/// - 39: TTL rack one set cycle counts (ITC hardware)
+/// - 40: TTL set cycle counts (NI hardware), string list in `INDEP_HEADSTAGE` layer with empty entries indexed by [0, NUM_DA_TTL_CHANNELS[
 Function/Wave GetSweepSettingsTextKeyWave(panelTitle)
 	string panelTitle
 
@@ -2241,9 +2244,9 @@ Function/Wave GetSweepSettingsTextKeyWave(panelTitle)
 	if(ExistsWithCorrectLayoutVersion(wv, versionOfNewWave))
 		return wv
 	elseif(WaveExists(wv))
-		Redimension/N=(-1, 38, 0) wv
+		Redimension/N=(-1, 41, 0) wv
 	else
-		Make/T/N=(1, 38) newDFR:$newName/Wave=wv
+		Make/T/N=(1, 41) newDFR:$newName/Wave=wv
 	endif
 
 	SetDimLabel ROWS, 0, Parameter, wv
@@ -2288,6 +2291,9 @@ Function/Wave GetSweepSettingsTextKeyWave(panelTitle)
 	wv[0][35] = "TTL Stimset wave note"
 	wv[0][36] = "TTL Stim Wave Checksum"
 	wv[0][37] = "TTL Stim set length"
+	wv[0][38] = "TTL rack zero set cycle counts"
+	wv[0][39] = "TTL rack one set cycle counts"
+	wv[0][40] = "TTL set cycle counts"
 
 	SetSweepSettingsDimLabels(wv, wv)
 	SetWaveVersion(wv, versionOfNewWave)

Packages/Testing-MIES/UTF_BasicHardwareTests.ipf

@@ -2467,15 +2467,15 @@ End
 
 // Using unassociated channels works
 // UTF_TD_GENERATOR HardwareMain#DeviceNameGeneratorMD1
-Function UnassociatedChannels([str])
+Function UnassociatedChannelsAndTTLs([str])
 	string str
 
 	STRUCT DAQSettings s
 	InitDAQSettingsFromString(s, "MD1_RA0_I0_L0_BKG_1_RES_1")
 	AcquireData(s, str, preAcquireFunc = EnableUnassocChannels_IGNORE)
 End
 
-Function UnassociatedChannels_REENTRY([str])
+Function UnassociatedChannelsAndTTLs_REENTRY([str])
 	string str
 
 	string device, sweeps, configs, unit, expectedStr
@@ -2596,6 +2596,17 @@ Function UnassociatedChannels_REENTRY([str])
 					else
 						CHECK_WAVE(sweepCounts, NULL_WAVE)
 					endif
+
+					// set cycle count
+					WAVE/T/Z cycleCounts = GetLastSetting(textualValues, j, "TTL rack zero set cycle counts", DATA_ACQUISITION_MODE)
+					CHECK_EQUAL_TEXTWAVES(cycleCounts, {"", "", "", "", "", "", "", "", ";0;;0;"})
+					WAVE/T/Z cycleCounts = GetLastSetting(textualValues, j, "TTL rack one set cycle counts", DATA_ACQUISITION_MODE)
+					if(HW_ITC_GetNumberOfRacks(device) > 1)
+						CHECK_EQUAL_TEXTWAVES(cycleCounts, {"", "", "", "", "", "", "", "", ";0;;0;"})
+					else
+						CHECK_WAVE(cycleCounts, NULL_WAVE)
+					endif
+
 					break
 				case HARDWARE_NI_DAC:
 					CHECK_EQUAL_WAVES(TTLs, {1, 3}, mode = WAVE_DATA)
@@ -2609,6 +2620,9 @@ Function UnassociatedChannels_REENTRY([str])
 					WAVE/T/Z sweepCounts = GetLastSetting(textualValues, j, "TTL set sweep counts", DATA_ACQUISITION_MODE)
 					CHECK_EQUAL_TEXTWAVES(sweepCounts, {"", "", "", "", "", "", "", "", ";0;;0;;;;;"})
 
+					WAVE/T/Z cycleCounts = GetLastSetting(textualValues, j, "TTL set cycle counts", DATA_ACQUISITION_MODE)
+					CHECK_EQUAL_TEXTWAVES(cycleCounts, {"", "", "", "", "", "", "", "", ";0;;0;;;;;"})
+
 					break
 			endswitch