Note

This is the documentation for the current state of the development branch of Qiskit Experiments. The documentation or APIs here can change prior to being released.

Calibrations.parameters_table

Calibrations.parameters_table(parameters=None, qubit_list=None, schedules=None, most_recent_only=True, group=None)[source]

A convenience function to help users visualize the values of their parameter.

Parameters:
  • parameters (Optional[List[str]]) – The parameter names that should be included in the returned table. If None is given then all names are included.

  • qubit_list (Optional[List[Tuple[int, ...]]]) – The qubits that should be included in the returned table. If None is given then all channels are returned.

  • schedules (Optional[List[Union[ScheduleBlock, str]]]) – The schedules to which to restrict the output.

  • most_recent_only (bool) – return only the most recent parameter values.

  • group (Optional[str]) – If the group is given then only the parameters from this group are returned.

Return type:

Dict[str, Union[List[Dict], List[str]]]

Returns:

A dictionary with the keys “data” and “columns” that can easily be converted to a data frame. The “data” are a list of dictionaries each holding a parameter value. The “columns” are the keys in the “data” dictionaries and are returned in the preferred display order.