Add customized new features

[FateDecider]

Hi there, I would like to add some features customized to my purpose. But I will need some guidance on which parts of the code to change. Let me explain the two things I have in mind:

1. For a multi-parameter scan, I want to reverse the order of the list corresponding to the final parameter, for every other value of the second last parameter. To do this, I have this in scan.py > execRecipe:

        # iter over each parameter (do once if no parameter!)
        for i, paramValueList in enumerate(product(*paramValues_list)):
            if self.reverse_order:  # Check if reverse order is enabled
            # Access the value of the second last parameter
                if len(paramValues_list) >= 2 and len(paramValues_list[-1]) > 1 and len(paramValues_list[-2]) > 1:
                    second_last_parameter_value = paramValues_list[-2][i]  
                    if second_last_parameter_value % 2 != 0:  # Check if the value is odd
                        paramValueList[-1] = reversed(paramValueList[-1])  # Reverse the order of the list for the last parameter

I want to add a button to the scanning GUI that sets self.reverse_order = True. Can you advise how to add this button in the respective backend codes?

2. For a multi-parameter scan, I have two parameters to scan and I measure a variable, and I want that to be plotted in "Scan" figure as a 2D plot instead of 1D line plots. I believe I have to change this setting in gui\scanning\figure.py, but not entirely sure how. Please advise.

Thanks for the advice!

[Python-simulation]

Hi!

1. I am not sure what you meant by "to reverse the order of the list corresponding to the final parameter, for every other value of the second last parameter". Could you provide an example with values so I can see if it is possible to do what you want with the current Autolab version (using $eval: and Variables)?
   To add a button you can either use QtDesigner to open the interface.ui file, add a button and connect to it in any scanning file. Or simpler, using code:

# In scanning/main.py at the end of __init__
self.reverseCheckBox = QtWidgets.QCheckBox("Reverse order")
self.reverseCheckBox .stateChanged.connect(self.doSomething)
self.verticalLayout_recipe.addWidget(self.reverseCheckBox)

def doSomething(self):
    self.reverse_order = self.reverseCheckBox.isChecked()  # boolean to use for scan
   # You can then use this state in scan.py BUT you need to add it to ScanThread that doesn't communicate with the GUI (as an argument maybe)

2. It's something I'd also like to do but have never found the time.
   Currently, plotting is done by selecting the x and y axis:

x = subdata.loc[:,variable_x]
y = subdata.loc[:,variable_y]

and plotting a line: curve = self.ax.plot(x, y, ...).
We should add a way to select x,y,z and plot it as an image like for true images: self.figMap.setImage(image_data, ...)
I didn't plan to do it soon so I can't help you more on this topic sorry.

[FateDecider]

Hi, thanks for the prompt reply. I am planning to scan the positions like this (in black) instead of (in green), which is the default for the nested loop structure

[Python-simulation]

Solution that works only for linear step and by providing the maximum value of the x parameter inside the recipe:

[Python-simulation]

For previous Autolab versions without Variable, you can do the same by replacing the parameter name with its address (dummy.constant(), system.parameter_buffer() ...)

[FateDecider]

Thanks!

For my second request, I cheated by doing the following:

and I save the values I need in the Driver temporarily and assemble them using a method in Driver():

but I believe the image did not quite plot correctly (I think my array formatting/shape is not correct - for my purpose, 2D image is good)

[Python-simulation]

The issue comes from the fact that you tried to plot three 'images' with different shapes.
The variable data correspond to a list with an image per scan step (in your example 3). The first image you try to plot is array([[0.01503037]]) with shape (1,1) (so not an image). The second is None and the third is array([[0.01503037, 0.02105777, 0.01424197]]) with shape (1,3).
The way images are plotted require to have an image per step but you tried to create an image for a whole scan if I understood correctly.

[Python-simulation]

One solution would be to create an empty array with the correct size and populate each point during the scan to have something like that:

data = [array([[0.01503037, None, None]]), array([[0.01503037, 0.02105777, None]]), array([[0.01503037, 0.02105777, 0.01424197]])]

I remind that data=[image_1, image_2, image_3] for a scan with 3 steps.