Skip to content

Add SmoothedConstantInterpolation #367

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.

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

Open
wants to merge 26 commits into
base: master
Choose a base branch
from

Conversation

SouthEndMusic
Copy link
Member

@SouthEndMusic SouthEndMusic commented Nov 25, 2024

Fixes #364.

Checklist

  • Appropriate tests were added
  • Any code changes were done in a way that does not break public API
  • All documentation related to code changes were updated
  • The new code follows the
    contributor guidelines, in particular the SciML Style Guide and
    COLPRAC.
  • Any new documentation only uses public API

Additional context

using DataInterpolations
using Plots
using Random

N = 10
Random.seed!(8)
u = rand(N)
t = cumsum(rand(N))
A1 = ConstantInterpolation(u, t)

p = plot()
plot!(A1)

for d_max in 00.05:0.05:0.2
    A2 = SmoothedConstantInterpolation(u, t, cache_parameters = true; d_max)
    plot!(A2)
end

p

figure

@SouthEndMusic SouthEndMusic marked this pull request as draft November 25, 2024 15:27
@SouthEndMusic SouthEndMusic marked this pull request as ready for review November 26, 2024 11:43
@SouthEndMusic SouthEndMusic marked this pull request as draft November 26, 2024 11:44
@SouthEndMusic SouthEndMusic marked this pull request as ready for review December 3, 2024 15:10
@SouthEndMusic SouthEndMusic marked this pull request as draft December 3, 2024 15:11
@SouthEndMusic
Copy link
Member Author

Fun feature; if SmoothedConstantInterpolation is used with extrapolation = ExtrapolationType.Periodic, then the transitions are also smooth:

using DataInterpolations
using Plots
using Random

N = 4
Random.seed!(8)
u = rand(N)
t = cumsum(rand(N))
Δt = t[end] - t[1]
t_eval = range(first(t) - Δt, last(t) + Δt, length = 500)

A = SmoothedConstantInterpolation(u, t; extrapolation = ExtrapolationType.Periodic, d_max = 0.2)

plot(t_eval, A.(t_eval))
scatter!(t[1:end-1], u[1:end-1]; label = "data")
scatter!(t[1:end-1] .+ Δt, u[1:end-1]; label = "data one period forward")
scatter!(t[1:end-1] .- Δt, u[1:end-1]; label = "data one period back")

plot

@SouthEndMusic SouthEndMusic marked this pull request as ready for review December 3, 2024 15:37
sathvikbhagavan
sathvikbhagavan previously approved these changes Dec 9, 2024
plot!(A)
```

Note that `u[end]` is ignored.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

even for extrapolation?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, also for extrapolation

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line can now be removed/edited?

@ChrisRackauckas
Copy link
Member

Conflicts?

@SouthEndMusic SouthEndMusic marked this pull request as draft April 16, 2025 09:02
@SouthEndMusic
Copy link
Member Author

@visr I added the function get_transition_ts to know which tstops to pass to the integrator so that it doesn't jump over the smooth transitions:

image

@SouthEndMusic SouthEndMusic marked this pull request as ready for review April 16, 2025 09:19
@ChrisRackauckas
Copy link
Member

What's the reason the end is ignored and it doesn't just constant extrapolate?

@SouthEndMusic
Copy link
Member Author

SouthEndMusic commented Apr 17, 2025

The key properties of this interpolation type are that it is differentiable everywhere and sufficiently close to constant interpolation. I achieve the diffentiability by replacing the stepwise transition in each data point by a differentiable transition in an interval around each data point.

What that means for extrapolation is a bit murky. I already made it so that the extrapolation is smooth in the case of periodic extrapolation, which means that the interpolation around the edges of the domain has to account for that. I'd argue that for constant extrapolation, ignoring the last data point is also best. Maybe for extension extrapolation, the last data point can be used, but that feels a bit inconsistent.

@ChrisRackauckas
Copy link
Member

I'd like to hear @sathvikbhagavan 's thoughts, because at least to me constant extrapolation with the last point feels natural

@sathvikbhagavan
Copy link
Member

sathvikbhagavan commented Apr 19, 2025

If I understand correctly, can't we do the same transition from second last to the last point after which it becomes constant? This is strictly not constant extrapolation as values would be different from the last point (for a small interval) as it needs to be C1 smooth everywhere

@SouthEndMusic
Copy link
Member Author

I made it now so that both Constant and Extension extrapolation use u[end], e.g.

using DataInterpolations
using Plots
using Random

N = 4
Random.seed!(10)
u = rand(N)
t = cumsum(rand(N))
Δt = t[end] - t[1]
t_eval = range(first(t) - Δt, last(t) + Δt, length=500)

A = SmoothedConstantInterpolation(u, t; extrapolation=ExtrapolationType.Extension, d_max=0.2, cache_parameters=true)

plot(t_eval, A.(t_eval), label="interpolation with Extension extrapolation")

scatter!(t, u, label="Data")

image

@SouthEndMusic
Copy link
Member Author

I don't understand why the derivative tests are failing 🤔

@SouthEndMusic
Copy link
Member Author

fixed it 👍

@ChrisRackauckas
Copy link
Member

I think I'm happy. @sathvikbhagavan ?

Copy link
Member

@sathvikbhagavan sathvikbhagavan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of clarifications

plot!(A)
```

Note that `u[end]` is ignored.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line can now be removed/edited?


It is a method for interpolating constantly with forward fill, with smoothing around the
value transitions to make the curve continuously differentiable while the integral never
drifts far from the integral of constant interpolation. `u[end]` is ignored for extrapolation types
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

comment about u[end] - it can be removed? When is u[end] ignored now?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Smooth equivalent of ConstantInterpolation in terms of integral
3 participants