Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BIAP: CoordinateImage API #1084

Merged
merged 2 commits into from
Feb 14, 2022
Merged

BIAP: CoordinateImage API #1084

merged 2 commits into from
Feb 14, 2022

Conversation

effigies
Copy link
Member

This branch culminates ~6 months of intermittent tinkering and revision of the concepts needed to support data sampled to surfaces. The particular use cases of CIFTI-2 and MNE's STC formats have driven a CoordinateAxis model that describes an axis that describes a sequence of sub-sampled surfaces and (raveled) volumes.

Test implementations exist in another branch, but the target of this branch is simply to merge the BIAP to render in the docs.

This branch culminates ~6 months of intermittent tinkering and revision
of the concepts needed to support data sampled to surfaces. The
particular use cases of CIFTI-2 and MNE's STC formats have driven a
CoordinateAxis model that describes an axis that describes a sequence of
sub-sampled surfaces and (raveled) volumes.

Test implementations exist in another branch, but the target of this
branch is simply to merge the BIAP to render in the docs.

For posterity, here are the squashed commit messages:

DOC: First pass at SurfaceImage BIAP

DOC: Address suggestions

DOC: Clarify use cases are motivating, not necessarily implementation target

DOC: Small updates

DOC: Update BIAP with a couple examples leading to further questions

DOC: Separate Geometry and Header objects

DOC: Smoothing example, typo

ENH: First pass at surfaceimage template classes

TEST: Build HDF5/Numpy-based surface classes

DOC: Add VolumeGeometry stub

DOC: Fix header formatting

TEST: Example FreeSurfer subject (not fitting into class hierarchy)

DOC: Add concatenable structure proposal

ENH: Add structure collection API

TEST: Rewrite FreeSurferSubject as GeometryCollection

ENH: Possible VolumeGeometry

STY: Geometry -> Pointset

Rename SurfaceGeometry to TriangularMesh

FIX: FreeSurfer example implementation

ENH: Flesh out VolumeGeometry

BIAP: Add SurfaceHeader.get_geometry() method

Rename Geometry -> Pointset

DOC: Commit current thinking on BIAP0009

RF: Remove test implementations for this branch
@codecov
Copy link

codecov bot commented Feb 14, 2022

Codecov Report

Merging #1084 (0bb3c02) into master (b8445fc) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1084   +/-   ##
=======================================
  Coverage   92.33%   92.33%           
=======================================
  Files          99       99           
  Lines       12217    12217           
  Branches     2391     2391           
=======================================
  Hits        11281    11281           
  Misses        612      612           
  Partials      324      324           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b8445fc...0bb3c02. Read the comment docs.

@effigies
Copy link
Member Author

Pre-test failures seem related to numpy/numpy#21052.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant