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.

Sign up for GitHub

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

Update PCT functions, close #89 #90

Merged
merged 5 commits into from
Oct 29, 2024
Merged

Update PCT functions, close #89 #90

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f89b9c7
Update PCT functions, close #89
Robinlovelace Oct 29, 2024
f72aea7
Wire up new uptake functions
dabreegster Oct 29, 2024
fdfdada
Try adding tests
Robinlovelace Oct 29, 2024
085bf74
Merge branch '89-new-pct-uptake-functions' of https://github.com/Urba…
Robinlovelace Oct 29, 2024
a2f89c1
Add tests
Robinlovelace Oct 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions od2net/src/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,8 @@ pub enum Uptake {
upper_limit: f64,
exponent: f64,
},
GovTargetSchool,
GoDutchSchool,
}

#[derive(Serialize, Deserialize)]
Expand Down
115 changes: 97 additions & 18 deletions od2net/src/plugins/uptake.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ pub fn calculate_uptake(uptake: &Uptake, total_distance_meters: f64) -> f64 {
}
Uptake::GovTargetPCT => pct_gov_target(total_distance_meters, gradient),
Uptake::GoDutchPCT => pct_go_dutch(total_distance_meters, gradient),
Uptake::GovTargetSchool => pct_gov_target_school(total_distance_meters, gradient),
Uptake::GoDutchSchool => pct_go_dutch_school(total_distance_meters, gradient),
Uptake::WalkToSchool {
upper_limit,
exponent,
Expand All @@ -30,16 +32,33 @@ pub fn calculate_uptake(uptake: &Uptake, total_distance_meters: f64) -> f64 {
// TODO What does gradient represent -- an average or total or something over the entire route?
// gradient should be in [0, 100]
// This returns [0.0, 1.0]
// alpha = -4.018,
// d1 = -0.6369,
// d2 = 1.988,
// d3 = 0.008775,
// h1 = -0.2555,
// h2 = -0.78,
// i1 = 0.02006,
// i2 = -0.1234,
// # logit (pcycle)= -4.018 + (-0.6369 * distance) +
// # (1.988 * distancesqrt) + (0.008775* distancesq) +
// # (-0.2555* gradient) + (0.02006* distance*gradient) +
// # (-0.1234* distancesqrt*gradient)
fn pct_gov_target(distance_meters: f64, gradient_percent: f64) -> f64 {
let alpha = -3.959;
let d1 = -0.5963;
let d2 = 1.866;
let d3 = 0.008050;
let h1 = -0.2710;
let i1 = 0.009394;
let i2 = -0.05135;

// TODO Why clamp to 30km?
let alpha = -4.018;
let d1 = -0.6369;
let d2 = 1.988;
let d3 = 0.008775;
let h1 = -0.2555;
let h2 = -0.78;
let i1 = 0.02006;
let i2 = -0.1234;

// gradient = gradient + h2
let gradient_percent = gradient_percent + h2;

// Clamp to 30km to prevent cycling potential increasing with distance
// This happens because the polynomial function reaches a minimal value at around 30km
let distance_km = (distance_meters / 1000.0).min(30.0);

let p = alpha
Expand All @@ -52,16 +71,36 @@ fn pct_gov_target(distance_meters: f64, gradient_percent: f64) -> f64 {
inverse_logit(p)
}

// gradient,
// alpha = -4.018 + 2.550,
// d1 = -0.6369 - 0.08036,
// d2 = 1.988,
// d3 = 0.008775,
// h1 = -0.2555,
// h2 = -0.78,
// i1 = 0.02006,
// i2 = -0.1234,
// verbose = FALSE) {
// distance_gradient = check_distance_gradient(distance, gradient, verbose)
// distance = distance_gradient$distance
// gradient = distance_gradient$gradient
// # Uptake formula from manual:
// # logit_pcycle = -4.018 + (-0.6369 * distance) + (1.988 * distancesqrt) +
// # (0.008775 * distancesq) + (-0.2555 * gradient) + (0.02006 * distance*gradient) +
// # (-0.1234 * distancesqrt*gradient) + (2.550 * dutch) + (-0.08036* dutch * distance) +
// # (0.05509* ebike * distance) + (-0.0002950* ebike * distancesq) + (0.1812* ebike * gradient)
// gradient = gradient + h2
fn pct_go_dutch(distance_meters: f64, gradient_percent: f64) -> f64 {
let alpha = -3.959 + 2.523;
let d1 = -0.5963 - 0.07626;
let d2 = 1.866;
let d3 = 0.008050;
let h1 = -0.2710;
let i1 = 0.009394;
let i2 = -0.05135;

// TODO Why clamp to 30km?
let alpha = -4.018 + 2.550;
let d1 = -0.6369 - 0.08036;
let d2 = 1.988;
let d3 = 0.008775;
let h1 = -0.2555;
let h2 = -0.78;
let i1 = 0.02006;
let i2 = -0.1234;

let gradient_percent = gradient_percent + h2;
let distance_km = (distance_meters / 1000.0).min(30.0);

let p = alpha
Expand All @@ -74,6 +113,46 @@ fn pct_go_dutch(distance_meters: f64, gradient_percent: f64) -> f64 {
inverse_logit(p)
}

// Cycle to school
// alpha = -7.178,
// d1 = -1.870,
// d2 = 5.961,
// # d3 = -0.2401,
// h1 = -0.5290,
// h2 = -0.63
fn pct_gov_target_school(distance_meters: f64, gradient_percent: f64) -> f64 {
let alpha = -7.178;
let d1 = -1.870;
let d2 = 5.961;
let h1 = -0.5290;
let h2 = -0.63;

let gradient_percent = gradient_percent + h2;
let distance_km = (distance_meters / 1000.0).min(30.0);

let p = alpha + (d1 * distance_km) + (d2 * distance_km.sqrt()) + (h1 * gradient_percent);
inverse_logit(p)
}

// alpha = -7.178 + 3.574,
// d1 = -1.870 + 0.3438,
// d2 = 5.961,
// h1 = -0.5290,
// h2 = -0.63,
fn pct_go_dutch_school(distance_meters: f64, gradient_percent: f64) -> f64 {
let alpha = -7.178 + 3.574;
let d1 = -1.870 + 0.3438;
let d2 = 5.961;
let h1 = -0.5290;
let h2 = -0.63;

let gradient_percent = gradient_percent + h2;
let distance_km = (distance_meters / 1000.0).min(30.0);

let p = alpha + (d1 * distance_km) + (d2 * distance_km.sqrt()) + (h1 * gradient_percent);
inverse_logit(p)
}

fn inverse_logit(p: f64) -> f64 {
let result = p.exp() / (1.0 + p.exp());
if result < 0.0 || result > 1.0 {
Expand Down