Skip to content

Commit a62e1a6

Browse files
authored
Add flowchart images to Object_methods.md
Added flowchart images to enhance the documentation of object methods in CanlabCore.
1 parent 7726072 commit a62e1a6

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

docs/Object_methods.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
CanlabCore is built around a small set of MATLAB classes that wrap neuroimaging data. Each class has **properties** (the data fields it stores — image values, masks, design matrices, region labels, etc.) and **methods** (the things you can do with that data — plot it, threshold it, run a t-test, render it on a brain surface, save it to disk). This page is the entry point to per-class documentation.
44

5+
![object types flowchart](overview_pngs/CANlab_object_types_flowchart.png)
6+
57
The design philosophy is interactive analysis with simple commands. A typical group analysis is a handful of one-liners:
68

79
```matlab
@@ -13,6 +15,7 @@ r = region(t); % connect blobs -> region object
1315
table(r); % atlas-labeled results table
1416
montage(r); % brain montage
1517
```
18+
![object types flowchart](overview_pngs/CANlab_ttest_flowchart.png)
1619

1720
Most user-facing image classes inherit from a common abstract base, `image_vector`, which stores image data as a flat `[voxels x images]` matrix in a `.dat` field with the inverse mapping back to 3-D space in `.volInfo`. This is what lets generic statistical / ML code operate on `.dat` while the class methods handle the spatial reconstruction transparently.
1821

0 commit comments

Comments
 (0)