| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| [[fswiki|top]] | [[fswiki|AnatomiCuts]] |
| Line 4: | Line 4: |
| This method finds corresponding clusters across subjects. Currently only one-to-one cluster's correspondences are available using the Hungarian algorithm. | This method finds corresponding clusters across subjects. Currently, only one-to-one cluster's correspondences are available using the Hungarian algorithm. |
| Line 9: | Line 9: |
| A use case analysis merely addresses the most obvious of questions: who needs the software, and what are they going to do with it. | The Hungarian algorithm finds corresponding clusters between two subjects. |
| Line 11: | Line 11: |
|
=== Actors (Users) === In UML terminology, the persons (or software agents) external to a software component are called the actors. |
{{{ AnatomiCuts_correspondences -s1 segmentation1.nii.gz -s2 segmentation2.nii.gz -c numClusters -h1 clusteringPath1 -h2 clusteringPath2 -m metric -o output.csv }}} |
| Line 14: | Line 15: |
|
==== Research ==== === Scenarios (Use Cases) === These establish the framework for test cases. They also bring out the vocabulary of the system. This vocabulary is defined in the Terms section following these scenarios. ==== Use Case #1 ==== ==== Use Case #2 ==== ==== Use Case #3 ==== ==== Use Case #4 ==== === Terms === The following is a list of some of the vocabulary used in the preceding scenarios, plus terms that are common across the system in which the software is used. == Requirements == === General Requirements === === Specific Requirements === == Implementation == === API === === System Architecture and Primary Components === === Classes === === Collaboration and Sequence Diagrams === UML diagrams describing the time-course of the objects composing the executable. === Properties === Here are listed the configurable properties of the executable. These can be configurables read from a configuration file, or configurables hard-coded into the source code. == Test Plan == === Introduction === Tests should cover the following categories of testing. ==== Functional ==== This type of test ascertains whether the software executes its basic functionality under optimal conditions. ==== Boundary ==== This type of test determines the breaking points of the software, and whether the software gracefully handles input near and beyond these boundaries. ==== Stability ==== This type of test determines long-term behavior of the software: whether is has a memory leak, or prone to crashes which are not repeatable in any single run of any of the other tests. ==== Performance ==== These tests produce benchmarks on the performance of the software. |
-s1 the segmentation to be used for anatomical similarity in subject one. -s2 the segmentation to be used for anatomical similarity in subject one. -h1 the path to the AnatomiCuts folder to be used for subject1. -h2 the path to the AnatomiCuts folder to be used for subject2. -m metric to be used: labels (anatomical similarity) or euclid (euclidean similarity). -sym (under development) this flag will mirror the segmentation in subject 2 to find between hemisphere correspondences. -o output csv file |
AnatomiCuts correspondences
This method finds corresponding clusters across subjects. Currently, only one-to-one cluster's correspondences are available using the Hungarian algorithm.
The Hungarian algorithm
The Hungarian algorithm finds corresponding clusters between two subjects.
AnatomiCuts_correspondences -s1 segmentation1.nii.gz -s2 segmentation2.nii.gz -c numClusters -h1 clusteringPath1 -h2 clusteringPath2 -m metric -o output.csv
-s1 the segmentation to be used for anatomical similarity in subject one. -s2 the segmentation to be used for anatomical similarity in subject one. -h1 the path to the AnatomiCuts folder to be used for subject1. -h2 the path to the AnatomiCuts folder to be used for subject2. -m metric to be used: labels (anatomical similarity) or euclid (euclidean similarity). -sym (under development) this flag will mirror the segmentation in subject 2 to find between hemisphere correspondences. -o output csv file