Package com.xinapse.apps.cardiac

Interface CardiacAnalysis

All Known Implementing Classes:
SelectableCardiacAnalysis
public interface CardiacAnalysis
An interface implemented by classes that can perform cardiac analysis.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    CardiacAnalysis.SpecifierPanel
    A JPanel that can be used to specify cardiac analysis parameters.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAME
    The name of CardiacAnalysis.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    doAnalysis(com.xinapse.apps.cardiac.CardiacFrame parentFrame, RadialDivider[] radialDividers, Integer endoEpicardialSplitPercent, ROI[][][] rois, ReadableImage[] inputImages, boolean contiguousTimes, int nTimePoints, int nCols, int nRows, float pixelXSize, float pixelYSize, float pixelZSize, MonitorWorker worker)
    Do the cardiac analysis.
    String
    getAnalysisDescription()
    Returns a String describing this cardiac analysis.
    String
    getAnalysisName()
    Returns the name of the analysis.
    void
    reportAnalysis(com.xinapse.apps.cardiac.CardiacFrame parentFrame)
    Create a report on the analysis performed.

  • Field Details

  • Method Details

    • getAnalysisName

      String getAnalysisName()
      Returns the name of the analysis.
      Returns:
      the name of the cardiac analysis.

    • getAnalysisDescription

      String getAnalysisDescription()
      Returns a String describing this cardiac analysis.
      Returns:
      a String describing this cardiac analysis.

    • doAnalysis

      void doAnalysis(com.xinapse.apps.cardiac.CardiacFrame parentFrame, RadialDivider[] radialDividers, Integer endoEpicardialSplitPercent, ROI[][][] rois, ReadableImage[] inputImages, boolean contiguousTimes, int nTimePoints, int nCols, int nRows, float pixelXSize, float pixelYSize, float pixelZSize, MonitorWorker worker) throws InvalidArgumentException, InvalidImageException, ROIException, CancelledException
      Do the cardiac analysis.
      Parameters:
      parentFrame - if non-null, the CardiacFrame that initiated the analysis.
      radialDividers - an array of RadialDivider - one for every physical image slice.
      endoEpicardialSplitPercent - if non-null, the percentage split between endo- and epi-cardial subregions.
      rois - an array of ROIs. The first index refers to the physical slice number, the second to the time point and the third to the ROI.
      inputImages - the array of input images. There may be more than one input image - either one per time point, or one per physical slice.
      contiguousTimes - true if time points are contiguous in the input image(s).
      nTimePoints - the number of time points in the input image(s).
      nCols - the number of columns of pixels in the input image(s).
      nRows - the number of rows of pixels in the input image(s).
      pixelXSize - the pixel width in mm.
      pixelYSize - the pixel height in mm.
      pixelZSize - the pixel depth (slice thickness) in mm.
      worker - if non-null, the MonitorWorker that can be used to check for cancellation by the user.
      Throws:
      InvalidArgumentException - if any of the arguments is invalid.
      InvalidImageException - if any of the input images is invalid.
      ROIException - if an error occurs while processing the ROIs.
      CancelledException - if the operation is cancelled by the user via the MonitorWorker.

    • reportAnalysis

      void reportAnalysis(com.xinapse.apps.cardiac.CardiacFrame parentFrame)
      Create a report on the analysis performed.
      Parameters:
      parentFrame - if non-null, the CardiacFrame that initiated the analysis.