Skip to content

[refactor] driver hamamatsurx: simplify return type for *ParamsList #3485

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

Open
pieleric wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[refactor] driver hamamatsurx: simplify return type for *ParamsList #3485

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
136 changes: 110 additions & 26 deletions src/odemis/driver/hamamatsurx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
import socket
import time
import re
from typing import Tuple, Optional, Dict, Callable
from typing import Tuple, Optional, Dict, Callable, List

import numpy

Expand Down Expand Up @@ -1397,7 +1397,7 @@ def terminate(self):

super().terminate()

def sendCommand(self, func, *args, **kwargs):
def sendCommand(self, func, *args, **kwargs) -> List[str]:
"""
Sends a command to RemoteEx.
:param func: (str) command or function, which should be send to RemoteEx
Expand Down Expand Up @@ -1670,11 +1670,25 @@ def MainParamInfoEx(self, parameter):
:returns: Label, Current value, Param type (PARAM_TYPE_DISPLAY)"""
return self.sendCommand("MainParamInfoEx", parameter)

def MainParamsList(self):
def MainParamsList(self) -> List[str]:
"""Returns a list of all parameters related to main window.
This command can be used to build up a complete parameter list related to main window at runtime.
:returns: NumberOfParameters,Parameter1,..., ParameterN"""
return self.sendCommand("MainParamsList")
:return: list of main window parameter names
"""
result = self.sendCommand("MainParamsList")
if not result:
logging.warning("MainParamsList returned empty result.")
return []
Comment on lines +1673 to +1681
try:
expected_count = int(result[0])
except (ValueError, IndexError):
logging.warning("MainParamsList returned unexpected format: %s", result)
return result
params = result[1:]
if len(params) != expected_count:
logging.warning("MainParamsList reported %d parameters but received %d",
expected_count, len(params))
return params

def MainSyncGet(self):
"""Returns the setting of the sync parameter which is available on the HPD-TA main window.
Expand Down Expand Up @@ -1744,10 +1758,24 @@ def GenParamInfoEx(self, parameter):
raise IOError("Failed to decode response from GenParamInfo: %s" % ex)
return label, value, param_typ

def GenParamsList(self):
def GenParamsList(self) -> List[str]:
"""Returns a list of all parameters related to the general options.
:returns: NumberOfParameters,Parameter1,..., ParameterN."""
return self.sendCommand("GenParamsList")
:return: list of general option parameter names
"""
result = self.sendCommand("GenParamsList")
if not result:
logging.warning("GenParamsList returned empty result.")
return []
Comment on lines +1761 to +1768
try:
expected_count = int(result[0])
except (ValueError, IndexError):
logging.warning("GenParamsList returned unexpected format: %s", result)
return result
params = result[1:]
if len(params) != expected_count:
logging.warning("GenParamsList reported %d parameters but received %d",
expected_count, len(params))
return params

# === Acquisition commands ========================================================

Expand Down Expand Up @@ -1804,7 +1832,7 @@ def AcqParamInfo(self, parameter):
"""
return self.sendCommand("AcqParamInfo", parameter)

def AcqParamInfoEx(self, parameter):
def AcqParamInfoEx(self, parameter: str) -> List[str]:
"""Returns information about the specified parameter. Returns more detailed information in case of a list
parameter (Parameter type = 2) than AcqParamInfo. In case of a numeric parameter (Parameter
type = 1) it additionally returns the step width
Expand All @@ -1815,14 +1843,28 @@ def AcqParamInfoEx(self, parameter):
Note: In case of a list or an exposure time the number of entries and all list entries are returned in
the response of the AcqParamInfoEx command. In case of a numeric parameter (Parameter type =
1) it additionally returns the step width
"""
"""
return self.sendCommand("AcqParamInfoEx", parameter)

def AcqParamsList(self):
def AcqParamsList(self) -> List[str]:
"""Returns a list of all parameters related to acquisition. This command can be used to build up
a complete parameter list related to acquisition at runtime.
:return: NumberOfParameters,Parameter1,..., ParameterN"""
return self.sendCommand("AcqParamsList")
a complete parameter list related to acquisition at runtime.
:return: list of acquisition parameter names
"""
result = self.sendCommand("AcqParamsList")
if not result:
logging.warning("AcqParamsList returned empty result.")
return []
try:
expected_count = int(result[0])
except (ValueError, IndexError):
logging.warning("AcqParamsList returned unexpected format: %s", result)
return result
params = result[1:]
if len(params) != expected_count:
logging.warning("AcqParamsList reported %d parameters but received %d",
expected_count, len(params))
return params

def AcqLiveMonitor(self, monitorType, nbBuffers=None, *args):
"""Starts a mode which returns information on every new image acquired in live mode.
Expand Down Expand Up @@ -1892,7 +1934,7 @@ def AcqAcqMonitor(self, type):

# === Camera commands ========================================================

def CamParamGet(self, location, parameter):
def CamParamGet(self, location: str, parameter: str) -> List[str]:
"""Returns the values of the camera options.
:param location: (str)
Setup: Parameters on the options dialog.
Expand Down Expand Up @@ -2100,12 +2142,26 @@ def CamParamInfoEx(self, location, parameter):
PARAM_TYPE_STRING, PARAM_TYPE_EXPTIME, PARAM_TYPE_DISPLAY"""
return self.sendCommand("CamParamInfoEx", location, parameter)

def CamParamsList(self, location):
def CamParamsList(self, location: str) -> List[str]:
"""Returns a list of all camera parameters of the specified location.
This command can be used to build up a complete parameter list for the corresponding camera at runtime.
:param location: (str) see CamParamGet
:return: NumberOfParameters,Parameter1,..., ParameterN"""
return self.sendCommand("CamParamsList", location)
:param location: see CamParamGet
:return: list of parameter names for the given location
"""
result = self.sendCommand("CamParamsList", location)
if not result:
logging.warning("CamParamsList returned empty result.")
return []
try:
expected_count = int(result[0])
except (ValueError, IndexError):
logging.warning("CamParamsList returned unexpected format: %s", result)
return result
params = result[1:]
if len(params) != expected_count:
logging.warning("CamParamsList(%s) reported %d parameters but received %d",
location, expected_count, len(params))
return params

def CamGetLiveBG(self):
"""Gets a new background image which is used for real time background subtraction (RTBS).
Expand Down Expand Up @@ -2183,11 +2239,25 @@ def DevParamInfoEx(self, location, parameter):
param type: PARAM_TYPE_NUMERIC, PARAM_TYPE_LIST"""
return self.sendCommand("DevParamInfoEx", location, parameter)

def DevParamsList(self, device):
def DevParamsList(self, device: str) -> List[str]:
"""Return list of all parameters of a specified device.
:param device: (str) see location in DevParamGet
:return: number of parameters, parameters"""
return self.sendCommand("DevParamsList", device)
:param device: see location in DevParamGet
:return: list of parameter names for the given device
"""
result = self.sendCommand("DevParamsList", device)
if not result:
logging.warning("DevParamsList returned empty result.")
return []
try:
expected_count = int(result[0])
except (ValueError, IndexError):
logging.warning("DevParamsList returned unexpected format: %s", result)
return result
params = result[1:]
if len(params) != expected_count:
logging.warning("DevParamsList(%s) reported %d parameters but received %d",
device, expected_count, len(params))
return params

# === Sequence commands ========================================================

Expand Down Expand Up @@ -2254,11 +2324,25 @@ def SeqParamInfoEx(self, parameter):
:return: label, current value, param type"""
return self.sendCommand("SeqParamInfoEx", parameter)

def SeqParamsList(self):
def SeqParamsList(self) -> List[str]:
"""Return list of all parameters related to sequence mode.
This command can be used to build up a complete parameter list related to sequence mode at runtime.
:return: number of parameters, parameters"""
return self.sendCommand("SeqParamsList")
:return: list of sequence mode parameter names
"""
result = self.sendCommand("SeqParamsList")
if not result:
logging.warning("SeqParamsList returned empty result.")
return []
try:
expected_count = int(result[0])
except (ValueError, IndexError):
logging.warning("SeqParamsList returned unexpected format: %s", result)
return result
params = result[1:]
if len(params) != expected_count:
logging.warning("SeqParamsList reported %d parameters but received %d",
expected_count, len(params))
return params

def SeqSeqMonitor(self, type):
"""This command starts a mode which returns information on every new image or part image acquired in Sequence
Expand Down
Loading