Function InitTimeGeometry

Wrapping/Python/mitk/Geometries.cpp:262–368

}

void InitTimeGeometry(py::module_& m)
{
  py::class_<TimeGeometry, TimeGeometry::Pointer>(m, "TimeGeometry",
    R"(Maps discrete time steps to floating-point time points.

A ``TimeGeometry`` is the temporal counterpart of :py:class:`BaseGeometry`.
It bridges integer time-step indices (used as array indices) and physical
time points (the time values a user sees). For static 3D data the time
geometry has a single time step that covers the full time range.

Subclasses:

- :py:class:`ProportionalTimeGeometry`: evenly spaced time points.
- :py:class:`ArbitraryTimeGeometry`: user-defined time points per step.
)")
    .def("count_time_steps", &TimeGeometry::CountTimeSteps,
      "Return the number of time steps.")
    .def("get_min_time_point", py::overload_cast<>(&TimeGeometry::GetMinimumTimePoint, py::const_),
      "Return the minimum (earliest) time point covered by this geometry.")
    .def("get_max_time_point", py::overload_cast<>(&TimeGeometry::GetMaximumTimePoint, py::const_),
      "Return the maximum (latest) time point covered by this geometry.")
    .def("get_min_time_point", py::overload_cast<TimeStepType>(&TimeGeometry::GetMinimumTimePoint, py::const_), py::arg("time_step"),
      R"(Return the minimum time point of a single time step.

Args:
    time_step: Time-step index.
)")
    .def("get_max_time_point", py::overload_cast<TimeStepType>(&TimeGeometry::GetMaximumTimePoint, py::const_), py::arg("time_step"),
      R"(Return the maximum time point of a single time step.

Args:
    time_step: Time-step index.
)")
    .def("get_time_bounds",
      [](const TimeGeometry& tg) {
        const auto b = tg.GetTimeBounds();
        return std::make_tuple(b[0], b[1]);
      },
      R"(Return the overall ``(min_time_point, max_time_point)`` tuple.

Returns:
    A 2-tuple of floats.
)")
    .def("get_time_bounds",
      [](const TimeGeometry& tg, TimeStepType t) {
        const auto b = tg.GetTimeBounds(t);
        return std::make_tuple(b[0], b[1]);
      },
      py::arg("time_step"),
      R"(Return the ``(min, max)`` time-point tuple for a single time step.

Args:
    time_step: Time-step index.

Returns:
    A 2-tuple of floats.
)")
    .def("time_step_to_time_point", &TimeGeometry::TimeStepToTimePoint, py::arg("time_step"),