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. More...
 
InMemorySession< T, V > CreateSession () const
 Documentation Inherited. More...
 
InMemorySession< T, V > CreateSession (const T &_time) const
 Documentation Inherited. More...
 
bool IsValid (const InMemorySession< T, P > &_session) const
 Documentation Inherited. More...
 
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. More...
 
std::optional< InMemorySession< T, P > > StepTo (const InMemorySession< T, double > &_session, const T &_time) const
 Documentation Inherited. More...
 

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()

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]

InMemorySession<T, V> CreateSession ( ) const
inline

Documentation Inherited.

◆ CreateSession() [2/2]

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

Documentation Inherited.

◆ IsValid()

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

Documentation Inherited.

◆ LookUp()

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()

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: