Merge branch 'Back-RoM-tasks' into All_orientations

ResearchKit/ActiveTasks/ORKForwardBendingRangeOfMotionStep.h

@@ -0,0 +1,42 @@
+/*
+ Copyright (c) 2016, Darren Levy. All rights reserved.
+ Copyright (c) 2018, Dr David W. Evans. All rights reserved.
+ 
+ Redistribution and use in source and binary forms, with or without modification,
+ are permitted provided that the following conditions are met:
+ 
+ 1.  Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+ 
+ 2.  Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation and/or
+ other materials provided with the distribution.
+ 
+ 3.  Neither the name of the copyright holder(s) nor the names of any contributors
+ may be used to endorse or promote products derived from this software without
+ specific prior written permission. No license is granted to the trademarks of
+ the copyright holders even if such marks are included in this software.
+ 
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+
+#import "ORKRangeOfMotionStep.h"
+
+
+/**
+ The `ORKForwardBendingRangeOfMotionStep` class represents a step that takes a range of motion measurement for standing forward bending, while holding the device against the chest in either the left or right hand.
+ */
+ORK_CLASS_AVAILABLE
+@interface ORKForwardBendingRangeOfMotionStep : ORKRangeOfMotionStep
+
+@end

ResearchKit/ActiveTasks/ORKForwardBendingRangeOfMotionStep.m

@@ -0,0 +1,44 @@
+/*
+ Copyright (c) 2016, Darren Levy. All rights reserved.
+ Copyright (c) 2018, Dr David W. Evans. All rights reserved.
+ 
+ Redistribution and use in source and binary forms, with or without modification,
+ are permitted provided that the following conditions are met:
+ 
+ 1.  Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+ 
+ 2.  Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation and/or
+ other materials provided with the distribution.
+ 
+ 3.  Neither the name of the copyright holder(s) nor the names of any contributors
+ may be used to endorse or promote products derived from this software without
+ specific prior written permission. No license is granted to the trademarks of
+ the copyright holders even if such marks are included in this software.
+ 
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+
+#import "ORKForwardBendingRangeOfMotionStep.h"
+#import "ORKForwardBendingRangeOfMotionStepViewController.h"
+#import "ORKHelpers_Internal.h"
+
+
+@implementation ORKForwardBendingRangeOfMotionStep
+
++ (Class)stepViewControllerClass {
+    return [ORKForwardBendingRangeOfMotionStepViewController class];
+}
+
+@end

ResearchKit/ActiveTasks/ORKForwardBendingRangeOfMotionStepViewController.h

@@ -0,0 +1,42 @@
+/*
+ Copyright (c) 2016, Darren Levy. All rights reserved.
+ Copyright (c) 2018, Dr David W. Evans. All rights reserved.
+ 
+ Redistribution and use in source and binary forms, with or without modification,
+ are permitted provided that the following conditions are met:
+ 
+ 1.  Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+ 
+ 2.  Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation and/or
+ other materials provided with the distribution.
+ 
+ 3.  Neither the name of the copyright holder(s) nor the names of any contributors
+ may be used to endorse or promote products derived from this software without
+ specific prior written permission. No license is granted to the trademarks of
+ the copyright holders even if such marks are included in this software.
+ 
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+
+#import "ORKRangeOfMotionStepViewController.h"
+
+
+/**
+ This class overrides its parent's result because here a start result of 0 degrees would mean the device is at a 90 degree angle. Furthermore, device rotation during forward bending is the opposite to that during the knee and shoulder range of motion tasks.
+ */
+ORK_CLASS_AVAILABLE
+@interface ORKForwardBendingRangeOfMotionStepViewController : ORKRangeOfMotionStepViewController
+
+@end

ResearchKit/ActiveTasks/ORKForwardBendingRangeOfMotionStepViewController.m

@@ -0,0 +1,164 @@
+/*
+ Copyright (c) 2016, Darren Levy. All rights reserved.
+ Copyright (c) 2018, Dr David W. Evans. All rights reserved.
+ 
+ Redistribution and use in source and binary forms, with or without modification,
+ are permitted provided that the following conditions are met:
+ 
+ 1.  Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+ 
+ 2.  Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation and/or
+ other materials provided with the distribution.
+ 
+ 3.  Neither the name of the copyright holder(s) nor the names of any contributors
+ may be used to endorse or promote products derived from this software without
+ specific prior written permission. No license is granted to the trademarks of
+ the copyright holders even if such marks are included in this software.
+ 
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+
+#import "ORKForwardBendingRangeOfMotionStepViewController.h"
+
+#import "ORKRangeOfMotionResult.h"
+#import "ORKStepViewController_Internal.h"
+
+#import "ORKCustomStepView_Internal.h"
+#import "ORKActiveStepViewController_Internal.h"
+#import "ORKDeviceMotionRecorder.h"
+#import "ORKActiveStepView.h"
+#import "ORKProgressView.h"
+
+
+#define radiansToDegrees(radians) ((radians) * 180.0 / M_PI)
+#define allOrientationsForPitch(x, w, y, z) (atan2(2.0 * (x*w + y*z), 1.0 - 2.0 * (x*x + z*z)))
+#define allOrientationsForRoll(x, w, y, z) (atan2(2.0 * (y*w - x*z), 1.0 - 2.0 * (y*y + z*z)))
+#define allOrientationsForYaw(x, w, y, z) (asin(2.0 * (x*y - w*z)))
+
+@interface ORKRangeOfMotionContentView : ORKActiveStepCustomView {
+    NSLayoutConstraint *_topConstraint;
+}
+
+@property (nonatomic, strong, readonly) ORKProgressView *progressView;
+
+@end
+
+
+@interface ORKForwardBendingRangeOfMotionStepViewController () <ORKDeviceMotionRecorderDelegate> {
+    ORKRangeOfMotionContentView *_contentView;
+    UITapGestureRecognizer *_gestureRecognizer;
+    CMAttitude *_referenceAttitude;
+    UIInterfaceOrientation _orientation;
+}
+
+@end
+
+
+@implementation ORKForwardBendingRangeOfMotionStepViewController
+
+- (void)viewDidLoad {
+    [super viewDidLoad];
+    _contentView = [ORKRangeOfMotionContentView new];
+    _contentView.translatesAutoresizingMaskIntoConstraints = NO;
+    self.activeStepView.activeCustomView = _contentView;
+    _gestureRecognizer = [[UITapGestureRecognizer alloc] initWithTarget:self action:@selector(handleTap:)];
+    [self.activeStepView addGestureRecognizer:_gestureRecognizer];
+}
+//This function records the angle of the device when the screen is tapped
+- (void)handleTap:(UIGestureRecognizer *)sender {
+    [self calculateAndSetAngles];
+    [self finish];
+}
+
+- (void)calculateAndSetAngles {
+    _startAngle = ([self getDeviceAngleInDegreesFromAttitude:_referenceAttitude]);
+
+    //This function calculates maximum and minimum angles recorded by the device
+    if (_newAngle > _maxAngle) {
+        _maxAngle = _newAngle;
+    }
+    if (_minAngle == 0.0 || _newAngle < _minAngle) {
+        _minAngle = _newAngle;
+    }
+}
+
+#pragma mark - ORKDeviceMotionRecorderDelegate
+
+- (void)deviceMotionRecorderDidUpdateWithMotion:(CMDeviceMotion *)motion {
+    if (!_referenceAttitude) {
+        _referenceAttitude = motion.attitude;
+    }
+    CMAttitude *currentAttitude = [motion.attitude copy];
+
+    [currentAttitude multiplyByInverseOfAttitude:_referenceAttitude];
+
+    double angle = [self getDeviceAngleInDegreesFromAttitude:currentAttitude];
+
+    //This function shifts the range of angles reported by the device from +/-180 degrees to -90 to +270 degrees, which should be sufficient to cover all achievable forward bending ranges of motion
+    BOOL shiftAngleRange = angle < -90 && angle >= -180;
+    if (shiftAngleRange) {
+        _newAngle = 360 - fabs(angle);
+    } else {
+        _newAngle = angle;
+    }
+
+    [self calculateAndSetAngles];
+}
+
+/*
+ When the device is in Portrait mode, we need to get the attitude's pitch
+ to determine the device's angle. attitude.pitch doesn't return all
+ orientations, so we use the attitude's quaternion to calculate the
+ angle.
+ */
+- (double)getDeviceAngleInDegreesFromAttitude:(CMAttitude *)attitude {
+    if (!_orientation) {
+        _orientation = [UIApplication sharedApplication].statusBarOrientation;
+    }
+    double angle;
+    if (UIInterfaceOrientationIsLandscape(_orientation)) {
+        double x = attitude.quaternion.x;
+        double w = attitude.quaternion.w;
+        double y = attitude.quaternion.y;
+        double z = attitude.quaternion.z;
+        angle = radiansToDegrees(allOrientationsForRoll(x, w, y, z));
+    } else {
+        double x = attitude.quaternion.x;
+        double w = attitude.quaternion.w;
+        double y = attitude.quaternion.y;
+        double z = attitude.quaternion.z;
+        angle = radiansToDegrees(allOrientationsForPitch(x, w, y, z));
+    }
+    return angle;
+}
+
+#pragma mark - ORKActiveTaskViewController
+
+- (ORKResult *)result {
+    ORKStepResult *stepResult = [super result];
+
+    ORKRangeOfMotionResult *result = [[ORKRangeOfMotionResult alloc] initWithIdentifier:self.step.identifier];
+    result.start = _startAngle - 90.0;
+    result.finish = result.start + _newAngle;
+    result.minimum = result.start + _minAngle;
+    result.maximum = result.start + _maxAngle;
+    result.range = fabs(result.maximum - result.minimum);
+
+    stepResult.results = [self.addedResults arrayByAddingObject:result] ? : @[result];
+
+    return stepResult;
+}
+
+@end

ResearchKit/ActiveTasks/ORKNeckExtensionRangeOfMotionStep.h

@@ -0,0 +1,42 @@
+/*
+ Copyright (c) 2016, Darren Levy. All rights reserved.
+ Copyright (c) 2018, Dr David W. Evans. All rights reserved.
+ 
+ Redistribution and use in source and binary forms, with or without modification,
+ are permitted provided that the following conditions are met:
+ 
+ 1.  Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+ 
+ 2.  Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation and/or
+ other materials provided with the distribution.
+ 
+ 3.  Neither the name of the copyright holder(s) nor the names of any contributors
+ may be used to endorse or promote products derived from this software without
+ specific prior written permission. No license is granted to the trademarks of
+ the copyright holders even if such marks are included in this software.
+ 
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+
+#import "ORKRangeOfMotionStep.h"
+
+
+/**
+ The `ORKNeckFlexionRangeOfMotionStep` class represents a step that takes a range of motion measurement for side (lateral) bending to the left or right side while standing, and holding the device against the chest in the opposite hand.
+ */
+ORK_CLASS_AVAILABLE
+@interface ORKNeckExtensionRangeOfMotionStep : ORKRangeOfMotionStep
+
+@end

ResearchKit/ActiveTasks/ORKNeckExtensionRangeOfMotionStep.m

@@ -0,0 +1,44 @@
+/*
+ Copyright (c) 2016, Darren Levy. All rights reserved.
+ Copyright (c) 2018, Dr David W. Evans. All rights reserved.
+ 
+ Redistribution and use in source and binary forms, with or without modification,
+ are permitted provided that the following conditions are met:
+ 
+ 1.  Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+ 
+ 2.  Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation and/or
+ other materials provided with the distribution.
+ 
+ 3.  Neither the name of the copyright holder(s) nor the names of any contributors
+ may be used to endorse or promote products derived from this software without
+ specific prior written permission. No license is granted to the trademarks of
+ the copyright holders even if such marks are included in this software.
+ 
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+
+#import "ORKNeckExtensionRangeOfMotionStep.h"
+#import "ORKNeckExtensionRangeOfMotionStepViewController.h"
+#import "ORKHelpers_Internal.h"
+
+
+@implementation ORKNeckExtensionRangeOfMotionStep
+
++ (Class)stepViewControllerClass {
+    return [ORKNeckExtensionRangeOfMotionStepViewController class];
+}
+
+@end