Skip to content

Allow to add files to analysis browser which got returned by a python script #2597

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
t-b wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Allow to add files to analysis browser which got returned by a python script #2597

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c8b633
AB_AddElementToSourceList: Make it static
t-b Dec 10, 2025
e5b0cb7
AB_AddFolder: Factor it out
t-b Dec 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions Packages/MIES/MIES_AnalysisBrowser.ipf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3113,10 +3113,7 @@ Function AB_ButtonProc_AddFolder(STRUCT WMButtonAction &ba) : ButtonControl
break
endif

AB_AddElementToSourceList(folder)

Make/FREE/T wFolder = {folder}
AB_AddExperimentEntries(ba.win, wFolder)
AB_AddFolder(ba.win, {folder})
AB_CollapseAll()
break
default:
Expand Down Expand Up @@ -3228,7 +3225,22 @@ static Function AB_AddFiles(string win, WAVE/T selFiles)
AB_AddExperimentEntries(win, newFiles)
End

Function AB_AddElementToSourceList(string entry)
/// @brief Add folders to the analysis browser
///
/// @param win analysis browser window
/// @param folders text wave with absolute folder paths containing pxps (backslashes need escaping)
Copy link

Copilot AI Dec 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation states "absolute folder paths containing pxps" but the function actually scans for pxp, uxp, and nwb files based on the checkbox settings in the analysis browser, as can be seen in AB_AddExperimentEntries. The documentation should be updated to reflect this, for example: "absolute folder paths containing data files (pxp, uxp, nwb)"

Suggested change
/// @param folders text wave with absolute folder paths containing pxps (backslashes need escaping)
/// @param folders text wave with absolute folder paths containing data files (pxp, uxp, nwb) (backslashes need escaping)

Copilot uses AI. Check for mistakes.
Function AB_AddFolder(string win, WAVE/T folders)
Copy link

Copilot AI Dec 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The function name AB_AddFolder is singular but the parameter is named 'folders' (plural) and the function accepts multiple folders via a wave. For consistency with the sibling function AB_AddFiles which uses plural naming, consider renaming this to AB_AddFolders to better reflect that it can handle multiple folders.

Suggested change
Function AB_AddFolder(string win, WAVE/T folders)
Function AB_AddFolders(string win, WAVE/T folders)

Copilot uses AI. Check for mistakes.

string folder

for(folder : folders)
AB_AddElementToSourceList(folder)
endfor

AB_AddExperimentEntries(win, folders)
Comment on lines +3234 to +3240
Copy link

Copilot AI Dec 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new AB_AddFolder function is missing duplicate checking logic that is present in the sibling function AB_AddFiles. AB_AddFiles checks each file against the existing folderList to avoid adding duplicates and only passes new files to AB_AddExperimentEntries. AB_AddFolder should implement the same duplicate checking pattern to ensure consistency and avoid processing the same folder multiple times.

Suggested change
string folder
for(folder : folders)
AB_AddElementToSourceList(folder)
endfor
AB_AddExperimentEntries(win, folders)
variable i, index = 0, size
Duplicate/FREE/T folders, newFolders
WAVE/T folderList = GetAnalysisBrowserGUIFolderList()
size = DimSize(folders, ROWS)
for(i = 0; i < size; i += 1)
FindValue/TEXT=folders[i]/TXOP=4 folderList
if(V_Value >= 0)
continue
endif
AB_AddElementToSourceList(folders[i])
newFolders[index] = folders[i]
index += 1
endfor
Redimension/N=(index) newFolders
AB_AddExperimentEntries(win, newFolders)

Copilot uses AI. Check for mistakes.
End

static Function AB_AddElementToSourceList(string entry)
Copy link

Copilot AI Dec 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Making AB_AddElementToSourceList static breaks existing test code in Packages/tests/UTF_HelperFunctions.ipf (line 1221) which calls MIES_AB#AB_AddElementToSourceList. While the new AB_AddFolder function provides a better public API, the test helper function OpenAnalysisBrowser needs to be updated to use the new public API instead of directly calling AB_AddElementToSourceList. Consider keeping AB_AddElementToSourceList public temporarily with a deprecation comment, or ensure all callers are updated in the same change.

Suggested change
static Function AB_AddElementToSourceList(string entry)
/// @deprecated Use AB_AddFolder instead. This function will be made static/private in the future.
Function AB_AddElementToSourceList(string entry)

Copilot uses AI. Check for mistakes.

variable size

Expand Down
Loading