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

Release notes 6.4 #2022

Merged
merged 10 commits into from
Apr 20, 2023
41 changes: 41 additions & 0 deletions docs/about/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,46 @@
# Release Notes

## ShapeWorks 6.4.0 - 2023-03-??
### What is new?
* **ShapeWorks Back-end**
* New shapeworks 'analyze' command for offline analysis of shape models
* Improved free form constraints that now support doubly connected areas (e.g. donut-like)
* Data Portal migrated to new ShapeWorks Cloud and swcc (ShapeWorks Cloud Client) tool
* ShapeWorks can now be used as a 3rd party library ([details here](../dev/shapeworks-library.md))
* Added support for 'save_init_splits' and 'checkpointing_interval' parameters in the project spreadsheet formats
* Added new JSON based file format for storing ShapeWorks projects (swproj)
* Added a unified logging library for ShapeWorks (spdlog)
* Uniform numerical computation of specificity across platforms
* **ShapeWorks Front-end**
* Studio can now automatically check for updates and prompt the user to download them
* Improved progress bar in Studio is more representative and also estimates time remaining
* Added ability to arbitrarily scale difference arrows in Studio
* Added file association support for swproj file extension on Windows and Mac
* New multi-level analysis feature in Studio ([details here](../studio/studio-analyze.md#multi-level-pca))
* Added ability to hide/show particles per domain
* **User's Support**
* Hip Use Case: The use case uses the hip joint to demonstrate the capability of ShapeWorks
to capture inter-domain correlations and interactions directly on triangular surface meshes.
The use case showcases calculating the alignment options available for multiple organ anatomies.
([details here](../use-cases/mesh-based/hip.md))
* Added options to the incremental use case when run in --interactive mode, including sorting method,
initial model size, and incremental batch size. The sorting method determines how the shapes are sorted
to be added incrementally. There are three options: random, median, distribution.
([detauls here](../use-cases/multistep/incremental_supershapes.md))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo:
([details here](../use-cases/multistep/incremental_supershapes.md))

* [Python API documentation](../python/python-api.md) has been added to the ShapeWorks documentation site

### Fixes
* Fix Studio python problem causing crash on group differences (#1781)
* Fix Studio slow/hanging on certain free form constraints (#1817, #1801)
* Fix crashes on certain projects (#1800, #1815)
* Fix procrustes with multi-domain models (#1755)
* Fixed crashes in groom due to multi-threading (#1944)

## ShapeWorks 6.3.2 - 2022-10-04
### Fixes

* Fix install_shapeworks.sh on Linux (#1883)


## ShapeWorks 6.3.1 - 2022-07-22

Expand Down
2 changes: 2 additions & 0 deletions docs/studio/studio-analyze.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ The PCA tab of the View panel shows reconstructed shapes (surface meshes) along

![ShapeWorks Studio Analysis View Panel PCA Display](../img/studio/studio_analyze_view_pca.png)

### Multi-Level PCA

The PCA tab of the View panel shows options to select modes of variation in different subspaces when a multiple domain shape model is loaded:
![ShapeWorks Studio Analysis View Panel PCA Display for Multiple-Domain Shape Model](../img/studio/studio_analyze_view_pca_multiple_domain.png)

Expand Down