Difference between revisions of "Documentation/Nightly/Developers/Tutorials/MemoryManagement"
(Made the memory management differences more clear between C++ and Python) |
|||
| Line 1: | Line 1: | ||
<noinclude>{{documentation/versioncheck}}</noinclude> | <noinclude>{{documentation/versioncheck}}</noinclude> | ||
| + | |||
| + | = Factory methods = | ||
Similarly to VTK, Slicer contains some "factory" methods: | Similarly to VTK, Slicer contains some "factory" methods: | ||
| Line 8: | Line 10: | ||
Factory methods return a pointer to a VTK object (with a reference count of 1) that the caller "owns", so the caller must take care of releasing the object to avoid memory leak. | Factory methods return a pointer to a VTK object (with a reference count of 1) that the caller "owns", so the caller must take care of releasing the object to avoid memory leak. | ||
| − | = Loadable modules (C++) = | + | == Loadable modules (C++) == |
If storing in a new variable: | If storing in a new variable: | ||
| Line 24: | Line 26: | ||
nodes->Delete(); | nodes->Delete(); | ||
| − | = Python scripts and scripted modules = | + | == Python scripts and scripted modules == |
Factory methods return an object that the caller owns (and thus the caller has to delete, with reference count >0) and Python adds an additional reference to this object when stored in a Python variable, resulting in a reference count of >1. To make sure that the object is deleted when the Python variable is deleted, we have to remove the additional reference that the factory method added. There is currently no automatic mechanism to remove that additional reference, so it has to be done manually by calling UnRegister (the reference count shouldn't be explicitly set to any specific value, it is only allowed to increment/decrement it using Register/UnRegister): | Factory methods return an object that the caller owns (and thus the caller has to delete, with reference count >0) and Python adds an additional reference to this object when stored in a Python variable, resulting in a reference count of >1. To make sure that the object is deleted when the Python variable is deleted, we have to remove the additional reference that the factory method added. There is currently no automatic mechanism to remove that additional reference, so it has to be done manually by calling UnRegister (the reference count shouldn't be explicitly set to any specific value, it is only allowed to increment/decrement it using Register/UnRegister): | ||
Revision as of 16:02, 31 October 2013
Home < Documentation < Nightly < Developers < Tutorials < MemoryManagement
|
For the latest Slicer documentation, visit the read-the-docs. |
Factory methods
Similarly to VTK, Slicer contains some "factory" methods:
- vtkMRMLScene::CreateNodeByClass() - vtkMRMLScene::GetNodesByClass() - ...
Factory methods return a pointer to a VTK object (with a reference count of 1) that the caller "owns", so the caller must take care of releasing the object to avoid memory leak.
Loadable modules (C++)
If storing in a new variable:
vtkSmartPointer<vtkCollection> nodes = vtkSmartPointer<vtkCollection>::Take(mrmlScene->GetNodesByClass("vtkMRMLLinearTransformNode"));
If the variable is created already:
vtkSmartPointer<vtkCollection> nodes;
nodes.TakeReference(mrmlScene->GetNodesByClass("vtkMRMLLinearTransformNode"));
Unsafe, legacy method without using smart pointers (not recommended, because the Delete() method may be forgotten or skipped due to an early return from the function):
vtkCollection* nodes = mrmlScene->GetNodesByClass("vtkMRMLLinearTransformNode");
...
nodes->Delete();
Python scripts and scripted modules
Factory methods return an object that the caller owns (and thus the caller has to delete, with reference count >0) and Python adds an additional reference to this object when stored in a Python variable, resulting in a reference count of >1. To make sure that the object is deleted when the Python variable is deleted, we have to remove the additional reference that the factory method added. There is currently no automatic mechanism to remove that additional reference, so it has to be done manually by calling UnRegister (the reference count shouldn't be explicitly set to any specific value, it is only allowed to increment/decrement it using Register/UnRegister):
nodes = slicer.mrmlScene.GetNodesByClass('vtkMRMLLinearTransformNode')
nodes.UnRegister(slicer.mrmlScene) # reference count is increased by both the factory method and the python reference; unregister to keep only the python reference
...
To avoid forgetting the UnRegister call, it is better to avoid factory methods whenever it is possible.
For example, instead of using the CreateNodeByClass factory method and call UnRegister manually:
n = slicer.mrmlScene.CreateNodeByClass('vtkMRMLViewNode')
slicer.mrmlScene.addNode(n)
n.UnRegister(slicer.mrmlScene)
this should be used (if the name of the node is known when the script is written):
n = slicer.mrmlScene.addNode(slicer.vtkMRMLViewNode())
or this should be used (if the name of the node is generated at runtime):
n = eval('slicer.mrmlScene.AddNode(slicer.%s())' % 'vtkMRMLViewNode')
