mrpt::obs::TPixelLabelInfoBase Struct Reference

Detailed Description

Virtual interface to all pixel-label semantic information structs.

See CObservation3DRangeScan::pixelLabels

Definition at line 24 of file TPixelLabelInfo.h.

#include <mrpt/obs/TPixelLabelInfo.h>

Inheritance diagram for mrpt::obs::TPixelLabelInfoBase:

Public Types
using	Ptr = std::shared_ptr< TPixelLabelInfoBase >
	Used in CObservation3DRangeScan::pixelLabels. More...
using	TMapLabelID2Name = std::map< uint32_t, std::string >

Public Member Functions
	TPixelLabelInfoBase (unsigned int BITFIELD_BYTES_)
virtual	~TPixelLabelInfoBase ()
const std::string &	getLabelName (unsigned int label_idx) const
void	setLabelName (unsigned int label_idx, const std::string &name)
int	checkLabelNameExistence (const std::string &name) const
	Check the existence of a label by returning its associated index. More...
virtual void	setSize (const int NROWS, const int NCOLS)=0
	Resizes the matrix pixelLabels to the given size, setting all bitfields to zero (that is, all pixels are assigned NONE category). More...
virtual void	setLabel (const int row, const int col, uint8_t label_idx)=0
	Mark the pixel(row,col) as classified in the category label_idx, which may be in the range 0 to MAX_NUM_LABELS-1 Note that 0 is a valid label index, it does not mean "no label". More...
virtual void	getLabels (const int row, const int col, uint8_t &labels)=0
virtual void	unsetLabel (const int row, const int col, uint8_t label_idx)=0
	For the pixel(row,col), removes its classification into the category label_idx, which may be in the range 0 to 7 Note that 0 is a valid label index, it does not mean "no label". More...
virtual void	unsetAll (const int row, const int col, uint8_t label_idx)=0
	Removes all categories for pixel(row,col) More...
virtual bool	checkLabel (const int row, const int col, uint8_t label_idx) const =0
	Checks whether pixel(row,col) has been clasified into category label_idx, which may be in the range 0 to 7. More...
void	writeToStream (mrpt::serialization::CArchive &out) const

Static Public Member Functions
static TPixelLabelInfoBase *	readAndBuildFromStream (mrpt::serialization::CArchive &in)

Public Attributes
TMapLabelID2Name	pixelLabelNames
	The 'semantic' or human-friendly name of the i'th bit in pixelLabels(r,c) can be found in pixelLabelNames[i] as a std::string. More...
const uint8_t	BITFIELD_BYTES
	Minimum number of bytes required to hold MAX_NUM_DIFFERENT_LABELS bits. More...

Protected Member Functions
virtual void	internal_readFromStream (mrpt::serialization::CArchive &in)=0
virtual void	internal_writeToStream (mrpt::serialization::CArchive &out) const =0
virtual void	Print (std::ostream &) const =0

Friends
std::ostream &	operator<< (std::ostream &out, const TPixelLabelInfoBase &obj)
	std stream interface More...

Member Typedef Documentation

Ptr

using mrpt::obs::TPixelLabelInfoBase::Ptr = std::shared_ptr<TPixelLabelInfoBase>

Used in CObservation3DRangeScan::pixelLabels.

Definition at line 33 of file TPixelLabelInfo.h.

TMapLabelID2Name

using mrpt::obs::TPixelLabelInfoBase::TMapLabelID2Name = std::map<uint32_t, std::string>

Definition at line 34 of file TPixelLabelInfo.h.

Constructor & Destructor Documentation

TPixelLabelInfoBase()

mrpt::obs::TPixelLabelInfoBase::TPixelLabelInfoBase ( unsigned int  BITFIELD_BYTES_ )

inline

Definition at line 26 of file TPixelLabelInfo.h.

~TPixelLabelInfoBase()

TPixelLabelInfoBase::~TPixelLabelInfoBase ( )

virtualdefault

Member Function Documentation

checkLabel()

virtual bool mrpt::obs::TPixelLabelInfoBase::checkLabel ( const int  row, const int  col, uint8_t  label_idx  ) const

pure virtual

Checks whether pixel(row,col) has been clasified into category label_idx, which may be in the range 0 to 7.

See also

unsetLabel, unsetAll

Implemented in mrpt::obs::TPixelLabelInfo< BYTES_REQUIRED_ >.

checkLabelNameExistence()

int mrpt::obs::TPixelLabelInfoBase::checkLabelNameExistence ( const std::string &  name ) const

inline

Check the existence of a label by returning its associated index.

-1 if it does not exist.

Definition at line 54 of file TPixelLabelInfo.h.

References pixelLabelNames.

getLabelName()

const std::string& mrpt::obs::TPixelLabelInfoBase::getLabelName ( unsigned int  label_idx ) const

inline

Definition at line 41 of file TPixelLabelInfo.h.

References pixelLabelNames.

getLabels()

virtual void mrpt::obs::TPixelLabelInfoBase::getLabels ( const int  row, const int  col, uint8_t &  labels  )

pure virtual

Implemented in mrpt::obs::TPixelLabelInfo< BYTES_REQUIRED_ >.

internal_readFromStream()

virtual void mrpt::obs::TPixelLabelInfoBase::internal_readFromStream ( mrpt::serialization::CArchive &  in )

protectedpure virtual

Implemented in mrpt::obs::TPixelLabelInfo< BYTES_REQUIRED_ >.

Referenced by readAndBuildFromStream().

Here is the caller graph for this function:

internal_writeToStream()

virtual void mrpt::obs::TPixelLabelInfoBase::internal_writeToStream ( mrpt::serialization::CArchive &  out ) const

protectedpure virtual

Implemented in mrpt::obs::TPixelLabelInfo< BYTES_REQUIRED_ >.

Print()

virtual void mrpt::obs::TPixelLabelInfoBase::Print ( std::ostream &  ) const

protectedpure virtual

Implemented in mrpt::obs::TPixelLabelInfo< BYTES_REQUIRED_ >.

readAndBuildFromStream()

TPixelLabelInfoBase * plib::readAndBuildFromStream ( mrpt::serialization::CArchive &  in )

static

Definition at line 61 of file TPixelLabelInfo.cpp.

References internal_readFromStream(), and MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.

Here is the call graph for this function:

setLabel()

virtual void mrpt::obs::TPixelLabelInfoBase::setLabel ( const int  row, const int  col, uint8_t  label_idx  )

pure virtual

Mark the pixel(row,col) as classified in the category label_idx, which may be in the range 0 to MAX_NUM_LABELS-1 Note that 0 is a valid label index, it does not mean "no label".

See also

unsetLabel, unsetAll

Implemented in mrpt::obs::TPixelLabelInfo< BYTES_REQUIRED_ >.

setLabelName()

void mrpt::obs::TPixelLabelInfoBase::setLabelName ( unsigned int  label_idx, const std::string &  name  )

inline

Definition at line 48 of file TPixelLabelInfo.h.

References pixelLabelNames.

setSize()

virtual void mrpt::obs::TPixelLabelInfoBase::setSize ( const int  NROWS, const int  NCOLS  )

pure virtual

Resizes the matrix pixelLabels to the given size, setting all bitfields to zero (that is, all pixels are assigned NONE category).

Implemented in mrpt::obs::TPixelLabelInfo< BYTES_REQUIRED_ >.

unsetAll()

virtual void mrpt::obs::TPixelLabelInfoBase::unsetAll ( const int  row, const int  col, uint8_t  label_idx  )

pure virtual

Removes all categories for pixel(row,col)

See also

setLabel, unsetLabel

unsetLabel()

virtual void mrpt::obs::TPixelLabelInfoBase::unsetLabel ( const int  row, const int  col, uint8_t  label_idx  )

pure virtual

For the pixel(row,col), removes its classification into the category label_idx, which may be in the range 0 to 7 Note that 0 is a valid label index, it does not mean "no label".

See also

setLabel, unsetAll

Implemented in mrpt::obs::TPixelLabelInfo< BYTES_REQUIRED_ >.

writeToStream()

void plib::writeToStream

(

mrpt::serialization::CArchive &

out

)

const

Definition at line 22 of file TPixelLabelInfo.cpp.

References out.

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  out, const TPixelLabelInfoBase &  obj  )

friend

std stream interface

Definition at line 92 of file TPixelLabelInfo.h.

Member Data Documentation

BITFIELD_BYTES

const uint8_t mrpt::obs::TPixelLabelInfoBase::BITFIELD_BYTES

Minimum number of bytes required to hold MAX_NUM_DIFFERENT_LABELS bits.

Definition at line 101 of file TPixelLabelInfo.h.

pixelLabelNames

TMapLabelID2Name mrpt::obs::TPixelLabelInfoBase::pixelLabelNames

The 'semantic' or human-friendly name of the i'th bit in pixelLabels(r,c) can be found in pixelLabelNames[i] as a std::string.

Definition at line 39 of file TPixelLabelInfo.h.

Referenced by checkLabelNameExistence(), getLabelName(), and setLabelName().