Plastimatch and Python Interactor

user1 · May 15, 2020, 1:47pm

Hello Community,

I have a (maybe easy) basic question to the Python Interactor in 3D Slicer/ SlicerRT. I want to know, which kind of the average Hausdorff-Distance the SlicerRT extension calculate (e.g. directed average or undirected average or undirected max average Hausdorff-distance).
Therefore I try to calculate the HD with the Python Interactor in 3D Slicer with the commands of Plastimatch (and compare with my manual calculation), but it doesn’t work. May somebody show me, how can I use the Plastimatch-commands in the Interactor (e.g. get_avg_average_hausdorff)?

Thank you very much!

gcsharp · May 15, 2020, 2:32pm

Unfortunately you can’t call plastimatch functions from python. Those functions are not python wrapped. But you can see which functions are called here:

github.com

SlicerRt/SlicerRT/blob/master/SegmentComparison/Logic/vtkSlicerSegmentComparisonModuleLogic.cxx#L471


// Compute Hausdorff distances

double checkpointHausdorffStart = timer->GetUniversalTime();

UNUSED_VARIABLE(checkpointHausdorffStart); // Although it is used later, a warning is logged so needs to be suppressed

Hausdorff_distance hausdorff;

hausdorff.set_reference_image(plmRefSegmentLabelmap->itk_uchar());

hausdorff.set_compare_image(plmCmpSegmentLabelmap->itk_uchar());

hausdorff.set_volume_boundary_behavior(ZERO_PADDING);

hausdorff.run();



double maximumHausdorffDistanceForBoundaryMm = hausdorff.get_boundary_hausdorff();

double averageHausdorffDistanceForBoundaryMm = hausdorff.get_avg_average_boundary_hausdorff();

double percent95HausdorffDistanceForBoundaryMm = hausdorff.get_percent_boundary_hausdorff();

parameterNode->SetMaximumHausdorffDistanceForVolumeMm(hausdorff.get_hausdorff());

parameterNode->SetMaximumHausdorffDistanceForBoundaryMm(maximumHausdorffDistanceForBoundaryMm);

parameterNode->SetAverageHausdorffDistanceForVolumeMm(hausdorff.get_avg_average_hausdorff());

parameterNode->SetAverageHausdorffDistanceForBoundaryMm(averageHausdorffDistanceForBoundaryMm);

parameterNode->SetPercent95HausdorffDistanceForVolumeMm(hausdorff.get_percent_hausdorff());

parameterNode->SetPercent95HausdorffDistanceForBoundaryMm(percent95HausdorffDistanceForBoundaryMm);

parameterNode->HausdorffResultsValidOn();



// Set results to table node

user1 · May 15, 2020, 3:01pm

Thanks for the quick answer.

So did I understood it right, that the average HD in Slicer represent the sum of all minimum distances from the external contour-pixels/ voxels of one contour/ segment to the pixel/ voxel of the external border of the other contour divided by the number of pixels from the first contour (or sum of all pixels of both contours?)? = directed average HD
After that the same steps are repeated for the other contour and the sum of both (directed) distances divided by 2 or did Slicer take the maximum of the two directed distances? = undirected average HD

Thanks in advance!

gcsharp · May 15, 2020, 7:45pm

It works like this:

For each boundary point of the compare image, find the closest boundary point on the reference image. Then take the average of these distances.
For each boundary point of the reference image, find the closest boundary point on the compare image. Then take the average of these distances.
Take the average of the numbers computed in step 1 and step 2.

lassoan · May 16, 2020, 4:26am

All computations that Slicer can perform are accessible from Python, too.

For example, you can compute metric by calling SegmentComparison module logic and retrieve results from the associated vtkMRMLSegmentComparisonNode.

user1 · May 16, 2020, 8:07am

Thanks for the information.

Unfortunately I can’t call these SegmentComparison module logic’s (“std::string ComputeHausdorffDistances(vtkMRMLSegmentComparisonNode* parameterNode);”) in the Python-Interactor. First I included the “slicer includes”, after that I created a segmentation from a LabelMap-volume (created in segmentations-module) as you showed in a thread before: “https://www.slicer.org/wiki/Documentation/Nightly/ScriptRepository#Create_a_segmentation_from_a_labelmap_volume_and_display_in_3D” (is the “parameterNode” == this segmentation?).

May you can give me an example how I can input the syntax for this, please?

Thank you!

cpinter · May 17, 2020, 10:26am

Please note the signature of the function. It takes a vtkMRMLSegmentComparisonNode, which is a parameter set node containing the parameters of a segment comparison run. Now if you look at this class

github.com

SlicerRt/SlicerRT/blob/master/SegmentComparison/Logic/vtkMRMLSegmentComparisonNode.h#L58-L176


/// Get reference segmentation node

vtkMRMLSegmentationNode* GetReferenceSegmentationNode();

/// Set reference segmentation node

void SetAndObserveReferenceSegmentationNode(vtkMRMLSegmentationNode* node);



/// Get compare segmentation node

vtkMRMLSegmentationNode* GetCompareSegmentationNode();

/// Set compare segmentation node

void SetAndObserveCompareSegmentationNode(vtkMRMLSegmentationNode* node);



/// Get rasterization reference volume node

vtkMRMLScalarVolumeNode* GetRasterizationReferenceVolumeNode();

/// Set rasterization reference volume node

void SetAndObserveRasterizationReferenceVolumeNode(vtkMRMLScalarVolumeNode* node);



/// Get Dice table node

vtkMRMLTableNode* GetDiceTableNode();

/// Set Dice table node

void SetAndObserveDiceTableNode(vtkMRMLTableNode* node);

This file has been truncated. show original

then you’ll see what inputs you can set to it and what outputs you gan get after the calculation.

user1 · May 19, 2020, 12:25pm

Thanks for the help! Sorry, that I have to ask again to this…

First, I get every time an error message, when I want to get my reference segmentation node (segmentation* GetReferenceSegmentationNode();). Do I understood it right, that my “vtkMRMLSegmentationNode” = my active Segmentation (which contains the two segments for calculation of Hausdorff/ Dice…)?
Furthermore I get the error message, that the name “SetAndObserveReferenceSegmentationNode” is not defined, when I want to set my reference segmentation node…

May you show me my mistake or are there any special packages necessary, which I have to include/ install/ import?

cpinter · May 19, 2020, 1:07pm

This function from an actual working module should help:

github.com

SlicerRt/SegmentRegistration/blob/master/ProstateMRIUSContourPropagation/ProstateMRIUSContourPropagation.py#L1085-L1126


def calculateSegmentSimilarity(self):

  logging.info('Calculating prostate similarity')

  if self.usSegmentationNode is None or self.mrSegmentationNode is None:

    logging.error('Failed to get segmentations')

    return False



  # Calculate Dice, Hausdorff

  if self.segmentComparisonNode is None or self.segmentComparisonNode.GetScene() is None:

    self.segmentComparisonNode = slicer.vtkMRMLSegmentComparisonNode()

    self.segmentComparisonNode.SetName(slicer.mrmlScene.GenerateUniqueName('MRI-US_SegmentComparison'))

    slicer.mrmlScene.AddNode(self.segmentComparisonNode)

  if self.diceTableNode is None:

    self.diceTableNode = slicer.vtkMRMLTableNode()

    self.diceTableNode.SetName('Dice comparison results table')

    slicer.mrmlScene.AddNode(self.diceTableNode)

  if self.hausdorffTableNode is None:

    self.hausdorffTableNode = slicer.vtkMRMLTableNode()

    self.hausdorffTableNode.SetName('Hausdorff comparison results table')

    slicer.mrmlScene.AddNode(self.hausdorffTableNode)

  self.segmentComparisonNode.SetAndObserveDiceTableNode(self.diceTableNode)

This file has been truncated. show original

user1 · May 19, 2020, 3:57pm

OK, I think I got it, thank you very much!

I just have one more question to the segmentation node. May you explain me, what the “usSegmentationNode” or “mrSegmentationNode” is in your code:
self.segmentComparisonNode.SetAndObserveReferenceSegmentationNode(self.usSegmentationNode)
I thought this are the segments in the active segmentation…

cpinter · May 20, 2020, 9:21am

This particular module compares segments from two different segmentations, one done on ultrasound (US) and the other on MR.

user1 · May 20, 2020, 9:41am

ok, I mean what is the input of this module.
So how I get a “usSegmentationNode” and a “mrSegmentationNode”?
Do I need two different segmentations or is it enough to have two segments to compare in one segmentation?

cpinter · May 20, 2020, 10:09am

You can find information about this module here

There is a tutorial as well that shows you how it is used.

You can compare any two segments.

user1 · May 20, 2020, 12:21pm

Ah ok it is this module. Is there any way to compute the Hausdorff-distances with the “Segment Comparison” - module in the python interactor as you can see here:

I want to calculate the Hausdorff-distances for volume and not for boundary which is the default one in SlicerRT (in my example segment it would be probably the same as boundary HD, but I want to use the volume HD for an other case). Therefore I tried to do this with the python-interactor…

cpinter · May 20, 2020, 12:55pm

You have all the information for this above. Please take a look at the settings vtkMRMLSegmentComparisonNode offers.

lassoan · May 20, 2020, 2:12pm

By definition, Hausdorff distance is between boundary surfaces, so you have to provide them as inputs. Even if you think that the boundary is a trivial one, such as bone surface or skin surface, you still need to specify it (for example, by creating a segment with thresholding).

gcsharp · May 20, 2020, 4:16pm

As I understand, Hausdorff distance is defined between two sets. Surface boundary is most common, but it is not the only choice.

Spiros_Karkavitsas · February 24, 2023, 2:23pm

Hello everyone

I came across your discussion since I have a relative easy question to ask: I dowloaded the Plastimatch in 3D slicer and I would like to ask how I can use it to compare segmentations using the mean surface distance ?

I was trying to find a script online but I could not find any script which I can trust totally…

Thank you for your time reading my message:)

cpinter · February 24, 2023, 3:18pm

I assume this means that you installed the SlicerRT extension. I suggest you use the Segment Comparison module and use the mean Hausdorff metric to achieve the same result.

Spiros_Karkavitsas · February 24, 2023, 3:40pm

Hello and thanks for your answer.

As you said,yes I installed the extension in Slicer.

So regarding your answer, why the mean Hausdorff distance is the same as the mean surface distance ? The answer might be obvious but since I have not searched it yet,that is why I am asking.

Στις Παρ, 24 Φεβ 2023, 16:18 ο χρήστης Csaba Pinter via 3D Slicer Community <notifications@slicer.discoursemail.com> έγραψε:

Topic		Replies	Views
Segmentation Comparsion Support slicerrt	2	1513	December 11, 2019
Hausdorff distance calculation in SegmentComparison module Support slicerrt	20	5577	October 10, 2018
Missing module: Hausdorff distances, Dice similarity metrics Support registration , segmentation , extensions-manager	4	454	February 25, 2022
Selecting input nodes in Slicer RT's Segment Comparison Development segmentation , python	1	25	July 3, 2024
Distance between two segments Support	14	3490	November 11, 2020

Plastimatch and Python Interactor

Related topics