Mock data

A collection of functions for generating mock data.

Wrapper functions

pyimpspec.generate_mock_circuits(identifier, **kwargs)

Generate the circuits used by the generate_mock_data function.

Parameters:

• identifier (str) – See generate_mock_data() for details.

• **kwargs – See generate_mock_data() for details.

Return type:

List[Circuit]

pyimpspec.generate_mock_data(identifier, **kwargs)

Generate impedance spectra either from a set of pre-defined equivalent circuits or a circuit description code.

Parameters:

• identifier (str) – An identifier that corresponds to one of the predefined equivalent circuits. If the string contains the * wildcard, then the string is split into fragments and valid identifiers containing all the fragments are returned. For example, CIRCUIT_7* returns the immittance spectra corresponding to the predefined equivalent circuits with the identifiers CIRCUIT_7 and CIRCUIT_7_INVALID. If no matches can be found (e.g., if an empty string is provided), then a list of valid identifiers will be printed. The identifiers are case-sensitive. If the identifier is not valid, then an attempt will be made to parse it as if it were a circuit description code.

• **kwargs –

  Keyword arguments to use when simulating an immittance spectrum. Valid keys include:

  • log_max_f: the logarithm of the highest frequency.

  • log_min_f: the logarithm of the lowest frequency.

  • num_per_decade: the number of points per decade.

  • noise: the amount of noise to add (as a percentage of \(|Z|\)).

  • seed: the seed for the pseudo-random number generator.

  • drift: if there is an element that exhibits drift, then it will be multiplied by this factor.

Return type:

List[DataSet]