Changeset 1002 for sans

Timestamp:

Jun 17, 2016 11:43:46 AM (7 years ago)

Author:

srkline

Message:

main changes here are the addition of a first pass at the file catalog, and patch panel. each of these is based on the old SANS file (for now) and has been updated to at least compile.

Much more work needs to be done to get the functionality to be what VSANS needs, both in what is important to report in the file catalog, and how to best present the patch GUI for different situations

Location:

sans/Dev/trunk/NCNR_User_Procedures/Reduction/VSANS

Files:

• VC_HDF5_VSANS_Utils.ipf (modified) (1 diff)
• VSANS_Includes.ipf (modified) (1 diff)
• V_FileCatalog.ipf (added)
• V_HDF5_RW_Utils.ipf (modified) (3 diffs)
• V_IQ_Utilities.ipf (modified) (7 diffs)
• V_Initialize.ipf (modified) (1 diff)
• V_MainPanel.ipf (modified) (5 diffs)
• V_MaskUtils.ipf (modified) (18 diffs)
• V_PatchFiles.ipf (added)
• V_Utilities_General.ipf (modified) (7 diffs)

sans/Dev/trunk/NCNR_User_Procedures/Reduction/VSANS/VC_HDF5_VSANS_Utils.ipf

@@ -222 +222 @@
         Save_VSANS_file("root:VSANS_DIV_file", fileName+".h5")
         
-        // read in a data file using the gateway-- reads from the home path
-        H_HDF5Gate_Read_Raw(fileName+".h5")
-        
-        // after reading in a "partial" file using the gateway (to generate the xref)
-        // Save the xref to disk (for later use)
-        Save_HDF5___xref("root:"+fileName,"HDF5___xref")
-        
-        // after you've generated the HDF5___xref, load it in and copy it
-        // to the necessary folder location.
-        Copy_HDF5___xref("root:VSANS_DIV_file", "HDF5___xref")
-        
-        // writes out the contents of a data folder using the gateway
-        H_HDF5Gate_Write_Raw("root:VSANS_DIV_file", fileName+".h5")
-
-        // re-load the data file using the gateway-- reads from the home path
-        // now with attributes
-        H_HDF5Gate_Read_Raw(fileName+".h5")
+//      // read in a data file using the gateway-- reads from the home path
+//      H_HDF5Gate_Read_Raw(fileName+".h5")
+//      
+//      // after reading in a "partial" file using the gateway (to generate the xref)
+//      // Save the xref to disk (for later use)
+//      Save_HDF5___xref("root:"+fileName,"HDF5___xref")
+//      
+//      // after you've generated the HDF5___xref, load it in and copy it
+//      // to the necessary folder location.
+//      Copy_HDF5___xref("root:VSANS_DIV_file", "HDF5___xref")
+//      
+//      // writes out the contents of a data folder using the gateway
+//      H_HDF5Gate_Write_Raw("root:VSANS_DIV_file", fileName+".h5")
+//
+//      // re-load the data file using the gateway-- reads from the home path
+//      // now with attributes
+//      H_HDF5Gate_Read_Raw(fileName+".h5")
         
 End

sans/Dev/trunk/NCNR_User_Procedures/Reduction/VSANS/VSANS_Includes.ipf

@@ -62 +62 @@
 #include "V_MaskUtils"
 
-
+// more functionality
+#include "V_FileCatalog"
+#include "V_PatchFiles"         //still in progress and won't compile

sans/Dev/trunk/NCNR_User_Procedures/Reduction/VSANS/V_HDF5_RW_Utils.ipf

@@ -31 +31 @@
 End
 
+// Moved to V_MaskUtils.ipf
 // passing null file string presents a dialog
-Proc LoadFakeMASKData()
-        V_LoadHDF5Data("","MSK")
-End
+//Proc LoadFakeMASKData()
+//      V_LoadHDF5Data("","MSK")
+//End
 
 // passing null file string presents a dialog
@@ -45 +46 @@
 //  x- move the initialization of the raw data folder to be in the as-yet unwritten initialization routine for
 // reduction. be sure that it's duplicated in the VCALC initialization too.
-// -- as needed, get rid of the FAKE redimension of the data from 3D->2D and from 128x128 to something else for VSANS
+// x- as needed, get rid of the FAKE redimension of the data from 3D->2D and from 128x128 to something else for VSANS
 //    This is a fake since I don't have anything close to correct fake data yet. (1/29/16)
 //
@@ -177 +178 @@
 // This is NOT CALLED anymore.
 // the rescaling (SetScale) of the data sets is still done separately to a "fake" beam center
-Function V_RedimFakeData()
+Function xV_RedimFakeData()
         
         // check for fake data in VCALC folder...

sans/Dev/trunk/NCNR_User_Procedures/Reduction/VSANS/V_IQ_Utilities.ipf

@@ -99 +99 @@
 
 
-Macro V_Combine1DData()
+Proc V_Combine1DData()
 
 // get the current display type
@@ -107 +107 @@
 
 // trim the data if needed
+        // remove the q=0 point from the back detector, if it's there
+        V_RemoveQ0_B(type)
+
 
 // concatenate the data sets
+        // clear the old tmp waves first, if they still exist
+        SetDataFolder $("root:Packages:NIST:VSANS:"+type)
+        Killwaves/Z tmp_q,tmp_i,tmp_s
+        setDataFolder root:
         V_1DConcatenate(type)
         
@@ -125 +132 @@
         String/G saveName=str
 End
+
+
+// blindly assumes that there is only one zero at the top of the wave
+// could be more sophisticated in the future...
+Function V_RemoveQ0_B(type)
+        String type
+        
+        SetDataFolder $("root:Packages:NIST:VSANS:"+type)
+
+        WAVE/Z qBin = qBin_qxqy_B
+        WAVE/Z iBin = iBin_qxqy_B
+        WAVE/Z eBin = eBin_qxqy_B
+        WAVE/Z nBin = nBin_qxqy_B
+        WAVE/Z iBin2 = iBin2_qxqy_B
+
+        if(qBin[0] == 0)
+                DeletePoints 0, 1, qBin,iBin,eBin,nBin,iBin2
+        endif
+        
+        SetDataFolder root:
+        return(0)
+end
 
 
@@ -136 +165 @@
 //    although waves may exist, they may not be the right ones to use. There
 //    will be a somewhat complex selection process
-// -- detector B is currently skipped
+// x- detector B is currently skipped
 //
 // this seems like a lot of extra work to do something so simple...
@@ -207 +236 @@
 //      Duplicate/O tmp_res3 $("root:"+folder2+":res3")
 
+// Can't kill here, since they are still needed to sort and write out!
 //      KillWaves/Z tmp_q,tmp_i,tmp_s,tmp_res0,tmp_res1,tmp_res2,tmp_res3       
         
@@ -215 +245 @@
 
 // TODO:
-// -- resolution waves are ignored
+// -- resolution waves are ignored, since they don't exist (yet)
 // -- only a sort is done, no rescaling of data sets
 //    (it's too late now anyways, since the data was concatenated
@@ -241 +271 @@
 
 
-// trims the beamstop out (based on shadow)
-// trims num from the highQ end
-// splits the res wave into individual waves in anticipation of concatenation
+// TODO
+// -- currently, this function is NOT called by anything
+// needs:
+// -- trim the beamstop out (based on shadow)
+// -- trim out zero q from the file (bad actor in analysis functions)
+// -- trim num from the highQ end or lowQ end?
+// -- splits the res wave into individual waves in anticipation of concatenation
+//   -- or -- deal with the res wave after?
+//
+//
 //
 Function V_Trim1DData(folderStr,nEnd)

sans/Dev/trunk/NCNR_User_Procedures/Reduction/VSANS/V_Initialize.ipf

@@ -333 +333 @@
         return isDemo
 End
+
+// Clean out the RawVSANS folder before saving
+Function BeforeExperimentSaveHook(rN,fileName,path,type,creator,kind)
+        Variable rN,kind
+        String fileName,path,type,creator
+
+        // clean out, so that the file SAVE is not slow due to the large experiment size
+        // TODO -- decide if this is really necessary
+//      
+        V_CleanOutRawVSANS()
+        Printf "Hook cleaned out RawVSANS, experiment saved\r"
+
+End

sans/Dev/trunk/NCNR_User_Procedures/Reduction/VSANS/V_MainPanel.ipf

@@ -74 +74 @@
         String ctrlName
 
-        PatchFiles()
+        V_PatchFiles()
 End
 
@@ -165 +165 @@
 End
 
-//on Misc Ops tab, generates a notebook
-Proc CatShort_MainButtonProc(ctrlName) : ButtonControl
-        String ctrlName
-
-        BuildCatShortNotebook()
-End
+////on Misc Ops tab, generates a notebook
+//Proc CatShort_MainButtonProc(ctrlName) : ButtonControl
+//      String ctrlName
+//
+//      BuildCatShortNotebook()
+//End
 
 //button is labeled "File Catalog"
@@ -176 +176 @@
         String ctrlName
 
-        //BuildCatVeryShortNotebook()
-        BuildCatVeryShortTable()
+        V_BuildCatVeryShortTable()
+End
+
+Proc CatSort_MainButtonProc(ctrlName) : ButtonControl
+        String ctrlName
+        
+        Catalog_Sort()
 End
 
@@ -337 +342 @@
         Button MainButton_0d,pos={15,180},size={130,20},proc=RealTime_MainButtonProc,title="RealTime Display"
         Button MainButton_0d,help={"Shows the panel for control of the RealTime data display. Only used during data collection"}
+        Button MainButton_0e,pos={15,210},size={130,20},proc=CatSort_MainButtonProc,title="Sort Catalog"
+        Button MainButton_0e,help={"Sort the Data Catalog, courtesy of ANSTO"}
+
+
 
 //on tab(1) - Reduction
@@ -407 +416 @@
         Button MainButton_4c,pos={15,150},size={80,20},proc=ShowAvePanel_MainButtonProc,title="Average"
         Button MainButton_4c,help={"Shows a panel for interactive selection of the 1-D averaging step"}
-        Button MainButton_4d,pos={15,180},size={110,20},proc=CatShort_MainButtonProc,title="CAT/Notebook"
-        Button MainButton_4d,help={"This will generate a CATalog notebook of all files in a specified local folder"}
+//      Button MainButton_4d,pos={15,180},size={110,20},proc=CatShort_MainButtonProc,title="CAT/Notebook"
+//      Button MainButton_4d,help={"This will generate a CATalog notebook of all files in a specified local folder"}
         Button MainButton_4e,pos={180,90},size={130,20},proc=NG1TransConv_MainButtonProc,title="NG1 Files to Trans"
         Button MainButton_4e,help={"Converts NG1 transmission data files to be interpreted as such"}

sans/Dev/trunk/NCNR_User_Procedures/Reduction/VSANS/V_MaskUtils.ipf

@@ -2 +2 @@
 #pragma rtGlobals=3             // Use modern global access method and strict wave access.
 
-
+//
+// Mask utilities:
+// - loader
+// - simple editor
+// - save mask file
+// - assign mask file to data file
+//
+//
+//  this is (at first) to be a very simple editor to generate masks row/column wise, not drawing
+//  masks with arbitrary shape. 
+//
+// 
+//
+
+///// LOADING
+
+// TODO - when maks is loaded, need to be sure to clean up the "extra" waves that may be present
+//  - the overlay and the currentTube waves since these are not overwritten or killed when new mask 
+//  data is read in from HDF. need to manually? check for these and delete then, or the data and
+//  mask overlay will be out of sync.
+//
+
+
+// passing null file string presents a dialog
+// called from the Main Button " Read Mask"
+Proc LoadFakeMASKData()
+        V_LoadHDF5Data("","MSK")
+End
+
+
+
+//// DRAWING/SAVING
+//
 // TODO:
 // x- CHANGE the mask behavior to a more logical choice - and consistent with SANS
@@ -11 +43 @@
 
 
-// also, move the mask generating utilities from VC_HDF5_Utils into this procedure - to keep
+// x- move the mask generating utilities from VC_HDF5_Utils into this procedure - to keep
 // all of the mask procedures together
 
 
-//
-// -- this is to be a very simple editor to generate masks row/column wise, not drawing
-//
+// TODO -- document the arrow keys moving the tube number and adding/deleting tubes from the mask
+//  this is done through a window hook function (LR moves tube number, up/down = add/delete)
+//
+// TODO -- make the arrow keys Igor 6 compatible - search for specialKeyCode or Keyboard Events in the help file
+//     and what needs to be replaced for Igor 6
+// TODO -- for L/R panels, the maksing of columns should be sufficient. Tubes are vertical. For the T/B panels
+//         the L/R panels cast a vertical shadow (=vertical mask) AND the tubes are horizontal, so the individual
+//         tubes will likely need to be masked in a horizontal line too, per tube. ADD this in...
 
 
 //TODO
-// -- draw a mask
-// -- save a mask (all panels)
-// -- be able to save the mask name to the file
-// -- be able to read a mask based on what is in the data file
+// x- draw a mask
+// x- save a mask (all panels)
+// -- be able to save the mask name to the RAW data file
+// -- be able to read a mask based on what name is in the data file
 //
 // x- biggest thing now is to re-write the DrawDetPanel() routine from the beamCenter.ipf
 //    to do what this panel needs
 //
-// -- lots to clean up
-// -- add this to the list of includes, move the file to SVN, and add it.
+// x- add this to the list of includes, move the file to SVN, and add it.
 //
 // -- for working with VCALC -- maybe have an automatic generator (if val < -2e6, mask = 0)
@@ -38 +74 @@
 //    routines need to be aware of this
 
-Macro Edit_a_Mask()
+
+
+// called from the main button "Draw Mask"
+Proc Edit_a_Mask()
         V_EditMask()
 end
@@ -45 +84 @@
         DoWindow/F MaskEditPanel
         if(V_flag==0)
+                Variable/G root:Packages:NIST:VSANS:Globals:gMaskTube = 0
+                Variable/G root:Packages:NIST:VSANS:Globals:gMaskMaxIndex = 47
                 Execute "MaskEditorPanel()"
         endif
@@ -52 +93 @@
 // TODO - may need to adjust the display for the different pixel dimensions
 //      ModifyGraph width={Plan,1,bottom,left}
+//
+// TODO -- need buttons for:
+//              -- quit
+//    -- help (button is there, fill in the content)
 //
 Proc MaskEditorPanel() : Panel
@@ -64 +109 @@
         PopupMenu popup_2,mode=1,popvalue="RAW",value= #"\"RAW;SAM;VCALC;\""
 
-        SetVariable setvar0,pos={247.00,20.00},size={150.00,14.00},title="tube number"
-        SetVariable setvar0,limits={0,128,1},value= _NUM:0
-        Button button_0,pos={249.00,46.00},size={50.00,20.00},proc=AddToMaskButtonProc,title="Add"
-        Button button_1,pos={309.00,46.00},size={50.00,20.00},proc=RemoveFromMaskButtonProc,title="Del"
-        Button button_2,pos={389.00,46.00},size={90.00,20.00},proc=ToggleMaskButtonProc,title="Toggle"
-        Button button_3,pos={489.00,46.00},size={80.00,20.00},proc=SaveMaskButtonProc,title="Save"
-
-// TODO -- need buttons for save? quit?
-// setVariable to add a row to the mask, column to the mask, toggle the mask on/off to see what's
-//     happening with the data
-
-
-// TODO - get rid of the hard-wired panel choice
-//      duplicate/O root:Packages:NIST:VSANS:VCALC:entry:instrument:detector_FL:det_FL curDispPanel
-        Make/O/D/N=(48,128) curDispPanel                //will this work?
-        SetScale/P x 0,1, curDispPanel
-        SetScale/P y 0,1, curDispPanel
+        SetVariable setvar0,pos={257.00,20.00},size={150.00,14.00},title="tube number"
+        SetVariable setvar0,limits={0,127,1},value=root:Packages:NIST:VSANS:Globals:gMaskTube
+        Button button_0,pos={257,46.00},size={50.00,20.00},proc=AddToMaskButtonProc,title="Add"
+        Button button_1,pos={319.00,46.00},size={50.00,20.00},proc=RemoveFromMaskButtonProc,title="Del"
+        Button button_2,pos={409.00,46.00},size={90.00,20.00},proc=ToggleMaskButtonProc,title="Toggle"
+        Button button_3,pos={509.00,46.00},size={80.00,20.00},proc=SaveMaskButtonProc,title="Save"
+        Button button_4,pos={603.00,10.00},size={20.00,20.00},proc=DrawMaskHelpButtonProc,title="?"
+        CheckBox check_0,pos={190.00,23.00},size={37.00,15.00},proc=DrawMaskRadioCheckProc,title="Row"
+        CheckBox check_0,value= 0,mode=1
+        CheckBox check_1,pos={190.00,46.00},size={32.00,15.00},proc=DrawMaskRadioCheckProc,title="Col"
+        CheckBox check_1,value= 1,mode=1
+
+        SetWindow MaskEditPanel, hook(MyHook)=MaskWindowHook
 
         // draw the correct images
@@ -88 +129 @@
         // overlay the current mask
         V_OverlayMask("FT",1)
-//      OverlayMaskPanel("FL")
 
 EndMacro
 
+Function DrawMaskHelpButtonProc(ba) : ButtonControl
+        STRUCT WMButtonAction &ba
+
+        switch( ba.eventCode )
+                case 2: // mouse up
+                        // click code here
+                        DoAlert 0, "Draw Mask Help not written yet..."
+                        break
+                case -1: // control being killed
+                        break
+        endswitch
+
+        return 0
+End
+
+//
+//a simple toggle between the two, so the logic is not done in the cleanest way.
+//
+// update the limits on the tube nubmer based on row/col and the panel (gMaskMaxIndex global)
+//
+Function DrawMaskRadioCheckProc(cba) : CheckBoxControl
+        STRUCT WMCheckboxAction &cba
+
+        switch( cba.eventCode )
+                case 2: // mouse up
+                        Variable checked = cba.checked
+                        String name = cba.ctrlName
+                        
+                        //get information to update the limits on the tube number setvar
+                        ControlInfo popup_0
+                        String str=S_Value
+                        wave data = $("root:Packages:NIST:VSANS:MSK:entry:instrument:detector_"+str+":data")
+                        Variable val
+                        
+                        // update the radio button status and the setvar limits                 
+                        if(cmpstr(name,"check_0") == 0)         // ROW is being selected
+                                CheckBox check_0,value = 1
+                                CheckBox check_1,value = 0
+                                val = DimSize(data, 1) -1
+                        else
+                                // COL is being selected
+                                CheckBox check_0,value = 0
+                                CheckBox check_1,value = 1
+                                val = DimSize(data, 0) -1
+                        endif
+                        
+                        SetVariable setvar0,limits={0,val,1}
+                        NVAR gVal = root:Packages:NIST:VSANS:Globals:gMaskTube
+                        NVAR gMax = root:Packages:NIST:VSANS:Globals:gMaskMaxIndex
+                        gMax = val
+                        if(gVal > val)
+                                gVal = val
+                        endif
+                        
+                        break
+                case -1: // control being killed
+                        break
+        endswitch
+
+        return 0
+End
+
+Function MaskWindowHook(s)
+        STRUCT WMWinHookStruct &s
+        
+        Variable hookResult = 0 // 0 if we do not handle event, 1 if we handle it.
+        
+        String message = ""
+
+        switch(s.eventCode)
+                case 11:        // Keyboard event
+//                      String keyCodeInfo
+//                      sprintf keyCodeInfo, "s.keycode = 0x%04X", s.keycode
+//                      if (strlen(message) > 0)
+//                              message += "\r"
+//                      endif
+//                      message +=keyCodeInfo
+//
+//                      message += "\r"
+//                      String specialKeyCodeInfo
+//                      sprintf specialKeyCodeInfo, "s.specialKeyCode = %d", s.specialKeyCode
+//                      message +=specialKeyCodeInfo
+//                      message += "\r"
+//
+//                      String keyTextInfo
+//                      sprintf keyTextInfo, "s.keyText = \"%s\"", s.keyText
+//                      message +=keyTextInfo
+//
+//                      String text = "\\Z24" + message
+//                      Textbox /C/N=Message/W=KeyboardEventsGraph/A=MT/X=0/Y=15 text
+
+                // TODO:  this is all Igor-7 ONLY
+
+// Note that I need to keep track of the index value since I'm intercepting the 
+// SetVariable event here. I need to keep the index in range.           
+                        STRUCT WMButtonAction ba
+                        ba.eventCode = 2
+                        NVAR tubeVal = root:Packages:NIST:VSANS:Globals:gMaskTube
+                        if(s.specialKeyCode == 100)
+                                //left arrow
+                                tubeVal -= 1
+                        endif
+                        if(s.specialKeyCode == 101)
+                                //right arrow
+                                tubeVal += 1
+                        endif
+                        if(s.specialKeyCode == 102)
+                                //up arrow
+                                AddToMaskButtonProc(ba)
+                        endif
+                        if(s.specialKeyCode == 103)
+                                //down arrow
+                                RemoveFromMaskButtonProc(ba)
+                        endif
+
+// enforce the limits on the setvar
+                        NVAR gMax = root:Packages:NIST:VSANS:Globals:gMaskMaxIndex
+                        if(tubeVal > gMax)
+                                tubeVal = gMax
+                        endif
+                        if(tubeVal < 0)
+                                tubeVal = 0
+                        endif
+                        
+// draw the "currentTube" every time
+                        ControlInfo popup_0
+                        String str=S_Value
+                        wave currentTube = $("root:Packages:NIST:VSANS:MSK:entry:instrument:detector_"+str+":currentTube")
+
+                        // update so that the proper row is displayed on the currentTube
+                        currentTube = 0
+                        
+                        ControlInfo check_0             // is it row?
+                        Variable isRow = V_value
+                        if(isRow)
+                                currentTube[][tubeVal] = 1                      
+                        else
+                                currentTube[tubeVal][] = 1
+                        endif           
+
+
+                        hookResult = 1  // We handled keystroke
+                        break
+        endswitch
+        
+        return hookResult               // If non-zero, we handled event and Igor will ignore it.
+End
 
 Function ToggleMaskButtonProc(ba) : ButtonControl
@@ -130 +317 @@
                         
                         Variable val
-                        ControlInfo setvar0
+                        ControlInfo setvar0             //get the tube number
                         val = V_Value
-                        maskData[val][] = 1
+                        
+                        ControlInfo check_0             // is it row?
+                        Variable isRow = V_value
+                        if(isRow)
+                                maskData[][val] = 1                     
+                        else
+                                maskData[val][] = 1
+                        endif
                         
                         V_OverlayMask(str,1)
                         
-//                      Print "add tube to mask"
                         break
                 case -1: // control being killed
@@ -157 +350 @@
                         
                         Variable val
-                        ControlInfo setvar0
+                        ControlInfo setvar0 // get the tube number
                         val = V_Value
-                        maskData[val][] = 0
-                        
-                        V_OverlayMask(str,1)                    
-//                      Print "remove tube from mask"
+                        
+                        ControlInfo check_0             // is it row?
+                        Variable isRow = V_value
+                        if(isRow)
+                                maskData[][val] = 0                     
+                        else
+                                maskData[val][] = 0
+                        endif
+                        
+                        V_OverlayMask(str,1)    
+                                        
                         break
                 case -1: // control being killed
@@ -202 +402 @@
                         //overlay the mask
                         V_OverlayMask(popStr,1)
-//                      OverlayMaskPanel(popStr)
-                        
+
                         break
                 case -1: // control being killed
@@ -215 +414 @@
 // SEE DrawDetPanel() in the BeamCenter file
 //
-// TODO - currently is hard-wired for the simulation path!
-//     need to make it more generic, especially for RAW data
+// TODO
+// x- currently is hard-wired for the simulation path!   need to make it more generic, especially for RAW data
 //
 // -- need to adjust the size of the image subwindows to keep the model
@@ -238 +437 @@
 
         
-        Wave dispW=root:curDispPanel
+//      Wave dispW=root:curDispPanel
 
         //plot it in the subwindow with the proper aspect and positioning
@@ -351 +550 @@
 //
 // TODO
-// -- make it work
-// -- remove the old mask first
-// -- make the mask "toggle" to remove it
-// -- go see SANS for color, implementation, etc.
-// -- un-comment the (two) calls
+// x- remove the old mask first
+// x- make the mask "toggle" to remove it
+// x- go see SANS for color, implementation, etc.
+// x- un-comment the (two) calls
 //
 //
@@ -362 +560 @@
 //
 // if state==1, show the mask, if ==0, hide the mask
+//
+//** This assumes that if the overlay is/not present on the image display, then the currentTiube is also there/not
+// and is not checked
+//
 Function V_OverlayMask(str,state)
         String str
@@ -375 +577 @@
                         Duplicate/O maskW $("root:Packages:NIST:VSANS:MSK:entry:instrument:detector_"+str+":overlay")
                         wave overlay = $("root:Packages:NIST:VSANS:MSK:entry:instrument:detector_"+str+":overlay")
-        
-                        Redimension/D overlay
-                        SetScale/P x 0,1, overlay
-                        SetScale/P y 0,1, overlay
+                        Duplicate/O maskW $("root:Packages:NIST:VSANS:MSK:entry:instrument:detector_"+str+":currentTube")
+                        wave currentTube = $("root:Packages:NIST:VSANS:MSK:entry:instrument:detector_"+str+":currentTube")
+
+                        Redimension/D overlay,currentTube
+                        SetScale/P x 0,1, overlay,currentTube
+                        SetScale/P y 0,1, overlay,currentTube
                 
-                        String tempStr = "root:Packages:NIST:MSK:overlay"
-        //              overlay = (maskW == 1) ? 1 : NaN                        //no need to do this - simply adjust the coloring
-        
+                        //              overlay = (maskW == 1) ? 1 : NaN                        //no need to do this - simply adjust the coloring
+
+                        // update so that the proper row is displayed on the currentTube
+                        currentTube = 0
+                                                
+                        Variable val
+                        ControlInfo setvar0             //get the tube number
+                        val = V_Value
+                        
+                        ControlInfo check_0             // is it row?
+                        Variable isRow = V_value
+                        if(isRow)
+                                currentTube[][val] = 1                  
+                        else
+                                currentTube[val][] = 1
+                        endif                   
+                                
                         CheckDisplayed/W=MaskEditPanel#DetData overlay
                         if(V_flag==0)           //so the overlay doesn't get appended more than once
                                 AppendImage/W=MaskEditPanel#DetData overlay
+                                AppendImage/W=MaskEditPanel#DetData currentTube
                                 ModifyImage/W=MaskEditPanel#DetData overlay ctab= {0.9,1,BlueRedGreen,0}        ,minRGB=NaN,maxRGB=0
+                                ModifyImage/W=MaskEditPanel#DetData currentTube ctab= {0.9,1,CyanMagenta,0}     ,minRGB=NaN,maxRGB=0
                 //              ModifyImage/W=MaskEditPanel#DetData overlay ctab= {0,*,BlueRedGreen,0}  
                         endif
@@ -393 +613 @@
                 if(state == 0)
                         wave overlay = $("root:Packages:NIST:VSANS:MSK:entry:instrument:detector_"+str+":overlay")
+                        wave currentTube = $("root:Packages:NIST:VSANS:MSK:entry:instrument:detector_"+str+":currentTube")
+
                         CheckDisplayed/W=MaskEditPanel#DetData overlay
 //                      Print "V_flag = ",V_flag
@@ -398 +620 @@
                         If(V_Flag == 1)         //overlay is present
                                 RemoveImage/W=MaskEditPanel#DetData overlay
+                                RemoveImage/W=MaskEditPanel#DetData currentTube
                         endif
                 endif
@@ -538 +761 @@
         Save_VSANS_file("root:VSANS_MASK_file", fileName+".h5")
         
-        // read in a data file using the gateway-- reads from the home path
-        H_HDF5Gate_Read_Raw(fileName+".h5")
-        
-        // after reading in a "partial" file using the gateway (to generate the xref)
-        // Save the xref to disk (for later use)
-        Save_HDF5___xref("root:"+fileName,"HDF5___xref")
-        
-        // after you've generated the HDF5___xref, load it in and copy it
-        // to the necessary folder location.
-        Copy_HDF5___xref("root:VSANS_MASK_file", "HDF5___xref")
-        
-        // writes out the contents of a data folder using the gateway
-        H_HDF5Gate_Write_Raw("root:VSANS_MASK_file", fileName+".h5")
-
-        // re-load the data file using the gateway-- reads from the home path
-        // now with attributes
-        H_HDF5Gate_Read_Raw(fileName+".h5")
-        
-End
+//      // read in a data file using the gateway-- reads from the home path
+//      H_HDF5Gate_Read_Raw(fileName+".h5")
+//      
+//      // after reading in a "partial" file using the gateway (to generate the xref)
+//      // Save the xref to disk (for later use)
+//      Save_HDF5___xref("root:"+fileName,"HDF5___xref")
+//      
+//      // after you've generated the HDF5___xref, load it in and copy it
+//      // to the necessary folder location.
+//      Copy_HDF5___xref("root:VSANS_MASK_file", "HDF5___xref")
+//      
+//      // writes out the contents of a data folder using the gateway
+//      H_HDF5Gate_Write_Raw("root:VSANS_MASK_file", fileName+".h5")
+//
+//      // re-load the data file using the gateway-- reads from the home path
+//      // now with attributes
+//      H_HDF5Gate_Read_Raw(fileName+".h5")
+        
+End

sans/Dev/trunk/NCNR_User_Procedures/Reduction/VSANS/V_Utilities_General.ipf

@@ -108 +108 @@
         return(err)
 end
+
+// TODO:
+// -- this still does not quite work. If there are no sub folders present in the RawVSANS folder
+//    it still thinks there are (1) item there.
+// -- if I replace the semicolon with a comma, it thinks there are two folders present and appears
+//    to delete the RawVSANS folder itself! seems very dangerous...this is because DataFolderDir returns
+//    a comma delimited list, but with a semicolon and \r at the end. need to remove these...
+Function V_CleanOutRawVSANS()
+
+        SetDataFolder root:Packages:NIST:VSANS:RawVSANS:
+        
+        // get a list of the data folders there
+        // kill them all if possible
+        String list,item
+        Variable numFolders,ii,pt
+        
+        list = DataFolderDir(1)
+        // this has FOLDERS: at the beginning and is comma-delimited
+        list = list[8,strlen(list)]
+        pt = strsearch(list,";",inf,1)
+        list = list[0,pt-1]                     //remove the ";\r" from the end of the string
+//      print list
+        
+        numFolders = ItemsInList(list , ",")
+//      Print List
+//      print strlen(list)
+
+        for(ii=0;ii<numFolders;ii+=1)
+                item = StringFromList(ii, list ,",")
+//              Print item
+                KillDataFolder/Z $(item)
+        endfor
+
+        list = DataFolderDir(1)
+        list = list[8,strlen(list)]
+        pt = strsearch(list,";",inf,1)
+        list = list[0,pt-1]
+        numFolders = ItemsInList(list, ",")
+        Printf "%g RawVSANS folders could not be killed\r",numFolders
+                
+        SetDataFolder root:
+        return(0)
+End
 
 //given a filename of a SANS data filename of the form
@@ -313 +356 @@
 // -1 => previous file
 // 1 => next file
+//
+// V_CheckIfRawData(fname)
+//
 Function/S V_GetPrevNextRawFile(curfilename, prevnext)
         String curfilename
@@ -337 +383 @@
 //run number "num". The null string is returned if no valid file can be found
 //the path "catPathName" used and is hard-wired, will abort if this path does not exist
-//the file returned will be a RAW SANS data file, other types of files are 
+//the file returned will be a RAW VSANS data file, other types of files are 
 //filtered out.
 //
@@ -399 +445 @@
                                         isRAW = V_CheckIfRawData(fullName)
                                         if(isRaw)
+                                                //print "is raw, ",fullname
                                                 //stop here
                                                 return(fullname)
@@ -411 +458 @@
 
 //
-// TODO -- for VSANS Nexus files, how do I quickly identify if a file is
+// TODO x- for VSANS Nexus files, how do I quickly identify if a file is
 //   RAW VSANS data? I don't want to generate any errors, but I want to quickly
 //   weed out the reduced data sets, etc. from file catalogs.
-//
-//function to test a binary file to see if it is a RAW binary SANS file
-//first checks the total bytes in the file (which for raw data is 33316 bytes)
-//**note that the "DIV" file will also show up as a raw file by the run field
-//should be listed in CAT/SHORT and in patch windows
-//
-//Function then checks the file fname (full path:file) for "RAW" run.type field
-//if not found, the data is not raw data and zero is returned
-//
-// called by many procedures (both external and local)
-//
+//      (check the instrument name...)
+
 // TODO -- as was written by SANS, this function is expecting fname to be the path:fileName
 // - but are the V_get() functions OK with getting a full path, and what do they
@@ -436 +474 @@
         
         testStr = V_getInstrumentName(fname)
-        
-        if(cmpstr(testStr,"") != 0)
+
+        if(cmpstr(testStr,"NG3-VSANS") == 0)
+                //testStr exists, ASSUMING it's a raw VSANS data file
+                Return(1)
+        else
+                //some other file
+                Return(0)
+        Endif
+End
+
+// TODO -- need to fill in correctly by determining this from the INTENT field
+//
+Function V_isTransFile(fname)
+        String fname
+        
+        Variable refnum,totalBytes
+        String testStr=""
+        
+//      testStr = V_getInstrumentName(fname)
+
+        if(cmpstr(testStr,"NG3-VSANS") == 0)            //wrong test
                 //testStr exists, ASSUMING it's a raw VSANS data file
                 Return(1)
@@ -638 +695 @@
                 
 End
+
+// returns a list of raw data files in the catPathName directory on disk
+// - list is SEMICOLON-delimited
+//
+// TODO: decide how to do this...
+// (1)
+// checks each file in the directory to see if it is a RAW data file by
+// call to V_CheckIfRawData() which currently looks for the instrument name in the file.
+// -- CON - this is excruciatingly slow, and by checking a field in the file, has to load in the 
+//  ENTIRE data file, and will load EVERY file in the folder. ugh.
+//
+// (2)
+// as was done for VAX files, look for a specific string in the file name as written by the acquisition
+//  (was .saN), now key on ".nxs.ngv"?
+//
+// called by PatchFiles.ipf, Tile_2D.ipf
+//
+Function/S V_GetRawDataFileList()
+        
+        //make sure that path exists
+        PathInfo catPathName
+        if (V_flag == 0)
+                Abort "Folder path does not exist - use Pick Path button on Main Panel"
+        Endif
+        String path = S_Path
+        
+        String list=IndexedFile(catPathName,-1,"????")
+        String newList="",item="",validName="",fullName=""
+        Variable num=ItemsInList(list,";"),ii
+        
+        for(ii=0;ii<num;ii+=1)
+                item = StringFromList(ii, list  ,";")
+
+                validName = V_FindValidFileName(item)
+                if(strlen(validName) != 0)              //non-null return from FindValidFileName()
+                        fullName = path + validName             
+
+        //method (1)                    
+//                      if(V_CheckIfRawData(item))
+//                              newlist += item + ";"
+//                      endif
+
+        //method (2)                    
+                        if( stringmatch(item,"*.nxs.ngv*") )
+                                newlist += item + ";"
+                        endif
+
+                        
+                endif
+                //print "ii=",ii
+        endfor
+        newList = SortList(newList,";",0)
+        return(newList)
+End
+
+
+//the following is a WaveMetrics procedure from <StrMatchList>
+// MatchList(matchStr,list,sep)
+// Returns the items of the list whose items match matchStr
+// The lists are separated by the sep character, usually ";"
+//
+// matchStr may be something like "abc", in which case it is identical to CmpStr
+// matchStr may also be "*" to match anything, "abc*" to match anything starting with "abc",
+//      "*abc" to match anything ending with "abc".
+// matchStr may also begin with "!" to indicate a match to anything not matching the rest of
+//      the pattern.
+// At most one "*" and one "!" are allowed in matchStr, otherwise the results are not guaranteed.
+//
+Function/S V_MyMatchList(matchStr,list,sep)
+        String matchStr,list,sep
+        String item,outList=""
+        Variable n=strlen(list)
+        Variable en,st=0
+        do
+                en= strsearch(list,sep,st)
+                if( en < 0 )
+                        if( st < n-1 )
+                                en= n   // no trailing separator
+                                sep=""  // don't put sep in output, either
+                        else
+                                break   // no more items in list
+                        endif
+                endif
+                item=list[st,en-1]
+                if( V_MyStrMatch(matchStr,item) == 0 )
+                        outlist += item+sep
+                Endif
+                st=en+1 
+        while (st < n ) // exit is by break, above
+        return outlist
+End
+
+//the following is a WaveMetrics procedure from <StrMatchList>
+// StrMatch(matchStr,str)
+// Returns 0 if the pattern in matchStr matches str, else it returns 1
+//
+// matchStr may be something like "abc", in which case it is identical to CmpStr
+// matchStr may also be "*" to match anything, "abc*" to match anything starting with "abc",
+//      "*abc" to match anything ending with "abc".
+// matchStr may also begin with "!" to indicate a match to anything not matching the rest of
+//      the pattern.
+// At most one "*" and one "!" are allowed in matchStr, otherwise the results are not guaranteed.
+//
+Function V_MyStrMatch(matchStr,str)
+        String matchStr,str
+        Variable match = 1              // 0 means match
+        Variable invert= strsearch(matchStr,"!",0) == 0
+        if( invert )
+                matchStr[0,0]=""        // remove the "!"
+        endif
+        Variable st=0,en=strlen(str)-1
+        Variable starPos= strsearch(matchStr,"*",0)
+        if( starPos >= 0 )      // have a star
+                if( starPos == 0 )      // at start
+                        matchStr[0,0]=""                                // remove star at start
+                else                                    // at end
+                        matchStr[starPos,999999]=""     // remove star and rest of (ignored, illegal) pattern
+                endif
+                Variable len=strlen(matchStr)
+                if( len > 0 )
+                        if(starPos == 0)        // star at start, match must be at end
+                                st=en-len+1
+                        else
+                                en=len-1        // star at end, match at start
+                        endif
+                else
+                        str=""  // so that "*" matches anything
+                endif
+        endif
+        match= !CmpStr(matchStr,str[st,en])==0  // 1 or 0
+        if( invert )
+                match= 1-match
+        endif
+        return match
+End
+
+
+//input is a list of run numbers, and output is a list of filenames (not the full path)
+//*** input list must be COMMA delimited***
+//output is equivalent to selecting from the CAT table
+//if some or all of the list items are valid filenames, keep them...
+//if an error is encountered, notify of the offending element and return a null list
+//
+//output is COMMA delimited
+//
+// this routine is expecting that the "ask", "none" special cases are handled elsewhere
+//and not passed here
+//
+// called by Marquee.ipf, MultipleReduce.ipf, ProtocolAsPanel.ipf
+//
+Function/S ParseRunNumberList(list)
+        String list
+        
+        String newList="",item="",tempStr=""
+        Variable num,ii,runNum
+        
+        //expand number ranges, if any
+        list = V_ExpandNumRanges(list)
+        
+        num=itemsinlist(list,",")
+        
+        for(ii=0;ii<num;ii+=1)
+                //get the item
+                item = StringFromList(ii,list,",")
+                //is it already a valid filename?
+                tempStr=V_FindValidFilename(item) //returns filename if good, null if error
+                if(strlen(tempstr)!=0)
+                        //valid name, add to list
+                        //Print "it's a file"
+                        newList += tempStr + ","
+                else
+                        //not a valid name
+                        //is it a number?
+                        runNum=str2num(item)
+                        //print runnum
+                        if(numtype(runNum) != 0)
+                                //not a number -  maybe an error                        
+                                DoAlert 0,"List item "+item+" is not a valid run number or filename. Please enter a valid number or filename."
+                                return("")
+                        else
+                                //a run number or an error
+                                tempStr = V_GetFileNameFromPathNoSemi( V_FindFileFromRunNumber(runNum) )
+                                if(strlen(tempstr)==0)
+                                        //file not found, error
+                                        DoAlert 0,"List item "+item+" is not a valid run number. Please enter a valid number."
+                                        return("")
+                                else
+                                        newList += tempStr + ","
+                                endif
+                        endif
+                endif
+        endfor          //loop over all items in list
+        
+        return(newList)
+End
+
+//takes a comma delimited list that MAY contain number range, and
+//expands any range of run numbers into a comma-delimited list...
+//and returns the new list - if not a range, return unchanged
+//
+// local function
+//
+Function/S V_ExpandNumRanges(list)
+        String list
+        
+        String newList="",dash="-",item,str
+        Variable num,ii,hasDash
+        
+        num=itemsinlist(list,",")
+//      print num
+        for(ii=0;ii<num;ii+=1)
+                //get the item
+                item = StringFromList(ii,list,",")
+                //does it contain a dash?
+                hasDash = strsearch(item,dash,0)                //-1 if no dash found
+                if(hasDash == -1)
+                        //not a range, keep it in the list
+                        newList += item + ","
+                else
+                        //has a dash (so it's a range), expand (or add null)
+                        newList += V_ListFromDash(item)         
+                endif
+        endfor
+        
+        return newList
+End
+
+//be sure to add a trailing comma to the return string...
+//
+// local function
+//
+Function/S V_ListFromDash(item)
+        String item
+        
+        String numList="",loStr="",hiStr=""
+        Variable lo,hi,ii
+        
+        loStr=StringFromList(0,item,"-")        //treat the range as a list
+        hiStr=StringFromList(1,item,"-")
+        lo=str2num(loStr)
+        hi=str2num(hiStr)
+        if( (numtype(lo) != 0) || (numtype(hi) !=0 ) || (lo > hi) )
+                numList=""
+                return numList
+        endif
+        for(ii=lo;ii<=hi;ii+=1)
+                numList += num2str(ii) + ","
+        endfor
+        
+        Return numList
+End
+