8.6.5.3. pymodaq_gui.parameter.utils module

class pymodaq_gui.parameter.utils.ParameterWithPath(parameter, path=None)[source]

Bases: SerializableBase

holds together a Parameter object and its full path

To be used when communicating between TCPIP to reconstruct properly the Parameter

Variables:

  • parameter (Parameter) – a Parameter object

  • path (full path of the parameter (a list of names, an empty tuple is also used for a parameter not in a tree),) – if None it is constructed from the parameter parents

Attributes:
parameter
path

Methods

deserialize(bytes_str)

Convert bytes into a ParameterWithPath object

value()

The value of the parameter

serialize
classmethod deserialize(bytes_str)[source]

Convert bytes into a ParameterWithPath object

Return type:

Union[ParameterWithPath, Tuple[ParameterWithPath, bytes]]

Returns:

  • ParameterWithPath (the decoded object)

  • bytes (the remaining bytes string if any)

static serialize(param)[source]
Return type:

bytes

value()[source]

The value of the parameter

Return type:

Any

property parameter: Parameter
property path: Sequence[str]
pymodaq_gui.parameter.utils.change_visibility_all_descendants(param, visible=True)[source]

Recursively show all descendants of a parameter

Return type:

None

pymodaq_gui.parameter.utils.compareParameters(param1, param2, with_self=True)[source]

Compare the structure and the opts of two parameters with their children, return True if structure and all opts are identical. If with_self is False, only the children opts are compared.

Parameters:
Return type:

bool

pymodaq_gui.parameter.utils.compareStructureParameter(param1, param2)[source]

Compare the structure of two parameters with their children, return True if structure is identical

Parameters:
Return type:

bool

pymodaq_gui.parameter.utils.compareValuesParameter(param1, param2, with_self=True)[source]

Compare the structure and the values of two parameters with their children, return True if structures and values are identical. If with_self is False, only the children opts are compared.

Parameters:
Return type:

bool

pymodaq_gui.parameter.utils.filter_parameter_tree(param, search_text='')[source]

Filter parameter tree based on search text. Returns True if this parameter or any of its children match the search.

Return type:

bool

pymodaq_gui.parameter.utils.getOpts(param)[source]

Return an OrderedDict with tree structures of all opts for all children of this parameter

Parameters:

param (Parameter)

Return type:

OrderedDict

pymodaq_gui.parameter.utils.getStruct(param)[source]

Return an OrderedDict with tree structures of all children of this parameter

Parameters:

param (Parameter)

Return type:

OrderedDict

pymodaq_gui.parameter.utils.getValues(param)[source]

Return an OrderedDict with tree structures of all values for all children of this parameter

Parameters:

param (Parameter)

Return type:

OrderedDict

pymodaq_gui.parameter.utils.get_param_dict_from_name(parent_list, name, pop=False)[source]

Get dict under parent whose name is name. The parent_list structure is the one used to init a Parameter object

Parameters:
Return type:

Optional[Dict[str, Any]]

pymodaq_gui.parameter.utils.get_param_from_name(parent, name)[source]

Get Parameter under parent whose name is name

Parameters:
Returns:

The first parameter found (depth first), None if there is none

Return type:

Optional[Parameter]

pymodaq_gui.parameter.utils.get_param_path(param)[source]

Get the parameter path from its highest parent down to the given parameter including its identifier (name)

Parameters:

param (Parameter) – The parameter object

Returns:

List[str]

Return type:

List[str]

pymodaq_gui.parameter.utils.get_widget_from_tree(parameter_tree, widget_instance)[source]

Get the widgets of the items of a ParameterTree whose class has the name of the given class

Parameters:

  • parameter_tree (Any)

  • widget_instance (type) – The widget class (only its name is compared)

Return type:

List[Any]

pymodaq_gui.parameter.utils.is_name_in_dict(dict_tmp, name)[source]

Check if a dict, as used to init a Parameter, has the given name

Return type:

bool

pymodaq_gui.parameter.utils.iter_children(param, childlist=None, filter_type=(), filter_name=(), select_filter=False)[source]

Get a list of parameters’ name under a given Parameter (see iter_children_params)

Returns:

The list of the children name from the given node.

Return type:

list

pymodaq_gui.parameter.utils.iter_children_params(param, childlist=None, output_type=None, filter_type=(), filter_name=(), select_filter=False)[source]

Get a list of parameters under a given Parameter.

Parameters:

  • param (Parameter) – the root node to be coursed

  • childlist (Optional[list]) – the child/output list, the results are appended to it. A new list is used if None

  • output_type (Optional[str]) – the attribute of parameter that will be added to the output list

  • filter_type (Iterable[str]) – filter children sharing those types

  • filter_name (Iterable[str]) – filter children sharing those names

  • select_filter (bool) – if True, add filtered parameters to output list. if False (default), add non-filtered parameter to output list.

Returns:

The list of the children from the given node.

Return type:

list

pymodaq_gui.parameter.utils.scroll_linear(scroll_val, min_val, max_val)[source]

Convert a scroll value [0-100] to a linear scale between min_val and max_val

Parameters:
Return type:

float

pymodaq_gui.parameter.utils.scroll_log(scroll_val, min_val, max_val)[source]

Convert a scroll value [0-100] to a log scale between min_val and max_val

Parameters:
Return type:

float

pymodaq_gui.parameter.utils.set_param_from_param(param_old, param_new)[source]

Walk through parameters children and set values using new parameter values.

Return type:

None

pymodaq_gui.parameter.utils.tree_change_blocker(param, keep=None)[source]

Block and accumulate the tree change signals of param, keeping only some change types

Backward compatible version of Parameter.treeChangeBlocker(keep=...), whose keep argument is only available in recent pyqtgraph versions.

Parameters:

  • param (Parameter) – the parameter whose tree change signals are blocked

  • keep (Optional[set[str]]) – the change types ('value', 'limits'…) emitted once unblocked. None keeps them all, an empty set discards all the changes made within the block

Return type:

Iterator[None]