Dynamic Modeler Module with python?

Support
1

Slicer: 4.11.0-2020-07-04 r29204 Win10

I want to use Dynamic Modeler Module Plane Cut tool (and others) with python. Is there any documentation published?

Thanks.

2

No documentation pages have been published yet, although one should probably be created.

You can display all of the input node references for a tool using the following:

planeCutTool = slicer.vtkSlicerDynamicModelerPlaneCutTool()
for i in range(planeCutTool.GetNumberOfInputNodes()):
  print(planeCutTool.GetNthInputNodeReferenceRole(i))

The node references can be used to create a dynamic modeler node:

dynamicModelerNode = slicer.mrmlScene.AddNewNodeByClass("vtkMRMLDynamicModelerNode")
dynamicModelerNode.SetToolName("Plane cut")
dynamicModelerNode.SetNodeReferenceID("PlaneCut.InputModel", inputmodelNode.GetID())
dynamicModelerNode.SetNodeReferenceID("PlaneCut.InputPlane", inputPlaneNode.GetID())
dynamicModelerNode.SetNodeReferenceID("PlaneCut.OutputPositiveModel", outputModel.GetID())
slicer.modules.dynamicmodeler.logic().RunDynamicModelerTool(dynamicModelerNode)
1 Like
3

Thanks so much @Sunderlandkyl.
Just a bit more info:

  • I need to add more than one InputPlane
  • I should like to look around with Parameters (Operation Type)

Thanks on advance!

4

Sure, then you can use:

  • AddNodeReferenceID instead of SetNodeReferenceID for the plane node
  • SetAttribute(“OperationType”, type), where type is “Union”, “Intersection”, or “Difference”.
1 Like
5

It works like a charm, wonderfull.
Thanks

6

@Sunderlandkyl could you add these to the documentation in header files? Thank you!

1 Like
7

This has been very helpful, but if I wanted to create a new model for the output is there a way I could do that. Or a way to create an empty model I could output too.

8

You can create a new model node as any other node (slicer.mrmlScene.AddNewNodeByClass). See a complete example here.

9

A post was split to a new topic: Show/hide output model in Python script

10

Hi,

I am a new member.
Following your code in the case of curve cut tool I get:
CurveCut.InputModel
CurveCut.InputCurve
CurveCut.InsidePoint

But then, if i try to implement an analogous code (eg in a case of sphere with a closed curve resampled and constrained)
I get the error: ‘[VTK] Output node missing!’
Does this error indicate that’ plane cut’ example is not applicable in a ‘curve cut’ case or am I doing something wrong?
Here is the code I use:

inputModel = slicer.util.getNode(‘SphereModel’)
inputCurve = slicer.util.getNode(‘CC’)
insidePoint = slicer.util.getNode(‘F’)

outputPositive = slicer.mrmlScene.AddNewNodeByClass(“vtkMRMLModelNode”, “CutModel_Positive”)
outputPositive.CreateDefaultDisplayNodes()
outputNegative = slicer.mrmlScene.AddNewNodeByClass(“vtkMRMLModelNode”, “CutModel_Negative”)
outputNegative.CreateDefaultDisplayNodes()

dynamicModelerNode = slicer.mrmlScene.AddNewNodeByClass(“vtkMRMLDynamicModelerNode”)
dynamicModelerNode.SetToolName(“Curve cut”)
dynamicModelerNode.SetNodeReferenceID(“CurveCut.InputModel”, inputModel.GetID())
dynamicModelerNode.SetNodeReferenceID(“CurveCut.InputCurve”, inputCurve.GetID())
dynamicModelerNode.SetNodeReferenceID(“CurveCut.InsidePoint”, insidePoint.GetID())
dynamicModelerNode.SetNodeReferenceID(“CurveCut.OutputPositiveModel”, outputPositive.GetID())
dynamicModelerNode.SetNodeReferenceID(“CurveCut.OutputNegativeModel”, outputNegative.GetID())

dynamicModelerNode.SetAttribute(“StraightCut”, “true”)
dynamicModelerNode.SetAttribute(“Operation”, “Split”)
dynamicModelerNode.SetAttribute(“InsideSurface”, “true”)
dynamicModelerNode.SetAttribute(“OutsideSurface”, “true”)

slicer.modules.dynamicmodeler.logic().RunDynamicModelerTool(dynamicModelerNode)

Thanks in advance!