Example module that computes and plots the cross sectional area of each visible segment. Direction of cross-section can be picked.

SliceAreaPlot.py

import os
import unittest
import vtk, qt, ctk, slicer
from slicer.ScriptedLoadableModule import *
from array import array
import logging
import vtk.util.numpy_support
import numpy as np

#
# SliceAreaPlot
#
# Computes and plots the cross sectional area along a specified axis of all visible segments.
#

class SliceAreaPlot(ScriptedLoadableModule):
  """Uses ScriptedLoadableModule base class, available at:
  https://github.com/Slicer/Slicer/blob/master/Base/Python/slicer/ScriptedLoadableModule.py
  """

  def __init__(self, parent):
    ScriptedLoadableModule.__init__(self, parent)
    self.parent.title = "Slice Area Plot"
    self.parent.categories = ["Quantification"]
    self.parent.dependencies = []
    self.parent.contributors = ["Hollister Herhold (AMNH)"] 
    self.parent.helpText = """
This module computes the cross sectional area of a segment and plots it along the length of the segment.
(Initially. It should eventually do length, width, and breadth.)
"""
    self.parent.helpText += self.getDefaultModuleDocumentationLink()
    self.parent.acknowledgementText = """
This file was originally developed by Jean-Christophe Fillion-Robin, Kitware Inc.
and Steve Pieper, Isomics, Inc. and was partially funded by NIH grant 3P41RR013218-12S1.
""" # replace with organization, grant and thanks.

#
# SliceAreaPlotWidget
#

class SliceAreaPlotWidget(ScriptedLoadableModuleWidget):
  """Uses ScriptedLoadableModuleWidget base class, available at:
  https://github.com/Slicer/Slicer/blob/master/Base/Python/slicer/ScriptedLoadableModule.py
  """

  def setup(self):
    ScriptedLoadableModuleWidget.setup(self)

    # Instantiate and connect widgets ...

    #
    # Parameters Area
    #
    parametersCollapsibleButton = ctk.ctkCollapsibleButton()
    parametersCollapsibleButton.text = "Parameters"
    self.layout.addWidget(parametersCollapsibleButton)

    # Layout within the dummy collapsible button
    parametersFormLayout = qt.QFormLayout(parametersCollapsibleButton)

    #
    # input volume selector
    #
    self.inputSelector = slicer.qMRMLNodeComboBox()
    self.inputSelector.nodeTypes = ["vtkMRMLScalarVolumeNode"]
    self.inputSelector.selectNodeUponCreation = True
    self.inputSelector.addEnabled = False
    self.inputSelector.removeEnabled = False
    self.inputSelector.noneEnabled = False
    self.inputSelector.showHidden = False
    self.inputSelector.showChildNodeTypes = False
    self.inputSelector.setMRMLScene( slicer.mrmlScene )
    self.inputSelector.setToolTip( "Pick the input to the algorithm." )
    parametersFormLayout.addRow("Input Volume: ", self.inputSelector)

    #
    # Segmentation selector
    #
    self.segmentationSelector = slicer.qMRMLNodeComboBox()
    self.segmentationSelector.nodeTypes = ["vtkMRMLSegmentationNode"]
    self.segmentationSelector.selectNodeUponCreation = True
    self.segmentationSelector.addEnabled = False
    self.segmentationSelector.removeEnabled = False
    self.segmentationSelector.noneEnabled = False
    self.segmentationSelector.showHidden = False
    self.segmentationSelector.showChildNodeTypes = False
    self.segmentationSelector.setMRMLScene( slicer.mrmlScene )
    self.segmentationSelector.setToolTip( "Pick the segmentation for the algorithm." )
    parametersFormLayout.addRow("Segmentation: ", self.segmentationSelector)

    #
    # Direction selector
    #
    self.directionSelectorWidget = qt.QComboBox()
    self.directionSelectorWidget.setToolTip("Select the direction of sweep for area calculation.")
    self.directionSelectorWidget.addItem("Axial")
    self.directionSelectorWidget.addItem("Coronal")
    self.directionSelectorWidget.addItem("Saggital")
    parametersFormLayout.addRow("Direction:", self.directionSelectorWidget)

    #
    # Apply Button
    #
    self.applyButton = qt.QPushButton("Plot")
    self.applyButton.toolTip = "Make the plot(s)."
    self.applyButton.enabled = True
    parametersFormLayout.addRow(self.applyButton)

    # connections
    self.applyButton.connect('clicked(bool)', self.onApplyButton)
    self.inputSelector.connect("currentNodeChanged(vtkMRMLNode*)", self.onSelect)
    self.segmentationSelector.connect("currentNodeChanged(vtkMRMLNode*)", self.onSelect)
    self.directionSelectorWidget.connect("currentIndexChanged(int)", self.onSelect)

    # Add vertical spacer
    self.layout.addStretch(1)

    # Refresh Apply button state
    self.onSelect()

  def cleanup(self):
    pass

  def onSelect(self):
    inputVoxelNode = self.inputSelector.currentNode()
    if inputVoxelNode != None:
      self.segmentationNode = self.segmentationSelector.currentNode()
      self.direction = self.directionSelectorWidget.currentText

      if self.direction == "Saggital":
        self.numSlices = inputVoxelNode.GetImageData().GetDimensions()[0]
      if self.direction == "Coronal":
        self.numSlices = inputVoxelNode.GetImageData().GetDimensions()[1]
      if self.direction == "Axial":
        self.numSlices = inputVoxelNode.GetImageData().GetDimensions()[2]
      

  def onApplyButton(self):
    logic = SliceAreaPlotLogic()
    logic.run(self.numSlices, self.segmentationNode, self.direction)

#
# SliceAreaPlotLogic
#

class SliceAreaPlotLogic(ScriptedLoadableModuleLogic):
  """This class should implement all the actual
  computation done by your module.  The interface
  should be such that other python code can import
  this class and make use of the functionality without
  requiring an instance of the Widget.
  Uses ScriptedLoadableModuleLogic base class, available at:
  https://github.com/Slicer/Slicer/blob/master/Base/Python/slicer/ScriptedLoadableModule.py
  """

  def hasImageData(self,volumeNode):
    """This is an example logic method that
    returns true if the passed in volume
    node has valid image data
    """
    if not volumeNode:
      logging.debug('hasImageData failed: no volume node')
      return False
    if volumeNode.GetImageData() is None:
      logging.debug('hasImageData failed: no image data in volume node')
      return False
    return True

  def run(self, numSlices, segmentationNode, direction):
    """
    Run the actual algorithm
    """

    # Get visible segment ID list.
    # Get segment ID list
    visibleSegmentIds = vtk.vtkStringArray()
    segmentationNode.GetDisplayNode().GetVisibleSegmentIDs(visibleSegmentIds)
    if visibleSegmentIds.GetNumberOfValues() == 0:
      logging.debug("SliceAreaPlot will not return any results: there are no visible segments")

    #
    # Make a table and set the first column as the slice number. This is used
    # as the X axis for plots.
    #
    tableNode=slicer.mrmlScene.AddNewNodeByClass("vtkMRMLTableNode", "Segment quantification")
    table = tableNode.GetTable()
    sliceNumberArray = vtk.vtkFloatArray()

    sliceNumberArray = vtk.vtkFloatArray()
    sliceNumberArray.SetName("Slice number")
    table.AddColumn(sliceNumberArray)
    table.SetNumberOfRows(numSlices)
    for i in range(numSlices):
      table.SetValue(i, 0, i)

    # Make a plot chart node. Plot series nodes will be added to this in the
    # loop below that iterates over each segment.
    plotChartNode = slicer.mrmlScene.AddNewNodeByClass("vtkMRMLPlotChartNode")
    plotChartNode.SetTitle(direction + ' slice area')
    plotChartNode.SetXAxisTitle('Slice')
    plotChartNode.SetYAxisTitle('Area in mm^2')

    #
    # For each segment, get the area and put it in the table in a new column.
    #
    for segmentIndex in range(visibleSegmentIds.GetNumberOfValues()):
      segmentID = visibleSegmentIds.GetValue(segmentIndex)
      segmentName = segmentationNode.GetSegmentation().GetSegment(segmentID).GetName()
      vimage = segmentationNode.GetBinaryLabelmapRepresentation(segmentID)
      if direction == "Saggital":
        firstSlice = vimage.GetExtent()[0]
        lastSlice = vimage.GetExtent()[1]
      if direction == "Coronal":
        firstSlice = vimage.GetExtent()[2]
        lastSlice = vimage.GetExtent()[3]
      if direction == "Axial":
        firstSlice = vimage.GetExtent()[4]
        lastSlice = vimage.GetExtent()[5]

      # Get segment as numpy array. This results in one big one-dimensional array, in order, of all
      # voxel values.
      narray = vtk.util.numpy_support.vtk_to_numpy(vimage.GetPointData().GetScalars())

      #
      # Reshape the segment volume to have an array of slices. This resuls in a 2-dimensional
      # array, where the first index is into each slice and the second index is basically
      # a one-d array that contains all voxel data for that slice.
      #
      # The shape elements are as follows:
      #   (saggital, coronal, axial)
      vshape = vimage.GetDimensions()

      s = vshape[0]
      c = vshape[1]
      a = vshape[2]

      # Make into 3D array.
      narray_3D = narray.reshape((a, c, s))

      if direction == "Axial":
        narrayBySlice = narray_3D.reshape([-1,s*c])

      if direction == "Coronal":
        narrayBySlice = (narray_3D.swapaxes(0,1)).reshape(-1,s*a)
        
      if direction == "Saggital":
        narrayBySlice = (narray_3D.transpose()).reshape(-1,c*a)

      # Count number of >0 voxels for each slice
      narrayBySlicePositive = narrayBySlice[:]>0
      areaBySliceInVoxels = np.count_nonzero(narrayBySlicePositive, axis=1)

      # Convert number of voxels to area in mm2
      areaOfPixelMm2 = vimage.GetSpacing()[0] * vimage.GetSpacing()[1]

      areaBySliceInMm2 = areaBySliceInVoxels  * areaOfPixelMm2

      # Insert number of empty slices into front of array and back of array so that
      # array is whole extent of data
      numFrontSlices = firstSlice
      numBackSlices = numSlices - lastSlice
      areaBySliceInMm2 = np.insert(areaBySliceInMm2, np.zeros(numFrontSlices,), 0)
      areaBySliceInMm2 = np.append(areaBySliceInMm2, np.zeros(numBackSlices))

      # Convert back to a vtk array for insertion into the table.
      vtk_data_array = vtk.util.numpy_support.numpy_to_vtk(areaBySliceInMm2)
      vtk_data_array.SetName(segmentName)
      tableNode.AddColumn(vtk_data_array)

      # Make a plot series node for this column.
      plotSeriesNode = slicer.mrmlScene.AddNewNodeByClass("vtkMRMLPlotSeriesNode", segmentName)
      plotSeriesNode.SetAndObserveTableNodeID(tableNode.GetID())
      plotSeriesNode.SetXColumnName("Slice number")
      plotSeriesNode.SetYColumnName(segmentName)
      plotSeriesNode.SetUniqueColor()

      # Add this series to the plot chart node created above.
      plotChartNode.AddAndObservePlotSeriesNodeID(plotSeriesNode.GetID())
      

    #
    # Looping done - now all that's left to do is display it.
    #
    layoutManager = slicer.app.layoutManager()
    layoutWithPlot = slicer.modules.plots.logic().GetLayoutWithPlot(layoutManager.layout)
    layoutManager.setLayout(layoutWithPlot)

    # Select chart in plot view

    plotWidget = layoutManager.plotWidget(0)
    plotViewNode = plotWidget.mrmlPlotViewNode()
    plotViewNode.SetPlotChartNodeID(plotChartNode.GetID())

    return True


class SliceAreaPlotTest(ScriptedLoadableModuleTest):
  """
  This is the test case for your scripted module.
  Uses ScriptedLoadableModuleTest base class, available at:
  https://github.com/Slicer/Slicer/blob/master/Base/Python/slicer/ScriptedLoadableModule.py
  """

  def setUp(self):
    """ Do whatever is needed to reset the state - typically a scene clear will be enough.
    """
    slicer.mrmlScene.Clear(0)

  def runTest(self):
    """Run as few or as many tests as needed here.
    """
    self.setUp()
    self.test_SliceAreaPlot1()

  def test_SliceAreaPlot1(self):
    """ Ideally you should have several levels of tests.  At the lowest level
    tests should exercise the functionality of the logic with different inputs
    (both valid and invalid).  At higher levels your tests should emulate the
    way the user would interact with your code and confirm that it still works
    the way you intended.
    One of the most important features of the tests is that it should alert other
    developers when their changes will have an impact on the behavior of your
    module.  For example, if a developer removes a feature that you depend on,
    your test should break so they know that the feature is needed.
    """

    self.delayDisplay("Starting the test")
    #
    # first, get some data
    #
    import urllib
    downloads = (
        ('http://slicer.kitware.com/midas3/download?items=5767', 'FA.nrrd', slicer.util.loadVolume),
        )

    for url,name,loader in downloads:
      filePath = slicer.app.temporaryPath + '/' + name
      if not os.path.exists(filePath) or os.stat(filePath).st_size == 0:
        logging.info('Requesting download %s from %s...\n' % (name, url))
        urllib.urlretrieve(url, filePath)
      if loader:
        logging.info('Loading %s...' % (name,))
        loader(filePath)
    self.delayDisplay('Finished with download and loading')

    volumeNode = slicer.util.getNode(pattern="FA")
    logic = SliceAreaPlotLogic()
    self.assertIsNotNone( logic.hasImageData(volumeNode) )
    self.delayDisplay('Test passed!')