Proposal: add a way to access ParaView's requested time in Python Calculator/Annotation

Development
,
1

The Python Calculator and Python Annotation filter let you refer to the current time and time index of the source they are connected to via the t_value and t_index variables and the {timevalue} and {timeindex} string substitutions. This is great if you want to use the time values associated with the data source.

However, there are use cases where you might want to use ParaView’s requested time instead. This is not currently possible to access in Python Calculator or Python Annotation, but I think it would be nice to be able to do that. For example, if you want to compute a time-varying function over a static dataset (a dataset that has one timestep) for animation purposes, it would be nice to get ParaView’s requested time as managed by the Time Manager rather than be stuck at the single non-varying time value associated with the static dataset.

I propose adding to Python Calculator/Annotation;

  • t_time as a local variable
  • {time} as a string replacement

or maybe

  • t_requestedtime as a local variable
  • {requestedtime} as a string replacement

These are my first thoughts for names and can likely be improved. I want to stay away from “t_paraviewtime” because ParaView-derived applications may make use of this feature, but won’t be called ParaView.

2 Likes
2

Sounds good.
If there is more than one time (requested time, dataset timestep time), I would rather the variable be longer and clear. t_requestedtime seems appropriate to me.

3

Agreed.

4

Thinking more about names, I think pipeline_time is a better name.

GitLab issue for this proposal: https://gitlab.kitware.com/paraview/paraview/-/issues/23025

5

Perfect.

6

I ended up going with current_time as the variable name as that matches a Current Time UI element in the Information panel

7

Merge request here: https://gitlab.kitware.com/paraview/paraview/-/merge_requests/7403

This will be in ParaView 6.1.