Gazebo Math

API Reference

7.4.0
TimeVaryingVolumetricGrid< T, V, InMemorySession< T, P >, P > Class Template Reference

Specialization of TimeVaryingVolumetricGrid which loads the whole of the dataset into memory. To construct this class use InMemoryTimeVaryingVolumetricGridFactory More...

#include <TimeVaryingVolumetricGrid.hh>

Public Member Functions

std::pair< Vector3< V >, Vector3< V > > Bounds (const InMemorySession< T, P > &_session) const
 Get the bounds of this grid field at given time.
 
InMemorySession< T, V > CreateSession () const
 Documentation Inherited.
 
InMemorySession< T, V > CreateSession (const T &_time) const
 Documentation Inherited.
 
bool IsValid (const InMemorySession< T, P > &_session) const
 Documentation Inherited.
 
std::optional< V > LookUp (const InMemorySession< T, P > &_session, const Vector3< P > &_pos, const Vector3< V > &_tol=Vector3< V >{1e-6, 1e-6, 1e-6}) const
 Looks up a given point. If the point lies in between two time frames then it performs spatio-temporal linear interpolation.
 
std::optional< InMemorySession< T, P > > StepTo (const InMemorySession< T, double > &_session, const T &_time) const
 Documentation Inherited.
 

Detailed Description

template<typename T, typename V, typename P>
class gz::math::TimeVaryingVolumetricGrid< T, V, InMemorySession< T, P >, P >

Specialization of TimeVaryingVolumetricGrid which loads the whole of the dataset into memory. To construct this class use InMemoryTimeVaryingVolumetricGridFactory

Member Function Documentation

◆ Bounds()

template<typename T , typename V , typename P >
std::pair< Vector3< V >, Vector3< V > > Bounds ( const InMemorySession< T, P > & _session) const
inline

Get the bounds of this grid field at given time.

Returns
A pair of vectors. All zeros if session is invalid.

◆ CreateSession() [1/2]

template<typename T , typename V , typename P >
InMemorySession< T, V > CreateSession ( ) const
inline

Documentation Inherited.

◆ CreateSession() [2/2]

template<typename T , typename V , typename P >
InMemorySession< T, V > CreateSession ( const T & _time) const
inline

Documentation Inherited.

◆ IsValid()

template<typename T , typename V , typename P >
bool IsValid ( const InMemorySession< T, P > & _session) const
inline

Documentation Inherited.

◆ LookUp()

template<typename T , typename V , typename P >
std::optional< V > LookUp ( const InMemorySession< T, P > & _session,
const Vector3< P > & _pos,
const Vector3< V > & _tol = Vector3<V>{1e-6, 1e-6, 1e-6} ) const
inline

Looks up a given point. If the point lies in between two time frames then it performs spatio-temporal linear interpolation.

Returns
nullopt if the data is out of range.

◆ StepTo()

template<typename T , typename V , typename P >
std::optional< InMemorySession< T, P > > StepTo ( const InMemorySession< T, double > & _session,
const T & _time ) const
inline

Documentation Inherited.


The documentation for this class was generated from the following file: