File map_channel2d.hpp

Core API objects - map channel 2D.

Helper functions for slamcore::MapChannelType

template<typename Archive>
inline void load_minimal(const Archive&, MapChannelType &obj, const std::string &value)
template<class Archive>
static inline std::string save_minimal(const Archive&, const MapChannelType &obj)
static inline std::ostream &operator<<(std::ostream &os, const MapChannelType obj)

Enums

enum class MapChannelType : EnumBaseT

Map channel types.

Values:

enumerator OccupancyProbability
enumerator Height
enumerator HeightVariance
enumerator Coverage
enumerator Count
template<typename T>
struct TypeTraits<T, typename enable_if_is_base_of<MapChannel2DInterface, T>::type>
#include <map_channel2d.hpp>

Public Static Attributes

static constexpr ObjectType EnumType = ObjectType::MapChannel2D
namespace slamcore

Helper conversion methods

slamcore::ImageFormat \(\leftrightarrow\) BytesPerChannel

Helper functions for slamcore::MapChannelType

template<typename Archive>
inline void load_minimal(const Archive&, MapChannelType &obj, const std::string &value)
template<class Archive>
static inline std::string save_minimal(const Archive&, const MapChannelType &obj)
static inline std::ostream &operator<<(std::ostream &os, const MapChannelType obj)

Get information about the client library

Enums

enum class MapChannelType : EnumBaseT

Map channel types.

Values:

enumerator OccupancyProbability
enumerator Height
enumerator HeightVariance
enumerator Coverage
enumerator Count
class MapChannel2DInterface
#include <map_channel2d.hpp>

Interface to a 2D map channel.

Public Types

using Ptr = std::shared_ptr<MapChannel2DInterface>
using CPtr = std::shared_ptr<const MapChannel2DInterface>

Public Functions

virtual ~MapChannel2DInterface() = default
virtual MapChannelType getType() const = 0

Type of channel.

virtual ImageFormat getFormat() const = 0

Data format.

virtual std::size_t getWidth() const = 0

Number of cells in the horizontal dimension.

virtual std::size_t getHeight() const = 0

Number of cells in the vertical dimension.

virtual std::size_t getPitch() const = 0

Data row stride in bytes.

virtual std::size_t getBytesPerPixel() const = 0

Bytes per pixel.

virtual std::size_t getBufferSize() const = 0

Total buffer size in bytes.

virtual bool isValid() const = 0

Check if the map channel contains valid data.

virtual const uint8_t *getData() const = 0

Internal data buffer.

virtual ScalarT getValueMin() const = 0

Minimum valid value. Smaller values should be treated as unknown.

virtual ScalarT getValueMax() const = 0

Maximum valid value. Greater values should be treated as unknown.

template<typename T> type >
#include <map_channel2d.hpp>

Public Static Attributes

static constexpr ObjectType EnumType = ObjectType::MapChannel2D