Pariece McKinney
789 lines
48 KiB
Objective-C
789 lines
48 KiB
Objective-C
/*
|
|
Copyright (c) 2015, Apple Inc. 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 <UIKit/UIKit.h>
|
|
#import <ResearchKit/ORKOrderedTask.h>
|
|
|
|
|
|
@class ORKNavigableOrderedTask;
|
|
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
@interface ORKOrderedTask (ORKPredefinedActiveTask)
|
|
|
|
/**
|
|
Returns a predefined Amsler Grid task that helps in detecting problems in user's vision.
|
|
|
|
In an Amsler Grid task, the participant is shown a square grid. The participant is asked to mark the areas where they notice disctortions in the grid.
|
|
|
|
Data collected by the task is in the form of an `ORKAmslerGridResult` object.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data collected.
|
|
If the value of this parameter is `nil`, the default localized text is displayed.
|
|
@param options Options that affect the features of the predefined task.
|
|
*/
|
|
+ (ORKNavigableOrderedTask *)amslerGridTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription: (nullable NSString *)intendedUseDescription
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
/**
|
|
Returns a predefined task that measures the upper extremity function.
|
|
|
|
In a hole peg test task, the participant is asked to fill holes with pegs.
|
|
|
|
A hole peg test task can be used to assess arm and hand function, especially in patients with severe disability.
|
|
|
|
Data collected in this task is in the form of an `ORKHolePegTestResult` object.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data
|
|
collected. If the value of this parameter is `nil`, the default
|
|
localized text will be displayed.
|
|
@param dominantHand The participant dominant hand that will be tested first.
|
|
@param numberOfPegs The number of pegs to place in the pegboard.
|
|
@param threshold The threshold value used for the detection area.
|
|
@param rotated A test variant that also requires peg rotation.
|
|
@param timeLimit The duration allowed to validate the peg position.
|
|
@param options Options that affect the features of the predefined task.
|
|
|
|
@return An active hole peg test task that can be presented with an `ORKTaskViewController` object.
|
|
*/
|
|
+ (ORKNavigableOrderedTask *)holePegTestTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
dominantHand:(ORKBodySagittal)dominantHand
|
|
numberOfPegs:(int)numberOfPegs
|
|
threshold:(double)threshold
|
|
rotated:(BOOL)rotated
|
|
timeLimit:(NSTimeInterval)timeLimit
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
|
|
/**
|
|
Returns a predefined task that consists of a fitness check.
|
|
|
|
In a fitness check task, the participant is asked to walk for a specified duration
|
|
(typically several minutes). During this period, various sensor data is collected and returned by
|
|
the task view controller's delegate. Sensor data can include accelerometer, device motion,
|
|
pedometer, location, and heart rate data where available.
|
|
|
|
At the conclusion of the walk, if heart rate data is available, the participant is asked to sit
|
|
down and rest for a period. Data collection continues during this period.
|
|
|
|
By default, the task includes an instruction step that explains what the user needs to do during
|
|
the task, but this can be excluded with `ORKPredefinedTaskOptionExcludeInstructions`.
|
|
|
|
Data collected from this task can be used to compute measures of general fitness.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data
|
|
collected. If the value of this parameter is `nil`, the default
|
|
localized text is displayed.
|
|
@param walkDuration The duration of the walk (the maximum is 10 minutes).
|
|
@param restDuration The duration of the post walk rest period.
|
|
@param options Options that affect the features of the predefined task.
|
|
|
|
@return An active fitness check task that can be presented with an `ORKTaskViewController` object.
|
|
*/
|
|
+ (ORKOrderedTask *)fitnessCheckTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
walkDuration:(NSTimeInterval)walkDuration
|
|
restDuration:(NSTimeInterval)restDuration
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
/**
|
|
Returns a predefined task that consists of a 6 Minute Walk Test (6MWT).
|
|
|
|
In a 6MWT task, the participant is asked to walk as far as they can in a 6 minute interval.
|
|
During this period, various sensor data is collected and returned by the task view controller's
|
|
delegate. Sensor data can include accelerometer, device motion, pedometer, location, and
|
|
heart rate data where available.
|
|
|
|
By default, the task includes an instruction step that explains what the user needs to do during
|
|
the task, but this can be excluded with `ORKPredefinedTaskOptionExcludeInstructions`.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data
|
|
collected. If the value of this parameter is `nil`, the default
|
|
localized text is displayed.
|
|
@param options Options that affect the features of the predefined task.
|
|
|
|
@return A 6 Minute Walk Test task that can be presented with an `ORKTaskViewController` object.
|
|
*/
|
|
+ (ORKOrderedTask *)sixMinuteWalkTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
options:(ORKPredefinedTaskOption)options API_AVAILABLE(ios(14.0));
|
|
|
|
/**
|
|
Returns a predefined task that consists of a Tecumseh Cube Test.
|
|
|
|
In a Tecumseh Cube Task task, the participant is asked to step up and down onto 20cm high
|
|
step or block for 3 minutes, and then prompted to result for 3 minutes. During this period,
|
|
various sensor data is collected and returned by the task view controller's delegate. Sensor
|
|
data can include accelerometer, device motion, pedometer, location, and heart rate data
|
|
where available.
|
|
|
|
By default, the task includes an instruction step that explains what the user needs to do during
|
|
the task, but this can be excluded with `ORKPredefinedTaskOptionExcludeInstructions`.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data
|
|
collected. If the value of this parameter is `nil`, the default
|
|
localized text is displayed.
|
|
@param audioBundleIdentifier The identifier for the bundle in which the audio file can be found.
|
|
@param audioResourceName The name of the audio file to be played.
|
|
@param audioFileExtension The file extension for the audio file to be played.
|
|
@param options Options that affect the features of the predefined task.
|
|
|
|
@return An active Tecumseh Cube Test task that can be presented with an `ORKTaskViewController` object.
|
|
*/
|
|
+ (ORKOrderedTask *)tecumsehCubeTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
audioBundleIdentifier:(NSString *)audioBundleIdentifier
|
|
audioResourceName:(NSString *)audioResourceName
|
|
audioFileExtension:(nullable NSString*)audioFileExtension
|
|
options:(ORKPredefinedTaskOption)options API_AVAILABLE(ios(14.0));
|
|
|
|
/**
|
|
Returns a predefined task that consists of a short walk.
|
|
|
|
In a short walk task, the participant is asked to walk a short distance, which may be indoors.
|
|
Typical uses of the resulting data are to assess stride length, smoothness, sway, or other aspects
|
|
of the participant's gait.
|
|
|
|
The presentation of the short walk task differs from the fitness check task in that the distance is
|
|
replaced by the number of steps taken, and the walk is split into a series of legs. After each leg,
|
|
the user is asked to turn and reverse direction.
|
|
|
|
The data collected by this task can include accelerometer, device motion, and pedometer data.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data
|
|
collected. If the value of this parameter is `nil`, the default
|
|
localized text is displayed.
|
|
@param numberOfStepsPerLeg The number of steps the participant is asked to walk. If the
|
|
pedometer is unavailable, a distance is suggested and a suitable
|
|
count down timer is displayed for each leg of the walk.
|
|
@param restDuration The duration of the rest period. When the value of this parameter is
|
|
nonzero, the user is asked to stand still for the specified rest
|
|
period after the turn sequence has been completed, and baseline
|
|
data is collected.
|
|
@param options Options that affect the features of the predefined task.
|
|
|
|
@return An active short walk task that can be presented with an `ORKTaskViewController` object.
|
|
*/
|
|
+ (ORKOrderedTask *)shortWalkTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
numberOfStepsPerLeg:(NSInteger)numberOfStepsPerLeg
|
|
restDuration:(NSTimeInterval)restDuration
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
/**
|
|
Returns a predefined task that consists of a short walk back and forth.
|
|
|
|
In a short walk task, the participant is asked to walk a short distance, which may be indoors.
|
|
Typical uses of the resulting data are to assess stride length, smoothness, sway, or other aspects
|
|
of the participant's gait.
|
|
|
|
The presentation of the back and forth walk task differs from the short walk in that the participant
|
|
is asked to walk back and forth rather than walking in a straight line for a certain number of steps.
|
|
|
|
The participant is then asked to turn in a full circle and then stand still.
|
|
|
|
This task is intended to allow the participant to walk in a confined space where the participant
|
|
does not have access to a long hallway to walk in a continuous straight line. Additionally, by asking
|
|
the participant to turn in a full circle and then stand still, the activity can access balance and
|
|
concentration.
|
|
|
|
The data collected by this task can include accelerometer, device motion, and pedometer data.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data
|
|
collected. If the value of this parameter is `nil`, the default
|
|
localized text is displayed.
|
|
@param walkDuration The duration of the walking period.
|
|
@param restDuration The duration of the rest period. When the value of this parameter is
|
|
nonzero, the user is asked to stand still for the specified rest
|
|
period after the turn sequence has been completed, and baseline
|
|
data is collected.
|
|
@param options Options that affect the features of the predefined task.
|
|
|
|
@return An active short walk task that can be presented with an `ORKTaskViewController` object.
|
|
*/
|
|
+ (ORKOrderedTask *)walkBackAndForthTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
walkDuration:(NSTimeInterval)walkDuration
|
|
restDuration:(NSTimeInterval)restDuration
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
|
|
/**
|
|
The knee range of motion task returns a task that measures the range of motion for either a left or right knee.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param limbOption Which knee is being measured.
|
|
@param intendedUseDescription A localized string describing the intended use of the data collected. If the value of this parameter is `nil`, default localized text is used.
|
|
@param options Options that affect the features of the predefined task.
|
|
*/
|
|
+ (ORKOrderedTask *)kneeRangeOfMotionTaskWithIdentifier:(NSString *)identifier
|
|
limbOption:(ORKPredefinedTaskLimbOption)limbOption
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
|
|
/**
|
|
The shoulder range of motion task returns a task that measures the range of motion for either a left or right shoulder.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param limbOption Which shoulder is being measured.
|
|
@param intendedUseDescription A localized string describing the intended use of the data collected. If the value of this parameter is `nil`, default localized text is used.
|
|
@param options Options that affect the features of the predefined task.
|
|
*/
|
|
+ (ORKOrderedTask *)shoulderRangeOfMotionTaskWithIdentifier:(NSString *)identifier
|
|
limbOption:(ORKPredefinedTaskLimbOption)limbOption
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
|
|
/**
|
|
Returns a predefined task that enables an audio recording WITH a check of the audio level.
|
|
|
|
In an audio recording task, the participant is asked to make some kind of sound
|
|
with their voice, and the audio data is collected.
|
|
|
|
An audio task can be used to measure properties of the user's voice, such as
|
|
frequency range, or the ability to pronounce certain sounds.
|
|
|
|
If `checkAudioLevel == YES` then a navigation rule is added to do a simple check of the background
|
|
noise level. If the background noise is too loud, then the participant is instructed to move to a
|
|
quieter location before trying again.
|
|
|
|
Data collected in this task consists of audio information.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data
|
|
collected. If the value of this parameter is `nil`, default
|
|
localized text is used.
|
|
@param speechInstruction Instructional content describing what the user needs to do when
|
|
recording begins. If the value of this parameter is `nil`,
|
|
default localized text is used.
|
|
@param shortSpeechInstruction Instructional content shown during audio recording. If the value of
|
|
this parameter is `nil`, default localized text is used.
|
|
@param duration The length of the count down timer that runs while audio data is
|
|
collected.
|
|
@param recordingSettings See "AV Foundation Audio Settings Constants" for possible values.
|
|
@param checkAudioLevel If `YES` then add navigational rules to check the background noise level.
|
|
@param options Options that affect the features of the predefined task.
|
|
|
|
@return An active audio task that can be presented with an `ORKTaskViewController` object.
|
|
*/
|
|
+ (ORKNavigableOrderedTask *)audioTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
speechInstruction:(nullable NSString *)speechInstruction
|
|
shortSpeechInstruction:(nullable NSString *)shortSpeechInstruction
|
|
duration:(NSTimeInterval)duration
|
|
recordingSettings:(nullable NSDictionary *)recordingSettings
|
|
checkAudioLevel:(BOOL)checkAudioLevel
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
|
|
/**
|
|
Returns a predefined task that consists of two finger tapping (Optionally with a hand specified)
|
|
|
|
In a two finger tapping task, the participant is asked to rhythmically and alternately tap two
|
|
targets on the device screen.
|
|
|
|
A two finger tapping task can be used to assess basic motor capabilities including speed, accuracy,
|
|
and rhythm.
|
|
|
|
Data collected in this task includes touch activity and accelerometer information.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data
|
|
collected. If the value of this parameter is `nil`, the default
|
|
localized text will be displayed.
|
|
@param duration The length of the count down timer that runs while touch data is
|
|
collected.
|
|
@param handOptions Options for determining which hand(s) to test.
|
|
@param options Options that affect the features of the predefined task.
|
|
|
|
@return An active two finger tapping task that can be presented with an `ORKTaskViewController` object.
|
|
*/
|
|
+ (ORKOrderedTask *)twoFingerTappingIntervalTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
duration:(NSTimeInterval)duration
|
|
handOptions:(ORKPredefinedTaskHandOption)handOptions
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
|
|
/**
|
|
Returns a predefined task that tests spatial span memory.
|
|
|
|
In a spatial span memory task, the participant is asked to repeat pattern sequences of increasing
|
|
length in a game-like environment. You can use this task to assess visuospatial memory and
|
|
executive function.
|
|
|
|
|
|
In each round of the task, an array of
|
|
target images are shown in a grid (by default, the images are flowers). The round consists of a
|
|
demonstration phase and an interactive phase. In the demonstration phase, some of the flowers
|
|
change color in a specific sequence. After the demonstration, the user is asked to tap the flowers
|
|
in the same sequence for the interactive phase.
|
|
|
|
The span (that is, the length of the pattern sequence) is automatically varied during the task,
|
|
increasing after users succeed and decreasing after they fail, within the range specified by
|
|
minimum and maximum values that you specify. You can also customize the speed of sequence playback
|
|
and the shape of the tap target.
|
|
|
|
A spatial span memory task finishes when the user has either completed the maximum number of tests
|
|
or made the maximum number of errors.
|
|
|
|
Data collected by the task is in the form of an `ORKSpatialSpanMemoryResult` object.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data
|
|
collected. If the value of this parameter is `nil`, the default
|
|
localized text is displayed.
|
|
@param initialSpan The sequence length of the initial memory pattern.
|
|
@param minimumSpan The minimum pattern sequence length.
|
|
@param maximumSpan The maximum pattern sequence length.
|
|
@param playSpeed The time per sequence item; a smaller value means faster sequence
|
|
play.
|
|
@param maximumTests The maximum number of rounds to conduct.
|
|
@param maximumConsecutiveFailures The maximum number of consecutive failures the user can make before
|
|
the task is terminated.
|
|
@param customTargetImage The image to use for the task. By default, and if the value of this
|
|
parameter is `nil`, the image is a flower. To supply a custom
|
|
image, create a template image to which iOS adds the tint color.
|
|
@param customTargetPluralName The name associated with `customTargetImage`; by default, the value
|
|
of this parameter is @"flowers".
|
|
@param requireReversal A Boolean value that indicates whether to require the user to tap
|
|
the sequence in reverse order.
|
|
@param options Options that affect the features of the predefined task.
|
|
|
|
@return An active spatial span memory task that can be presented with an `ORKTaskViewController` object.
|
|
*/
|
|
+ (ORKOrderedTask *)spatialSpanMemoryTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
initialSpan:(NSInteger)initialSpan
|
|
minimumSpan:(NSInteger)minimumSpan
|
|
maximumSpan:(NSInteger)maximumSpan
|
|
playSpeed:(NSTimeInterval)playSpeed
|
|
maximumTests:(NSInteger)maximumTests
|
|
maximumConsecutiveFailures:(NSInteger)maximumConsecutiveFailures
|
|
customTargetImage:(nullable UIImage *)customTargetImage
|
|
customTargetPluralName:(nullable NSString *)customTargetPluralName
|
|
requireReversal:(BOOL)requireReversal
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
/**
|
|
Returns a predefined Stroop task that tests participants selective attention and cognitive flexibility.
|
|
|
|
In a stroop task, the participant is shown a text. The text is a name of a color, but the text is printed in a color that may or may not be denoted by the name. In each attempt of the task, the participant has to press the button that corresponds to the first letter of the color in which the text is printed. The participant has to ignore the name of the color written in the text, but respond based on the color of the text.
|
|
|
|
A stroop task finishes when the user has completed all the attempts, irrespective of correct or incorrect answers.
|
|
|
|
Data collected by the task is in the form of an `ORKStroopResult` object.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data
|
|
collected. If the value of this parameter is `nil`, the default
|
|
localized text is displayed.
|
|
@param numberOfAttempts Total number of stroop questions to include in the task.
|
|
@param options Options that affect the features of the predefined task.
|
|
*/
|
|
+ (ORKOrderedTask *)stroopTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
numberOfAttempts:(NSInteger)numberOfAttempts
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
/**
|
|
Returns a predefined Speech Recognition task that transcribes participant's speech.
|
|
|
|
In a Speech Recognition task, the participant is shown a text or image or both. The participant has to read the text aloud, or describe the image.
|
|
|
|
A Speech Recognition task finishes when the user presses the Stop Recording button.
|
|
|
|
Data collected by the task is in the form of an `ORKSpeechRecognitionResult` object.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data collected.
|
|
If the value of this parameter is `nil`, the default localized text is displayed.
|
|
@param speechRecognizerLocale An enum that represents the locale to be used by speech recognition API.
|
|
@param speechRecognitionImage The image shown to the participant.
|
|
@param speechRecognitionText The text shown to the participant.
|
|
@param shouldHideTranscript The boolean value used to show or hide the transcription from the user.
|
|
@param allowsEdittingTranscript The boolean value used to present step that allows editting transcription.
|
|
@param options Options that affect the features of the predefined task.
|
|
*/
|
|
+ (ORKOrderedTask *)speechRecognitionTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
speechRecognizerLocale:(ORKSpeechRecognizerLocale)speechRecognizerLocale
|
|
speechRecognitionImage:(nullable UIImage *)speechRecognitionImage
|
|
speechRecognitionText:(nullable NSString *)speechRecognitionText
|
|
shouldHideTranscript:(BOOL)shouldHideTranscript
|
|
allowsEdittingTranscript:(BOOL)allowsEdittingTranscript
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
/**
|
|
Returns a predefined task that tests speech audiometry.
|
|
|
|
In a speech in noise task, the participant is asked to listen to some sentences mixed with background noise at varying signal to noise ratio (SNR).
|
|
|
|
You can use a speech in noise task to measure the speech reception threshold (SRT) of an individual.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data
|
|
collected. If the value of this parameter is `nil`, default
|
|
localized text is used.
|
|
@param options Options that affect the features of the predefined task.
|
|
|
|
@return An active speech in noise task that can be presented with an `ORKTaskViewController` object.
|
|
*/
|
|
+ (ORKOrderedTask *)speechInNoiseTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
|
|
|
|
/**
|
|
Returns a predefined task that tests tone audiometry.
|
|
|
|
In a tone audiometry task, the participant is asked to listen to some tones with different audio
|
|
frequencies, playing on different channels (left and right), with the volume being progressively
|
|
increased until the participant taps a button.
|
|
|
|
You can use a tone audiometry task to measure properties of the user's hearing, based on their
|
|
reaction to a wide range of frequencies.
|
|
|
|
Data collected in this task consists of audio signal amplitude for specific frequencies and
|
|
channels.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data
|
|
collected. If the value of this parameter is `nil`, default
|
|
localized text is used.
|
|
@param speechInstruction Instructional content describing what the user needs to do when
|
|
recording begins. If the value of this parameter is `nil`,
|
|
default localized text is used.
|
|
@param shortSpeechInstruction Instructional content shown during audio recording. If the value of
|
|
this parameter is `nil`, default localized text is used.
|
|
@param toneDuration The maximum length of the duration for each tone (each tone can be
|
|
interrupted sooner, after the participant presses the main
|
|
button).
|
|
@param options Options that affect the features of the predefined task.
|
|
|
|
@return An active tone audiometry task that can be presented with an `ORKTaskViewController` object.
|
|
*/
|
|
+ (ORKOrderedTask *)toneAudiometryTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
speechInstruction:(nullable NSString *)speechInstruction
|
|
shortSpeechInstruction:(nullable NSString *)shortSpeechInstruction
|
|
toneDuration:(NSTimeInterval)toneDuration
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
/**
|
|
Returns a predefined task that tests dBHL tone audiometry.
|
|
|
|
In the dBHL tone audiometry task, the participant is asked to listen to some tones with different audio
|
|
frequencies, playing on different channels (left and right), that vary in dB HL values depending on whether or not the user tapped the button.
|
|
|
|
You can use a tone audiometry task to measure the hearing threshold of the user.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data
|
|
collected. If the value of this parameter is `nil`, default
|
|
localized text is used.
|
|
@param options Options that affect the features of the predefined task.
|
|
|
|
@return An active dBHL tone audiometry task that can be presented with an `ORKTaskViewController` object.
|
|
*/
|
|
+ (ORKNavigableOrderedTask *)dBHLToneAudiometryTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
/**
|
|
Returns a predefined task that tests the participant's reaction time.
|
|
|
|
In a reaction time task, the participant is asked to move the device sharply in any
|
|
direction in response to a visual cue. You can use this task to accurately assess the participant's
|
|
simple reaction time.
|
|
|
|
A reaction time task finishes when the participant has completed the required
|
|
number of attempts successfully. An attempt is successful when the participant exerts acceleration
|
|
greater than `thresholdAcceleration` to the device after the stimulus has been delivered and before
|
|
`timeout` has elapsed. An attempt is unsuccessful if acceleration greater than
|
|
`thresholdAcceleration` is applied to the device before the stimulus or if this does not occur
|
|
before `timeout` has elapsed. If unsuccessful, the result is not reported and the participant must
|
|
try again to proceed with the task.
|
|
|
|
Data collected by the task is in the form of ORKReactionTimeResult objects. These
|
|
objects contain a timestamp representing the delivery of the stimulus and an ORKFileResult, which
|
|
references the motion data collected during an attempt. The researcher can use these to evaluate
|
|
the response to the stimulus and calculate the reaction time.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the
|
|
study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data
|
|
collected. If the value of this parameter is `nil`, the
|
|
default localized text is displayed.
|
|
@param maximumStimulusInterval The maximum interval before the stimulus is delivered.
|
|
@param minimumStimulusInterval The minimum interval before the stimulus is delivered.
|
|
@param thresholdAcceleration The acceleration required to end a reaction time test.
|
|
@param numberOfAttempts The number of successful attempts required before the task is
|
|
complete. The active step result will contain this many
|
|
child results if the task is completed.
|
|
@param timeout The interval permitted after the stimulus until the test fails,
|
|
if the threshold is not reached.
|
|
@param successSoundID The sound to play after a successful attempt.
|
|
@param timeoutSoundID The sound to play after an attempt that times out.
|
|
@param failureSoundID The sound to play after an unsuccessful attempt.
|
|
@param options Options that affect the features of the predefined task.
|
|
|
|
@return An active device motion reaction time task that can be presented with an `ORKTaskViewController` object.
|
|
*/
|
|
|
|
+ (ORKOrderedTask *)reactionTimeTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
maximumStimulusInterval:(NSTimeInterval)maximumStimulusInterval
|
|
minimumStimulusInterval:(NSTimeInterval)minimumStimulusInterval
|
|
thresholdAcceleration:(double)thresholdAcceleration
|
|
numberOfAttempts:(int)numberOfAttempts
|
|
timeout:(NSTimeInterval)timeout
|
|
successSound:(UInt32)successSoundID
|
|
timeoutSound:(UInt32)timeoutSoundID
|
|
failureSound:(UInt32)failureSoundID
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
/**
|
|
Returns a predefined task that tests the participant's normalized reaction time.
|
|
|
|
In a reaction time task, the participant is asked to tap the "hold" button and not release the tap until seeing the visual cue,
|
|
in which they should they should tap the visual cue. You can use this task to accurately assess the participant's simple reaction time.
|
|
|
|
A reaction time task finishes when the participant has completed the required
|
|
number of attempts successfully. An attempt is successful when the participant exerts acceleration
|
|
greater than `thresholdAcceleration` to the device after the stimulus has been delivered and before
|
|
`timeout` has elapsed. An attempt is unsuccessful if acceleration greater than
|
|
`thresholdAcceleration` is applied to the device before the stimulus or if this does not occur
|
|
before `timeout` has elapsed. If unsuccessful, the result is not reported and the participant must
|
|
try again to proceed with the task.
|
|
|
|
Data collected by the task is in the form of ORKNormalizedReactionTimeResult objects. These
|
|
objects contain a timestamp representing the delivery of the stimulus and an ORKFileResult, which
|
|
references the motion data collected during an attempt. The researcher can use these to evaluate
|
|
the response to the stimulus and calculate the reaction time.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the
|
|
study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data
|
|
collected. If the value of this parameter is `nil`, the
|
|
default localized text is displayed.
|
|
@param maximumStimulusInterval The maximum interval before the stimulus is delivered.
|
|
@param minimumStimulusInterval The minimum interval before the stimulus is delivered.
|
|
@param thresholdAcceleration The acceleration required to end a reaction time test.
|
|
@param numberOfAttempts The number of successful attempts required before the task is
|
|
complete. The active step result will contain this many
|
|
child results if the task is completed.
|
|
@param timeout The interval permitted after the stimulus until the test fails,
|
|
if the threshold is not reached.
|
|
@param successSoundID The sound to play after a successful attempt.
|
|
@param timeoutSoundID The sound to play after an attempt that times out.
|
|
@param failureSoundID The sound to play after an unsuccessful attempt.
|
|
@param options Options that affect the features of the predefined task.
|
|
|
|
@return An active device motion reaction time task that can be presented with an `ORKTaskViewController` object.
|
|
*/
|
|
+ (ORKOrderedTask *)normalizedReactionTimeTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
maximumStimulusInterval:(NSTimeInterval)maximumStimulusInterval
|
|
minimumStimulusInterval:(NSTimeInterval)minimumStimulusInterval
|
|
thresholdAcceleration:(double)thresholdAcceleration
|
|
numberOfAttempts:(int)numberOfAttempts
|
|
timeout:(NSTimeInterval)timeout
|
|
successSound:(UInt32)successSoundID
|
|
timeoutSound:(UInt32)timeoutSoundID
|
|
failureSound:(UInt32)failureSoundID
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
/**
|
|
Returns a predefined task that consists of a Tower of Hanoi puzzle.
|
|
|
|
In a Tower of Hanoi task, the participant is asked to solve the classic puzzle in as few moves as possible.
|
|
You can use this task to assess the participant's problem-solving skills.
|
|
|
|
A Tower of Hanoi task finishes when the participant has completed the puzzle correctly or concedes that he or she cannot solve it.
|
|
|
|
Data collected by the task is in the form of an `ORKTowerOfHanoiResult` object. Data collected in this task consists of how many moves were taken and whether the puzzle was successfully completed or not.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data
|
|
collected. If the value of this parameter is `nil`, the
|
|
default localized text is displayed.
|
|
@param numberOfDisks The number of disks in the puzzle; the default value for this property is 3.
|
|
@param options Options that affect the features of the predefined task.
|
|
|
|
@return An active device motion reaction time task that can be presented with an `ORKTaskViewController` object.
|
|
*/
|
|
+ (ORKOrderedTask *)towerOfHanoiTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
numberOfDisks:(NSUInteger)numberOfDisks
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
/**
|
|
Returns a predefined task that consists of a timed walk, with a distinct turn around step.
|
|
|
|
In a timed walk task, the participant is asked to walk for a specific distance as quickly as
|
|
possible, but safely. Then the participant is asked to turn around. The task is immediately
|
|
administered again by having the patient walk back the same distance.
|
|
A timed walk task can be used to measure lower extremity function.
|
|
|
|
The presentation of the timed walk task differs from both the fitness check task and the short
|
|
walk task in that the distance is fixed. After a first walk, the user is asked to turn, then reverse
|
|
direction.
|
|
|
|
The data collected by this task can include accelerometer, device motion, pedometer data,
|
|
and location where available.
|
|
|
|
Data collected by the task is in the form of an `ORKTimedWalkResult` object.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data
|
|
collected. If the value of this parameter is `nil`, the default
|
|
localized text is displayed.
|
|
@param distanceInMeters The timed walk distance in meters.
|
|
@param timeLimit The time limit to complete the trials.
|
|
@param turnAroundTimeLimit The time limit to complete the turn around step, passing zero or negative value to this parameter will bypass the turnAroundTime step.
|
|
@param includeAssistiveDeviceForm A Boolean value that indicates whether to inlude the form step
|
|
about the usage of an assistive device.
|
|
@param options Options that affect the features of the predefined task.
|
|
|
|
@return An active timed walk task that can be presented with an `ORKTaskViewController` object.
|
|
*/
|
|
+ (ORKOrderedTask *)timedWalkTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
distanceInMeters:(double)distanceInMeters
|
|
timeLimit:(NSTimeInterval)timeLimit
|
|
turnAroundTimeLimit:(NSTimeInterval)turnAroundTimeLimit
|
|
includeAssistiveDeviceForm:(BOOL)includeAssistiveDeviceForm
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
|
|
/**
|
|
Returns a predefined task that consists of the paced serial addition test (PSAT).
|
|
|
|
In a PSAT task, the participant is asked to add a new digit to the one immediately before it
|
|
every 2 or 3 seconds.
|
|
|
|
A PSAT task can be used to measure the cognitive function that assesses auditory and/or
|
|
visual information processing speed and flexibility, as well as calculation ability.
|
|
|
|
Data collected by the task is in the form of an `ORKPSATResult` object.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data
|
|
collected. If the value of this parameter is `nil`, the default
|
|
localized text is displayed.
|
|
@param presentationMode The presentation mode of the PSAT test (auditory or visual or both).
|
|
@param interStimulusInterval The time interval between two digits presented.
|
|
@param stimulusDuration The time duration the digit is shown on screen (only for
|
|
visual PSAT, that is PVSAT and PAVSAT).
|
|
@param seriesLength The number of digits that will be presented during the task.
|
|
@param options Options that affect the features of the predefined task.
|
|
|
|
@return An active PSAT task that can be presented with an `ORKTaskViewController` object.
|
|
|
|
*/
|
|
+ (ORKOrderedTask *)PSATTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
presentationMode:(ORKPSATPresentationMode)presentationMode
|
|
interStimulusInterval:(NSTimeInterval)interStimulusInterval
|
|
stimulusDuration:(NSTimeInterval)stimulusDuration
|
|
seriesLength:(NSInteger)seriesLength
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
|
|
/**
|
|
Returns a predefined task that measures hand tremor.
|
|
|
|
In a tremor assessment task, the participant is asked to hold the device with their most affected
|
|
hand in various positions while accelerometer and motion data are captured.
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data
|
|
collected. If the value of this parameter is `nil`, the default
|
|
localized text is displayed.
|
|
@param activeStepDuration The duration for each active step in the task.
|
|
@param activeTaskOptions Options that affect which active steps are presented for this task.
|
|
@param handOptions Options for determining which hand(s) to test.
|
|
@param options Options that affect the features of the predefined task.
|
|
|
|
@return An active tremor test task that can be presented with an `ORKTaskViewController` object.
|
|
*/
|
|
+ (ORKNavigableOrderedTask *)tremorTestTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
activeStepDuration:(NSTimeInterval)activeStepDuration
|
|
activeTaskOptions:(ORKTremorActiveTaskOption)activeTaskOptions
|
|
handOptions:(ORKPredefinedTaskHandOption)handOptions
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
|
|
/**
|
|
Returns a predefined task that measures visual attention and task switching.
|
|
|
|
In a trail making test, the participant is asked to connect a series of cicles labeled 1,2,3... or
|
|
1,A,2,B,3,C... and time to complete the test is recorded.
|
|
|
|
`ORKTrailMakingTypeIdentifierA` uses the pattern: 1-2-3-4-5-6-7.
|
|
`ORKTrailMakingTypeIdentifierB` uses the pattern: 1-A-2-B-3-C-4-D-5-E-6-F-7
|
|
|
|
@param identifier The task identifier to use for this task, appropriate to the study.
|
|
@param intendedUseDescription A localized string describing the intended use of the data
|
|
collected. If the value of this parameter is `nil`, the default
|
|
localized text is displayed.
|
|
@param trailmakingInstruction Instructional content describing what the user needs to do when
|
|
the task begins. If the value of this parameter is `nil`,
|
|
@param trailType Type of trail to display. Either `ORKTrailMakingTypeIdentifierA` or `ORKTrailMakingTypeIdentifierB`
|
|
@param options Options that affect the features of the predefined task.
|
|
|
|
@return An active trail making test task that can be presented with an `ORKTaskViewController` object.
|
|
*/
|
|
+ (ORKOrderedTask *)trailmakingTaskWithIdentifier:(NSString *)identifier
|
|
intendedUseDescription:(nullable NSString *)intendedUseDescription
|
|
trailmakingInstruction:(nullable NSString *)trailmakingInstruction
|
|
trailType:(ORKTrailMakingTypeIdentifier)trailType
|
|
options:(ORKPredefinedTaskOption)options;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|