LSSTApplications
17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
|
Functions | |
def | logPairs (obj, pairs, logLevel=Log.DEBUG) |
def | logInfo (obj, prefix, logLevel=Log.DEBUG) |
def | timeMethod (func) |
def lsst.pipe.base.timer.logInfo | ( | obj, | |
prefix, | |||
logLevel = Log.DEBUG |
|||
) |
Log timer information to ``obj.metadata`` and ``obj.log``. Parameters ---------- obj : `lsst.pipe.base.Task`-type A `~lsst.pipe.base.Task` or any other object with these two attributes: - ``metadata`` an instance of `lsst.daf.base.PropertyList`` (or other object with ``add(name, value)`` method). - ``log`` an instance of `lsst.log.Log`. prefix Name prefix, the resulting entries are ``CpuTime``, etc.. For example timeMethod uses ``prefix = Start`` when the method begins and ``prefix = End`` when the method ends. logLevel : optional Log level (an `lsst.log` level constant, such as `lsst.log.Log.DEBUG`). Notes ----- Logged items include: - ``Utc``: UTC date in ISO format (only in metadata since log entries have timestamps). - ``CpuTime``: System + User CPU time (seconds). This should only be used in differential measurements; the time reference point is undefined. - ``MaxRss``: maximum resident set size. All logged resource information is only for the current process; child processes are excluded.
Definition at line 62 of file timer.py.
def lsst.pipe.base.timer.logPairs | ( | obj, | |
pairs, | |||
logLevel = Log.DEBUG |
|||
) |
Log ``(name, value)`` pairs to ``obj.metadata`` and ``obj.log`` Parameters ---------- obj : `lsst.pipe.base.Task`-type A `~lsst.pipe.base.Task` or any other object with these two attributes: - ``metadata`` an instance of `lsst.daf.base.PropertyList`` (or other object with ``add(name, value)`` method). - ``log`` an instance of `lsst.log.Log`. pairs : sequence A sequence of ``(name, value)`` pairs, with value typically numeric. logLevel : optional Log level (an `lsst.log` level constant, such as `lsst.log.Log.DEBUG`).
Definition at line 34 of file timer.py.
def lsst.pipe.base.timer.timeMethod | ( | func | ) |
Decorator to measure duration of a task method. Parameters ---------- func The method to wrap. Notes ----- Writes various measures of time and possibly memory usage to the task's metadata; all items are prefixed with the function name. .. warning:: This decorator only works with instance methods of Task, or any class with these attributes: - ``metadata``: an instance of `lsst.daf.base.PropertyList` (or other object with ``add(name, value)`` method). - ``log``: an instance of `lsst.log.Log`. Examples -------- To use:: import lsst.pipe.base as pipeBase class FooTask(pipeBase.Task): pass @pipeBase.timeMethod def run(self, ...): # or any other instance method you want to time pass