Note
HOM performance monitor submodules, classes and methods report time and memory statistics in milliseconds and bytes respectively.
Methods ¶
cancel()
Stop the profile from recording timed events and remove it from the performance monitor.
Raises hou.OperationFailed if the profile is not active, that is, the profile is neither recording nor paused.
exportAsCSV(file_path)
Export the profile statistics to disk using a comma-separated (CSV) format. The exported .csv file can be loaded into a spreadsheet application such as Microsoft Excel and used to generate graphs.
Raises hou.OperationFailed if the profile is still active or if the .csv file could not be written to disk (i.e. permission problems).
id()
→ int
Return the profile’s unique identifier which is used internally by the performance monitor.
isActive()
→ bool
Return True if the profile is either recording events or is paused.
isRecordingCookStats()
→ bool
Return True if the profile is recording cook events and statistics.
isRecordingPDGCookStats()
→ bool
Return True if the profile is recording PDG node cook events and statistics.
isRecordingDrawStats()
→ bool
Return True if the profile is recording draw events and statistics.
isRecordingErrors()
→ bool
Return True if the profile is recording errors.
isRecordingFrameStats()
→ bool
Return True if the profile is recording frame events and statistics.
isRecordingGPUDrawStats()
→ bool
Return True if the profile is recording GPU draw events and statistics.
isRecordingRenderStats()
→ bool
Return True if the profile is recording statistics related to rendering.
isRecordingScriptStats()
→ bool
Return True if the profile is recording script events and statistics.
isRecordingSolveStats()
→ bool
Return True if the profile is recording simulation solver events and statistics.
isRecordingThreadStats()
→ bool
Return True if the profile is recording thread statistics.
isRecordingViewportStats()
→ bool
Return True if the profile is recording viewport events and statistics.
isPaused()
→ bool
Return True if the profile is paused from recording.
pause()
Pause the profile from recording events and statistics.
Raises hou.OperationFailed if the profile is stopped or already paused.
resume()
Unpause the profile so that it can record events and statistics.
Raises hou.OperationFailed if the profile is stopped or is already recording (i.e. not paused).
save(file_path)
This method is deprecated in favor of hou.perfMon.saveProfile.
stats()
Return the profile statistics in JSON format.
Raises hou.OperationFailed if the profile is still active and has not generated any statistics.
stop()
Stop the profile from recording and generate statistics for the events that it has already recorded.
Raises hou.OperationFailed if the profile is not active.
title()
→ str
Return the profile title.
See also |