sbarber2
commented
9 months ago Here is a draft of the specification for the functionality covered in this issue:
- [ ] Create a module named circumnutation_analysis.py (the existing module gravitropism.py might be a helpful example).
- [ ] In this new module, create a function named calculate_results_circumnutation() that takes as input parameters a list of 2D [x,y] points, distance factors for the x and y dimensions (pixels per mm, and a frame rate in frames per minute, and returns a dictionary with four keys and their corresponding values: {'maxAmplitude': float, 'rate': float, 'rateUnits' : string, 'amplitudeUnits': string }. If the distance factors are not provided, then the unit of distance calculated is in pixels. If the frame rate is not provided, then the we will represent the passing of time as frames rather than minutes. Amplitude here is the amplitude in the horizontal, or x, dimension, of the points list.
- [ ] Create passing pytests in a new module tests/circumnutation_test.py to cover at least the_ following cases: empty points list, points list of length 1, points list of length 2, no x distance factor, no y distance factor, no frame rate, "normal case" -- that is, both x and y distance factors provided, frame rate provided, and a points list with more than 2 elements.
The specifics of the result calculations will be analogous to those in the showResult() function of https://github.com/Plant-Tracer/legacy_ios_app/blob/main/www/app/controllers/Graph.js
Please feel free to further elaborate, correct, and/or revise the function specification as more details about the calculations are understood.
simsong
Evantso
Calculate maxAmplitude and rate given vector of [x,y] points and frame rate, return as dictionary
See https://github.com/Plant-Tracer/legacy_ios_app/blob/main/www/app/controllers/Graph.js for specfics of calculation