Modifications to Cardiac module or suggestion to module for annotation of geometrical components

I am new to 3D Slicer and I would like to use it to study the mitral valve from 3D echocardiography.
What I am looking for may already be an available extension, but I have not found it. What I would like is the cardiac module, with some modifications. Is it possible to add features to an extension? Currently, I am using a Matlab GUI that i have developed to extract geometrical components, but the view manipulation and volume viewing are not as good as in 3D Slicer. Therefore, it would be nice to incorporate some of my features in a module if it is not already an available extension.

I want to extract the cardiac components for all time-frames in the cardiac cycle. In the end I want to export the components as CSV’s or similar to run Matlab codes on the components. However, to do so I need it in a specific format, and I also want to be able to annotate in a certain way. What I want to do is:

For each individual time-frame i want to annotate geometrical components. I want to extract them by annotating one component at a time and store it based on the current frame in terms of 3D coordinates. E.g. I would like to extract the posteromedial papillary muscle head location from frame 1:end, before annotating the other papillary muscles. (I like this way of annotating because then I am able to follow the individual component through the cycle). Then as i move through time I also want the annotated components in that time-frame to be plotted in the volume. I also want to be able to delete and modify annotated features. (E.g. if i have annotated 10 points around the annular circumference I want the possibility to move through time and only modify the locations of e.g. the annular point at the anterior horn to update the annular spline.)

I want to be able to turn on e.g. Annulus mode, and then the extension should store the points in the current time frame and also plot in the current time frame.

Here is a Pseudocode of what i want to do for one of the features. May be easier to understand.

get Frame
get Points %annotated on volume

append the Points to Annulus(frame) if anything is annotated
if Annulus(frame) contains more than X points
    create spline of annulus points

in current time frame:
plot Annular points
plot Spline

store Annular points at that time frame in CSV or structure

if delete/modify mode
get Point
find  index of Point closest to Annulus(frame) points
delete  or swap Annulus(frame).index

update and plot

Yes. Entire 3D Slicer and all extensions are open-source and freely usable and modifiable, customizable, extensible.

You can annotate one slice (add points, curves, etc.) then use Sequences module to create a time sequence of each annotation that you want to specify for each time point: click the green + button to create a new sequence, then select the node (e.g., curve node) as proxy node and check the “Save changes” checkbox to sautomatically save the current state of the node for each time point of the image sequence.

This should work well. When you step to the next image frame (Ctrl+Shift+Right-arrow) then the current position of the node is copied to this new frame, so you can just adjust the position of the papillary muscle tip.

You can replay all the time-varying nodes in slice and 3D views, make adjustments, etc., so this should be no problem at all.

You can use “Valve annulus analysis” module of SlicerHeart extension to very quickly and accurately define the annulus curve. It still uses slightly older markups infrastructure (at that time closed curves were not available, therefore we used markups fiducial points to designate a curve), and the module may be a bit heavyweight if all you need is the annulus curve and you want to mark it on many image frames. Therefore, you may consider using the “Valve View” module instead, which allows quick marking of annulus contour points by automatically rotating the views around the annulus axis when a curve point is placed.

Markups are saved as json by default. A time sequence of a markup will be saved in a zip file (with .mrb file extension that you can rename to .zip and unzip it). You can easily parse this json file and save the point coordinates into a csv file - see example here.

On a side note: Using Matlab made sense 5-10 years ago, but Python has become so much better in so many aspects that Matlab is no longer relevant in all but a few niche applications. By switching to Python you will start acquiring essential skills (Python programming experience is expected for most R&D jobs nowadays), you get access to several magnitudes more tools and libraries, get much more opportunity to find collaborators and share your work with others so that you can make an impact.

Thank you very much for this detailed response.
Some follow up questions:

When I annotate the annulus at one time-instance using fiducials, how do I store those points in a sequence? There are many choices for the Proxy Node, and can I select all annotated points for that sequence?
Fiducials_OneTime. Can I mark all these points (attached figure) and store them in one individual sequence? Currently I am not able to do so.

As mentioned, I want to annotate all time-frames. Therefore, I only want the annotated annulus at each individual time frame to be plotted in slicer view. Now, when I annotate using fiducials, the annular points remain plotted when I move forward in time. Same with the annular curves when I use the "Valve annulus analysis” module of SlicerHeart extension. But this might be because I have not entirely understood how to use sequences.

The ideal situation would be to enter an annotation module that understands and reads the current frame. And based on the frame and the chosen anatomical component, we are able to store the points and also plot them in their respective frame. I have started to create this now but are trying to figure out how to:

Is there a way to extract the current frame based on
Is it possible to extract the annulus at all time-frames and additionally store them based on the volume name so that it can be accessed and plotted when opening the volume in this “mode”?

Thanks again!

Use a Closed Curve markup node for annulus curve. Choose this curve node as proxy node.

Sequences module does exactly this. You just need to add a sequence node to the image sequence’s browser node and set the markups curve as a proxy node.

These are all straightforward to do. See examples in the script repository.

Thanks again for the quick answer.

I found this code in the script repository:

     interactionNode =
     selectionNode =
     fiducialNode = slicer.vtkMRMLMarkupsFiducialNode()

This enables me to add new MarkupsFiducials, and also adds the annotated fiducials in a new category each time I run the code (MarkupsFiducial_1, MarkupsFiducial_2 etc) However, can I pre-define the name? And also append to one with a given name? I know this is possible in the Fiducial Registraion Wizard, but I want to define it in a module.

Let’s say I run the mentioned code above, but instead of getting a category names MarkupsFiducial_X I name it “Annulus”. And if i want to add more fiducial markers to that category i simply run the code again, and it appends the markers to the pre-named folder. I bet this is possible, but can not seem to find out how to do it.


You don’t need to create the markups fiducial using Python scripting - you can create it in Markups module (click on new closed curve button, double click on the new node in the tree below, and type annulus) or using the toolbar.

You must not create a new annulus node for each time point, because then you would not be able to synchronized recording/replay of the moving annulus curve and the moving image. Just create one annulus curve node and add it as a proxy node in sequences module (to the same sequence browser as the image). If you find this too complicated (create a new sequence then choose the curve node as proxy node) then let us know and then we’ll brainstorm about how to simplify the user interface to make this easier.

In a week or two, @smrolfe will integrate her markups improvements, which should further improve things for you: there will be a new dedicated markups toolbar that will make it easy to add/edit/switch between markups; and you will be able to predefine names for markup control points.

Thanks again for the reply!

I saw the Markups module, and it works nicely. I have tried it out more this morning, and it together with sequence module has the features that I was looking for. Is it possible though to display several modules at once? Let’s say cardiac view + Markups module?

I have gotten a bit more familiar with the sequence module now as well. However, I have some issues with the annular annotation for each time-step, at least when I use closed curve markups. The reason being that if annotate using one rotation axis, and during annotation alter this axis slightly by slicing in one of the two planes which control the rotation axis, I am not able to find the closed curve markup points because I now only see the curve. The same will be the issue when i annotate papillary muscles, as I might loose sight of the point if i slice through the plane.
Something I therefore wanted to implement was a swap point feature. Where I am able to enter a mode related to the Closed Curve, or simply Fiducial markers, and swap my annotated point with the point closest to it (at that time-frame). This would speed up the annotation process, and for the Closed Curve would make it independent of the rotation axis choice. Changing the rotation axis to be in the middle of the annulus often helps, but if we loose the control points to alter the Closed Curve this may not work well without a swap point mode.

For my purpose I have to be consistent with the placement of the points (near the same location), as I use the information as boundary conditions in finite element analysis of the mitral valve.

I am looking forward to the markups improvements.
Thanks again!

Valve view module remains active when you switch to a different module, so most likely you can just switch to markups module. If you have to access features from multiple modules then you can create a simple Python scripted module with a custom GUI, which contains all the GUI widgets that you need. There are high-level widgets, such as markups table or subject hierarchy tree.

To avoid any bias (caused by incorrect point marking in previous time point), it is probably safer to restart the curve from scratch for each time point. If you are not worried about bias and just want to slightly adjust the curve for each time point then you can go to Markups module / Control points section, enable “Click to jump slices” and check position of each point by clicking on it, then moving it in slice views (after you drag-and-dropped the point, you can click on it to show the new position in all other views).

You can insert points into a curve by Ctrl+Left-click and you could add a Python script that would observe the curve and remove the closest point to the new point, but probably the other solutions described above are better.

You can also compute the annulus curve positions and papillary muscle base positions automatically from a single frame, using Sequence Registration extension module (which can compute displacement field of across a 3D volume sequence). We tested this for the annulus markup on 4D ultrasound images and it worked very well.

It cannot track the leaflet motion though (as the displacement field is too discontinuous where the leaflets coapt), so if you need to track full leaflet motion then you need to segment the leaflets on each frame. We have neural networks for segmenting leaflets automatically that we will finalize and release during the upcoming Slicer Project week #35. This project week will be still virtual, so you should be able to join easily. We have lots of additional valve analysis tools that we are releasing progressively (as we complete studies and get the results published).