Skip to content

Commit

Permalink
Merge pull request #1815 from AllenInstitute/feature/1815-Improve_Get…
Browse files Browse the repository at this point in the history 
…ActiveChannels
  • Loading branch information
@t-b
t-b authored Jul 14, 2023
2 parents 7877b8c + 43b6643 commit 2530b80
Show file tree
Hide file tree
Showing 8 changed files with 217 additions and 138 deletions.
4 changes: 2 additions & 2 deletions Packages/MIES/MIES_AnalysisFunctionHelpers.ipf
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ End
///
/// @param DAQConfigWave DAQ configuration wave, most users need to call
/// `GetDAQConfigWave(device)` to get that wave.
/// @param channelNumber channel number (0-based)
/// @param channelNumber hardware channel number
/// @param channelType channel type, one of @ref XopChannelConstants
threadsafe Function AFH_GetDAQDataColumn(DAQConfigWave, channelNumber, channelType)
WAVE DAQConfigWave
Expand Down Expand Up @@ -156,7 +156,7 @@ End
///
/// @param DAQConfigWave DAQ configuration wave, most users need to call
/// `GetDAQConfigWave(device)` to get that wave.
/// @param channelNumber channel number (0-based)
/// @param channelNumber hardware channel number
/// @param channelType channel type, one of @ref XopChannelConstants
Function/S AFH_GetChannelUnit(DAQConfigWave, channelNumber, channelType)
WAVE DAQConfigWave
Expand Down
13 changes: 8 additions & 5 deletions Packages/MIES/MIES_BrowserSettingsPanel.ipf
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1606,11 +1606,11 @@ End
/// @brief Debug function to add traces with epoch information
Function BSP_AddTracesForEpochs(string win)

variable i, j, numEntries, start_x, start_y, end_x, end_y, yOffset
variable i, j, start_x, start_y, end_x, end_y, yOffset
variable headstage, yLevelOffset, level, idx, numTraces, numEpochs
variable sweepNumber, traceIndex, channelType, hwChannelNumber, guiChannelNumber, ttlBit, fetchChanType
STRUCT RGBColor c
string device, xaxis, yaxis, axes, axis, levels_x_name, levels_y_name, name, idPart, level_x_trace
string xaxis, yaxis, axes, axis, levels_x_name, levels_y_name, name, idPart, level_x_trace

if(!BSP_IsDataBrowser(win) && !BSP_IsSweepBrowser(win))
printf "The current window is neither a databrowser nor a sweepbrowser windows.\r"
Expand Down Expand Up @@ -1673,16 +1673,19 @@ Function BSP_AddTracesForEpochs(string win)
fetchChanType = channelType
switch(channelType)
case XOP_CHANNEL_TYPE_ADC:
guiChannelNumber = SFH_GetDAChannel(win, sweepNumber, channelType, hwChannelNumber)
guiChannelNumber = hwChannelNumber
guiChannelNumber = SFH_GetDAChannel(win, sweepNumber, channelType, guiChannelNumber)
fetchChanType = XOP_CHANNEL_TYPE_DAC
break
case XOP_CHANNEL_TYPE_DAC:
guiChannelNumber = hwChannelNumber
break
case XOP_CHANNEL_TYPE_TTL:
ttlBit = str2num(traceInfos[i][%TTLBit])
device = BSP_GetDevice(win)
guiChannelNumber = GetChannelNumberTTL(device, hwChannelNumber, ttlBit)
WAVE/Z channelMapHWToGUI = GetActiveChannels(numericalValues, textualValues, sweepNumber, XOP_CHANNEL_TYPE_TTL, TTLmode = TTL_HWTOGUI_CHANNEL)
ASSERT(WaveExists(channelMapHWToGUI), "Expected TTL channel(s) for sweep " + num2istr(sweepNumber) + " in LNB, but none found.")
guiChannelNumber = channelMapHWToGUI[hwChannelNumber][IsNaN(ttlBit) ? 0 : ttlBit]
ASSERT(IsFinite(guiChannelNumber), "Could not retrieve GUI channel number for TTL hardware channel/ttlBits")
break
default:
ASSERT(0, "Unsupported channelType")
Expand Down
2 changes: 2 additions & 0 deletions Packages/MIES/MIES_Constants.ipf
View file
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,8 @@ Constant TIME_TP_ONLY_ON_DAQ = 1
/// @{
Constant TTL_HARDWARE_CHANNEL = 0x0
Constant TTL_DAEPHYS_CHANNEL = 0x1
Constant TTL_GUITOHW_CHANNEL = 0x2
Constant TTL_HWTOGUI_CHANNEL = 0x3
/// @}

Constant MINIMUM_WAVE_SIZE = 64
Expand Down
4 changes: 2 additions & 2 deletions Packages/MIES/MIES_DAC-Hardware.ipf
View file
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ End
///
/// @param hardwareType One of @ref HardwareDACTypeConstants
/// @param deviceID device identifier
/// @param channel channel number
/// @param channel hardware channel number
/// @param value value to write in volts
/// @param flags [optional, default none] One or multiple flags from @ref HardwareInteractionFlags
Function HW_WriteDAC(hardwareType, deviceID, channel, value, [flags])
Expand All @@ -233,7 +233,7 @@ End
///
/// @param hardwareType One of @ref HardwareDACTypeConstants
/// @param deviceID device identifier
/// @param channel channel number
/// @param channel hardware channel number
/// @param flags [optional, default none] One or multiple flags from @ref HardwareInteractionFlags
///
/// @return value in volts
Expand Down
225 changes: 128 additions & 97 deletions Packages/MIES/MIES_MiesUtilities.ipf
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2110,7 +2110,7 @@ End
///
/// @param sweepDFR datafolder holding 1D waves
/// @param channelType One of @ref XopChannelConstants
/// @param channelNumber channel number
/// @param channelNumber hardware channel number
/// @param splitTTLBits [optional, defaults to false] return a single bit of the TTL wave
/// @param ttlBit [optional] number specifying the TTL bit
Function/WAVE GetDAQDataSingleColumnWave(sweepDFR, channelType, channelNumber, [splitTTLBits, ttlBit])
Expand Down Expand Up @@ -4734,79 +4734,145 @@ threadsafe Function GetTTLBits(numericalValues, sweep, channel)
return ttlBits[index]
End

/// @brief Return a wave with the used TTL channels/bits which are indexed by DAEphys TTL channels
/// @brief Return a wave with the requested TTL channel information defined by TTLmode
///
/// @param numericalValues Numerical labnotebook values
/// @param textualValues Text labnotebook values
/// @param sweep Sweep number
threadsafe static Function/WAVE GetTTLChannelsOrBits(WAVE numericalValues, WAVE textualValues, variable sweep)
variable index, first, last
/// @param TTLmode One of @ref ActiveChannelsTTLMode.
threadsafe static Function/WAVE GetActiveChannelsTTL(WAVE numericalValues, WAVE textualValues, variable sweep, variable TTLmode)

variable i, index, first, last, haveRackZero, haveRackOne, numHWTTLChannels, bits, hwChannel

index = GetIndexForHeadstageIndepData(numericalValues)

WAVE/T/Z ttlChannels = GetLastSetting(textualValues, sweep, "TTL channels", DATA_ACQUISITION_MODE)
WAVE/Z ttlBitsRackZero = GetLastSetting(numericalValues, sweep, "TTL rack zero bits", DATA_ACQUISITION_MODE)
WAVE/Z ttlBitsRackOne = GetLastSetting(numericalValues, sweep, "TTL rack one bits", DATA_ACQUISITION_MODE)

if(WaveExists(ttlChannels))
// NI hardware
return ListToNumericWave(ttlChannels[index], ";")
elseif(WaveExists(ttlBitsRackZero) || WaveExists(ttlBitsRackOne))
// ITC hardware
Make/FREE/D/N=(NUM_DA_TTL_CHANNELS) entries = NaN
switch(TTLmode)
case TTL_HARDWARE_CHANNEL: // intended drop-through
case TTL_DAEPHYS_CHANNEL:
return ListToNumericWave(ttlChannels[index], ";")
case TTL_GUITOHW_CHANNEL:
WAVE channelMapGUIToHW = GetActiveChannelMapTTLGUIToHW()
WAVE NIChannelNumbersHW = ListToNumericWave(ttlChannels[index], ";")
channelMapGUIToHW[][%HWCHANNEL] = NIChannelNumbersHW[p]

return channelMapGUIToHW
case TTL_HWTOGUI_CHANNEL:
WAVE channelMapHWToGUI = GetActiveChannelMapTTLHWToGUI()

WAVE NIChannelNumbersHW = ListToNumericWave(ttlChannels[index], ";")
channelMapHWToGUI[][] = NIChannelNumbersHW[p]

return channelMapHWToGUI
default:
ASSERT_TS(0, "Invalid TTLmode")
endswitch
endif

if(WaveExists(ttlBitsRackZero))
HW_ITC_GetRackRange(RACK_ZERO, first, last)
entries[first, last] = (ttlBitsRackZero[index] & 2^p) == 2^p ? p : NaN
endif
// ITC hardware
switch(TTLmode)
case TTL_HARDWARE_CHANNEL:

if(WaveExists(ttlBitsRackOne))
HW_ITC_GetRackRange(RACK_ONE, first, last)
entries[first, last] = (ttlBitsRackOne[index] & 2^p) == 2^p ? p : NaN
endif
WAVE/Z ttlChannelRackZero = GetLastSetting(numericalValues, sweep, "TTL rack zero channel", DATA_ACQUISITION_MODE)
WAVE/Z ttlChannelRackOne = GetLastSetting(numericalValues, sweep, "TTL rack one channel", DATA_ACQUISITION_MODE)
if(WaveExists(ttlChannelRackZero) || WaveExists(ttlChannelRackOne))
numHWTTLChannels = max(HARDWARE_ITC_TTL_1600_RACK_ONE + 1, NUM_DA_TTL_CHANNELS)
Make/FREE/D/N=(numHWTTLChannels) entries = NaN
if(WaveExists(ttlChannelRackZero))
hwChannel = ttlChannelRackZero[index]
entries[hwChannel] = hwChannel
endif

return entries
endif
if(WaveExists(ttlChannelRackOne))
hwChannel = ttlChannelRackOne[index]
entries[hwChannel] = hwChannel
endif

// no TTL entries
return $""
End
return entries
endif

/// @brief Return a wave with the used TTL channels which are indexed by DAEphys TTL channels
///
/// The returned wave is *not* hardware independent.
/// For ITC hardware this will only ever return at most one active channel.
///
/// @param numericalValues Numerical labnotebook values
/// @param textualValues Text labnotebook values
/// @param sweep Sweep number
threadsafe static Function/WAVE GetTTLChannels(WAVE numericalValues, WAVE textualValues, variable sweep)
variable index
break
case TTL_DAEPHYS_CHANNEL:

index = GetIndexForHeadstageIndepData(numericalValues)
WAVE/Z ttlBitsRackZero = GetLastSetting(numericalValues, sweep, "TTL rack zero bits", DATA_ACQUISITION_MODE)
WAVE/Z ttlBitsRackOne = GetLastSetting(numericalValues, sweep, "TTL rack one bits", DATA_ACQUISITION_MODE)
if(WaveExists(ttlBitsRackZero) || WaveExists(ttlBitsRackOne))
Make/FREE/D/N=(NUM_DA_TTL_CHANNELS) entries = NaN

WAVE/T/Z ttlChannels = GetLastSetting(textualValues, sweep, "TTL channels", DATA_ACQUISITION_MODE)
WAVE/Z ttlChannelRackZero = GetLastSetting(numericalValues, sweep, "TTL rack zero channel", DATA_ACQUISITION_MODE)
WAVE/Z ttlChannelRackOne = GetLastSetting(numericalValues, sweep, "TTL rack one channel", DATA_ACQUISITION_MODE)
if(WaveExists(ttlBitsRackZero))
HW_ITC_GetRackRange(RACK_ZERO, first, last)
bits = ttlBitsRackZero[index]
entries[first, last] = (bits & 1 << p) != 0 ? p : NaN
endif

if(WaveExists(ttlChannels))
// NI hardware
return ListToNumericWave(ttlChannels[index], ";")
elseif(WaveExists(ttlChannelRackZero) || WaveExists(ttlChannelRackOne))
// ITC hardware
Make/FREE/D/N=(NUM_DA_TTL_CHANNELS) entries = NaN
if(WaveExists(ttlChannelRackZero))
entries[ttlChannelRackZero[index]] = ttlChannelRackZero[index]
endif
if(WaveExists(ttlBitsRackOne))
HW_ITC_GetRackRange(RACK_ONE, first, last)
bits = ttlBitsRackOne[index]
entries[first, last] = (bits & 1 << (p - NUM_ITC_TTL_BITS_PER_RACK)) != 0 ? p : NaN
endif

if(WaveExists(ttlChannelRackOne))
entries[ttlChannelRackOne[index]] = ttlChannelRackOne[index]
endif
return entries
endif

return entries
endif
break
case TTL_GUITOHW_CHANNEL:
WAVE channelMapGUIToHW = GetActiveChannelMapTTLGUIToHW()

WAVE/Z ttlChannelRackZero = GetLastSetting(numericalValues, sweep, "TTL rack zero channel", DATA_ACQUISITION_MODE)
WAVE/Z ttlChannelRackOne = GetLastSetting(numericalValues, sweep, "TTL rack one channel", DATA_ACQUISITION_MODE)
WAVE/Z ttlBitsRackZero = GetLastSetting(numericalValues, sweep, "TTL rack zero bits", DATA_ACQUISITION_MODE)
WAVE/Z ttlBitsRackOne = GetLastSetting(numericalValues, sweep, "TTL rack one bits", DATA_ACQUISITION_MODE)
haveRackZero = WaveExists(ttlBitsRackZero) && WaveExists(ttlChannelRackZero)
haveRackOne = WaveExists(ttlBitsRackOne) && WaveExists(ttlChannelRackOne)
if(haveRackZero)
HW_ITC_GetRackRange(RACK_ZERO, first, last)
bits = ttlBitsRackZero[index]
hwChannel = ttlChannelRackZero[index]
channelMapGUIToHW[first, last][%TTLBITNR] = (bits & 1 << p) != 0 ? p : NaN
channelMapGUIToHW[first, last][%HWCHANNEL] = IsNaN(channelMapGUIToHW[p][%TTLBITNR]) ? NaN : hwChannel
endif
if(haveRackOne)
HW_ITC_GetRackRange(RACK_ONE, first, last)
bits = ttlBitsRackOne[index]
hwChannel = ttlChannelRackOne[index]
channelMapGUIToHW[first, last][%TTLBITNR] = (bits & 1 << (p - NUM_ITC_TTL_BITS_PER_RACK)) != 0 ? p : NaN
channelMapGUIToHW[first, last][%HWCHANNEL] = IsNaN(channelMapGUIToHW[p][%TTLBITNR]) ? NaN : hwChannel
endif
if(haveRackZero || haveRackOne)
return channelMapGUIToHW
endif
break
case TTL_HWTOGUI_CHANNEL:
WAVE channelMapHWToGUI = GetActiveChannelMapTTLHWToGUI()

WAVE/Z ttlChannelRackZero = GetLastSetting(numericalValues, sweep, "TTL rack zero channel", DATA_ACQUISITION_MODE)
WAVE/Z ttlChannelRackOne = GetLastSetting(numericalValues, sweep, "TTL rack one channel", DATA_ACQUISITION_MODE)
WAVE/Z ttlBitsRackZero = GetLastSetting(numericalValues, sweep, "TTL rack zero bits", DATA_ACQUISITION_MODE)
WAVE/Z ttlBitsRackOne = GetLastSetting(numericalValues, sweep, "TTL rack one bits", DATA_ACQUISITION_MODE)
haveRackZero = WaveExists(ttlBitsRackZero) && WaveExists(ttlChannelRackZero)
haveRackOne = WaveExists(ttlBitsRackOne) && WaveExists(ttlChannelRackOne)
if(haveRackZero)
HW_ITC_GetRackRange(RACK_ZERO, first, last)
bits = ttlBitsRackZero[index]
hwChannel = ttlChannelRackZero[index]
channelMapHWToGUI[hwChannel][first, last] = (bits & 1 << q) != 0 ? q : NaN
endif
if(haveRackOne)
HW_ITC_GetRackRange(RACK_ONE, first, last)
bits = ttlBitsRackOne[index]
hwChannel = ttlChannelRackOne[index]
channelMapHWToGUI[hwChannel][first - NUM_ITC_TTL_BITS_PER_RACK, last - NUM_ITC_TTL_BITS_PER_RACK] = (bits & 1 << q) != 0 ? q + NUM_ITC_TTL_BITS_PER_RACK : NaN
endif
if(haveRackZero || haveRackOne)
return channelMapHWToGUI
endif
break
default:
ASSERT_TS(0, "Invalid TTLmode")
endswitch

// no TTL entries
return $""
End

Expand Down Expand Up @@ -4839,10 +4905,15 @@ End
/// - ``TTL``:
///
/// - NI hardware (regardless of TTLmode): ``{NaN, NaN, 2, 3, ...}``
/// - ITC hardware (ITC18 specifically) with TTLmode:
/// - ITC hardware with TTLmode, example for two active racks:
///
/// - ``TTL_DAEPHYS_CHANNEL``: ``{NaN, NaN, 2, 3, ...}``
/// - ``TTL_HARDWARE_CHANNEL``: ``{NaN, 1, NaN, NaN, ...}``
/// - ``TTL_DAEPHYS_CHANNEL``: ``{NaN, NaN, 2, 3, NaN, 5, NaN, NaN}``
/// - ``TTL_HARDWARE_CHANNEL``: ``{0, NaN, NaN, 3, NaN, NaN, Nan, NaN}``
/// - ``TTL_GUITOHW_CHANNEL``: returns a 2D wave that allows to index by GUI channel (row) and retrieve hardware channel number and ttlbit number.
/// The columns are %HWCHANNEL and %TTLBITNR. The %TTLBITNR column is only valid for ITC hardware.
/// - ``TTL_HWTOGUI_CHANNEL``: returns a 2D wave that allows to index by hardware channel number and TTL bit number and retrieve the GUI channel number.
/// The hardware channel is indexed in the row and the TTL bit number in the column dimension. For NI hardware the TTL bit index should be zero.
/// Inactive hardware channel/ttlbit combinations return NaN.
///
/// \endrst
///
Expand Down Expand Up @@ -4870,14 +4941,7 @@ threadsafe Function/WAVE GetActiveChannels(WAVE numericalValues, WAVE textualVal
key = "ADC"
break
case XOP_CHANNEL_TYPE_TTL:
switch(TTLmode)
case TTL_HARDWARE_CHANNEL:
return GetTTLChannels(numericalValues, textualValues, sweepNo)
case TTL_DAEPHYS_CHANNEL:
return GetTTLChannelsOrBits(numericalValues, textualValues, sweepNo)
default:
ASSERT_TS(0, "Invalid TTLmode")
endswitch
return GetActiveChannelsTTL(numericalValues, textualValues, sweepNo, TTLmode)
default:
ASSERT_TS(0, "Unexpected channelType")
endswitch
Expand Down Expand Up @@ -8255,36 +8319,3 @@ Function SetUserPingTimestamp(variable timeStamp)
NVAR JSONid = $GetSettingsJSONid()
JSON_SetString(JSONid, "/" + PACKAGE_SETTINGS_USERPING + "/last upload", isoTS)
End

/// @brief Converts a TTL hardware channel number and ttlBit information to a GUI channel number
/// If the hardware device is NI then ttlBit is ignored.
///
/// @param[in] device Hardware device
/// @param[in] hwChannelNumber Hardware channel number
/// @param[in] ttlBit Number fo the TTL bit in the ITC rack in the range 0 to NUM_ITC_TTL_BITS_PER_RACK - 1
/// @returns TTL GUI channel number
Function GetChannelNumberTTL(string device, variable hwChannelNumber, variable ttlBit)

variable hwType

hwType = GetHardwareType(device)
if(hwType == HARDWARE_NI_DAC)
return hwChannelNumber
elseif(hwType == HARDWARE_ITC_DAC)
if(IsITC1600(device))
if(hwChannelNumber == HARDWARE_ITC_TTL_1600_RACK_ZERO)
return ttlBit
elseif(hwChannelNumber == HARDWARE_ITC_TTL_1600_RACK_ONE)
return ttlBit + NUM_ITC_TTL_BITS_PER_RACK
else
ASSERT(0, "Unknown ITC1600 TTL hardware channel number")
endif
elseif(hwChannelNumber == HARDWARE_ITC_TTL_DEF_RACK_ZERO)
return ttlBit
else
ASSERT(0, "Unknown single rack ITC TTL hardware channel number")
endif
else
ASSERT(0, "Unsupported hardware type")
endif
End
23 changes: 23 additions & 0 deletions Packages/MIES/MIES_WaveDataFolderGetters.ipf
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7789,3 +7789,26 @@ Function/WAVE GetSFVarAssignments()

return varAssignments
End

/// @brief Returns a wave where GetActiveChannels fills in the mapping between GUI and hardware TTL channels
/// The wave is initialized here with no active channels
threadsafe Function/WAVE GetActiveChannelMapTTLGUIToHW()

Make/FREE/D/N=(NUM_DA_TTL_CHANNELS, 2) channelMapGUIToHW = NaN
SetDimlabel COLS, 0, HWCHANNEL, channelMapGUIToHW
SetDimlabel COLS, 1, TTLBITNR, channelMapGUIToHW

return channelMapGUIToHW
End

/// @brief Returns a wave where GetActiveChannels fills in the mapping between hardware and GUI TTL channels
/// The wave is initialized here with no active channels
threadsafe Function/WAVE GetActiveChannelMapTTLHWToGUI()

variable numHWTTLChannels

numHWTTLChannels = max(HARDWARE_ITC_TTL_1600_RACK_ONE + 1, NUM_DA_TTL_CHANNELS)
Make/FREE/D/N=(numHWTTLChannels, NUM_ITC_TTL_BITS_PER_RACK) channelMapHWToGUI = NaN

return channelMapHWToGUI
End
Loading

0 comments on commit 2530b80

Please sign in to comment.