cbadc.utilities.pickle_dump

cbadc.utilities.pickle_dump(object_to_be_pickled, filename: str)[source]

Convenience function to pickle an object.

In principle all class instances in this package can be pickled to a file for later use.

For example this includes:

  • analog signal instances,

  • analog system instances,

  • digital control instance,

  • simulation instances,

  • and digital estimator instances.

Parameters
  • object_to_be_pickled (any) – a pickleable object

  • filename (str) – the path for it to be stored.