From e3c7a548caffab7399f7f101d8f44b90dc7e5c30 Mon Sep 17 00:00:00 2001 From: rly Date: Thu, 26 Sep 2024 13:15:28 -0700 Subject: [PATCH] Update changelog --- CHANGELOG.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 803a044..2ae03b7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,19 +1,21 @@ # Changelog for ndx-pose -## ndx-pose 0.2.0 (July 19, 2024) +## ndx-pose 0.2.0 (September 26, 2024) ### Major changes - Added support for storing training data in the new `PoseTraining` neurodata type and other new types. @roomrys, @CBroz1, @rly, @talmo, @eberrigan (#7, #21, #24) -- Deprecated the `nodes` and `edges` constructor arguments and fields from the `PoseEstimation` neurodata type. - Instead: - - Create a `Skeleton` object with those nodes and edges. - - Create a `Skeletons` container object and pass the `Skeleton` object to that. - - Add the `Skeletons` object to your "behavior" processing module (at the same level as the `PoseEstimation` object). - - Pass the `Skeleton` object to the `PoseEstimation` constructor. - Data from ndx-pose < 0.2.0 can still be read; a temporary `Skeleton` object with name "subject" will be created - and the `nodes` and `edges` fields will be populated with the data from the `PoseEstimation` object. @rly - (#7, #24, #33) +- Deprecated the `nodes` and `edges` constructor arguments and fields from the `PoseEstimation` neurodata type to + support linking to the same `Skeleton` object from a `PoseEstimation` object and pose training data. + @rly (#7, #24, #33) + - Data from `ndx-pose` versions before `0.2.0` can still be read; a temporary `Skeleton` object with name + "subject" will be created and the `nodes` and `edges` fields will be populated with the data from + the `PoseEstimation` object. + - Instead of using the `nodes` and `edges` fields, you should now use a `Skeleton` object: + - Create a `Skeleton` object with those nodes and edges. + - Create a `Skeletons` container object and pass the `Skeleton` object to that. + - Add the `Skeletons` object to your "behavior" processing module (at the same level as the `PoseEstimation` object). + - Pass the `Skeleton` object to the `PoseEstimation` constructor. - Added ability to link a `PoseEstimation` object to one or more camera devices. If the number of original videos, labeled videos, or dimensions does not equal the number of camera devices when creating the object not from a file, a `DeprecationWarning` will be raised. @rly (#33)