Skip to content

Commit

Permalink
Add doc for BranchTimepointsFeature
Browse files Browse the repository at this point in the history
  • Loading branch information
stefanhahmann committed Jan 15, 2025
1 parent fd992a7 commit 0866523
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ Mastodon Deep Lineage is an extension of Mastodon. For the full documentation of
|--------------------------------------|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|
| Branch N Leaves | _idem_ | The total number of leaves of a branch spot in the whole track subtree of this branch spot. <br><br> Example visualization: ![branchNLeavesAnimation.gif](doc/features/branch/branchNLeavesAnimation.gif) | ![](doc/features/branch/branchNLeaves.png) |
| Branch N Successors and Predecessors | _idem_ | Total number of successors and predecessors of a branch spot in the whole track subtree of this branch spot. <br><br> Example visualization: <br> Successors (encodes reproductivity) ![branchNSuccessorsAnimation.gif](doc/features/branch/branchNSuccessorsAnimation.gif) <br> Predecessors (encodes generation) ![branchNPredecessorsAnimation.gif](doc/features/branch/branchNPredecessorsAnimation.gif) | ![](doc/features/branch/branchNSuccessorsPredecessors.png) |
| Branch Start and End Timepoints | _idem_ | The first timepoint and the last timepoint of a branch spot. <br><br> Example visualization: <br> First timepoint ![branchFirstTimepoint.gif](doc/features/branch/branchFirstTimepoint.gif) <br> Last timepoint ![branchLastTimepoint.gif](doc/features/branch/branchLastTimepoint.gif) | ![](doc/features/branch/branchNSuccessorsPredecessors.png) |
| Branch Sinuosity | _idem_ | The sinuosity of a spot during its life span (cf. [Sinuosity](https://en.wikipedia.org/wiki/Sinuosity)), i.e. how much the track represented by the branch is curved. Values close to 1: almost straight movement. Values significantly higher than 1: winding or meandering movement. Positive infinity (∞), if the spot is at the end at the same position as at the beginning, but has moved in between. <br><br> Example visualization: ![branchSinuosityAnimation.gif](doc/features/branch/branchSinuosityAnimation.gif) | ![](doc/features/branch/branchSinuosityEquation.gif) |
| Branch Average Movement | _idem_ | The average movement per frame of a spot during its life span. Example visualization: ![branchAverageMovementAnimation.gif](doc/features/branch/branchAverageMovementAnimation.gif) | ![](doc/features/branch/branchAverageMovementEquation.gif) <br><br> e.g.: <br><br> ![](doc/features/branch/branchAverageMovement.png) |
| Branch Movement Direction | _idem_ | The movement direction of a branch spot represented as a normalized directional vector pointing from the start (spot) position to the end (spot) position of the BranchSpot. <br><br> Example visualizations: <br> x-component ![branchMovementDirectionXAnimation.gif](doc/features/branch/branchMovementDirectionXAnimation.gif) <br> y-component ![branchMovementDirectionYAnimation.gif](doc/features/branch/branchMovementDirectionYAnimation.gif) <br> z-component ![branchMovementDirectionZAnimation.gif](doc/features/branch/branchMovementDirectionZAnimation.gif) | ![](doc/features/branch/branchMovementDirectionEquation.gif) |
Expand Down
Binary file added doc/features/branch/branchFirstTimepoint.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/features/branch/branchLastTimepoint.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0866523

Please sign in to comment.