simpeg.utils.Counter#

class simpeg.utils.Counter[source]#

Bases: object

Class for recording iterations and operation times. Counter allows anything that calls it to record iterations and timings in a simple way.

Also has plotting functions that allow quick recalls of data.

Methods

`count`(prop)	Increases the count of the property.
`countTic`(prop)	Times a property call, this is the init call.
`countToc`(prop)	Times a property call, this is the end call.
`summary`()	Provides a text summary of the current counters and timers.

Examples

If you want to use this, import count or timeIt and use them as decorators on class methods.

>>> from simpeg.utils import Counter, count, timeIt

>>> class MyClass(object):
...     def __init__(self, url):
...         self.counter = Counter()
...     @count
...     def MyMethod(self):
...         pass
...     @timeIt
...     def MySecondMethod(self):
...         pass

>>> c = MyClass('blah')
>>> for i in range(100): c.MyMethod()
>>> for i in range(300): c.MySecondMethod()
>>> c.counter.summary()
Counters:
  MyClass.MyMethod                        :      100
Times:                                        mean      sum
  MyClass.MySecondMethod                  : 9.08e-07, 2.72e-04,  300x