octomap 1.9.8
Loading...
Searching...
No Matches
octomap::OcTreeNodeStamped Class Reference

#include <OcTreeStamped.h>

Inheritance diagram for octomap::OcTreeNodeStamped:
Collaboration diagram for octomap::OcTreeNodeStamped:

Public Types

typedef float DataType
 Make the templated data type available from the outside.

Public Member Functions

void addValue (const float &p)
 adds p to the node's logOdds value (with no boundary / threshold checking!)
void copyData (const OcTreeDataNode &from)
 Copy the payload (data in "value") from rhs into this node Opposed to copy ctor, this does not clone the children as well.
void copyData (const OcTreeNodeStamped &from)
float getLogOdds () const
float getMaxChildLogOdds () const
double getMeanChildLogOdds () const
double getOccupancy () const
unsigned int getTimestamp () const
float getValue () const
 OCTOMAP_DEPRECATED (bool childExists(unsigned int i) const)
 Test whether the i-th child exists.
 OcTreeNodeStamped ()
 OcTreeNodeStamped (const OcTreeNodeStamped &rhs)
bool operator== (const OcTreeDataNode &rhs) const
 Equals operator, compares if the stored value is identical.
bool operator== (const OcTreeNodeStamped &rhs) const
std::istream & readData (std::istream &s)
 Read node payload (data only) from binary stream.
void setLogOdds (float l)
 sets log odds occupancy of node
void setTimestamp (unsigned int t)
void setValue (float v)
 sets value to be stored in the node
void updateOccupancyChildren ()
void updateTimestamp ()
std::ostream & writeData (std::ostream &s) const
 Write node payload (data only) to binary stream.

Protected Member Functions

void allocChildren ()

Protected Attributes

AbstractOcTreeNode ** children
 pointer to array of children, may be NULL
unsigned int timestamp
float value
 stored data (payload)

Member Typedef Documentation

◆ DataType

typedef float octomap::OcTreeDataNode< float >::DataType
inherited

Make the templated data type available from the outside.

Constructor & Destructor Documentation

◆ OcTreeNodeStamped() [1/2]

octomap::OcTreeNodeStamped::OcTreeNodeStamped ( )
inline

References octomap::OcTreeNode::OcTreeNode(), and timestamp.

Referenced by copyData(), OcTreeNodeStamped(), and operator==().

◆ OcTreeNodeStamped() [2/2]

octomap::OcTreeNodeStamped::OcTreeNodeStamped ( const OcTreeNodeStamped & rhs)
inline

References octomap::OcTreeNode::OcTreeNode(), OcTreeNodeStamped(), and timestamp.

Member Function Documentation

◆ addValue()

void octomap::OcTreeNode::addValue ( const float & p)
inherited

adds p to the node's logOdds value (with no boundary / threshold checking!)

References octomap::OcTreeDataNode< float >::value.

◆ allocChildren()

void octomap::OcTreeDataNode< float >::allocChildren ( )
protectedinherited

◆ copyData() [1/2]

void octomap::OcTreeDataNode< float >::copyData ( const OcTreeDataNode< float > & from)
inherited

Copy the payload (data in "value") from rhs into this node Opposed to copy ctor, this does not clone the children as well.

Referenced by octomap::ColorOcTreeNode::copyData(), and octomap::OcTreeNodeStamped::copyData().

◆ copyData() [2/2]

void octomap::OcTreeNodeStamped::copyData ( const OcTreeNodeStamped & from)
inline

References octomap::OcTreeDataNode< float >::copyData(), getTimestamp(), OcTreeNodeStamped(), and timestamp.

◆ getLogOdds()

float octomap::OcTreeNode::getLogOdds ( ) const
inlineinherited
Returns
log odds representation of occupancy probability of node

References octomap::OcTreeDataNode< float >::value.

Referenced by getMaxChildLogOdds(), octomap::AbstractOccupancyOcTree::isNodeAtThreshold(), octomap::AbstractOccupancyOcTree::isNodeAtThreshold(), octomap::AbstractOccupancyOcTree::isNodeOccupied(), octomap::AbstractOccupancyOcTree::isNodeOccupied(), and main().

◆ getMaxChildLogOdds()

float octomap::OcTreeNode::getMaxChildLogOdds ( ) const
inherited
Returns
maximum of children's occupancy probabilities, in log odds

References octomap::OcTreeDataNode< float >::children, getLogOdds(), and OcTreeNode().

Referenced by updateOccupancyChildren(), and octomap::OcTreeNodeStamped::updateOccupancyChildren().

◆ getMeanChildLogOdds()

double octomap::OcTreeNode::getMeanChildLogOdds ( ) const
inherited
Returns
mean of all children's occupancy probabilities, in log odds

References octomap::OcTreeDataNode< float >::children, getOccupancy(), and OcTreeNode().

◆ getOccupancy()

double octomap::OcTreeNode::getOccupancy ( ) const
inlineinherited
Returns
occupancy probability of node

References octomap::probability(), and octomap::OcTreeDataNode< float >::value.

Referenced by getMeanChildLogOdds(), octomap::ColorOcTree::integrateNodeColor(), main(), print_query_info(), and print_query_info().

◆ getTimestamp()

unsigned int octomap::OcTreeNodeStamped::getTimestamp ( ) const
inline

References timestamp.

Referenced by copyData(), and main().

◆ getValue()

float octomap::OcTreeDataNode< float >::getValue ( ) const
inlineinherited
Returns
value stored in the node

◆ OCTOMAP_DEPRECATED()

octomap::OcTreeDataNode< float >::OCTOMAP_DEPRECATED ( bool childExists(unsigned int i) const )
inherited

Test whether the i-th child exists.

Returns
true if the i-th child exists

◆ operator==() [1/2]

bool octomap::OcTreeDataNode< float >::operator== ( const OcTreeDataNode< float > & rhs) const
inherited

Equals operator, compares if the stored value is identical.

◆ operator==() [2/2]

bool octomap::OcTreeNodeStamped::operator== ( const OcTreeNodeStamped & rhs) const
inline

References OcTreeNodeStamped(), timestamp, octomap::OcTreeDataNode< T >::value, and octomap::OcTreeDataNode< float >::value.

◆ readData()

std::istream & octomap::OcTreeDataNode< float >::readData ( std::istream & s)
inherited

Read node payload (data only) from binary stream.

◆ setLogOdds()

void octomap::OcTreeNode::setLogOdds ( float l)
inlineinherited

sets log odds occupancy of node

References octomap::OcTreeDataNode< float >::value.

Referenced by updateOccupancyChildren(), and octomap::OcTreeNodeStamped::updateOccupancyChildren().

◆ setTimestamp()

void octomap::OcTreeNodeStamped::setTimestamp ( unsigned int t)
inline

References timestamp.

◆ setValue()

void octomap::OcTreeDataNode< float >::setValue ( float v)
inlineinherited

sets value to be stored in the node

◆ updateOccupancyChildren()

void octomap::OcTreeNodeStamped::updateOccupancyChildren ( )
inline

References octomap::OcTreeNode::getMaxChildLogOdds(), octomap::OcTreeNode::setLogOdds(), and updateTimestamp().

◆ updateTimestamp()

void octomap::OcTreeNodeStamped::updateTimestamp ( )
inline

References timestamp.

Referenced by octomap::OcTreeStamped::updateNodeLogOdds(), and updateOccupancyChildren().

◆ writeData()

std::ostream & octomap::OcTreeDataNode< float >::writeData ( std::ostream & s) const
inherited

Write node payload (data only) to binary stream.

Field Documentation

◆ children

AbstractOcTreeNode** octomap::OcTreeDataNode< float >::children
protectedinherited

pointer to array of children, may be NULL

Note
The tree class manages this pointer, the array, and the memory for it! The children of a node are always enforced to be the same type as the node

Referenced by octomap::ColorOcTreeNode::getAverageChildColor(), octomap::OcTreeNode::getMaxChildLogOdds(), and octomap::OcTreeNode::getMeanChildLogOdds().

◆ timestamp

unsigned int octomap::OcTreeNodeStamped::timestamp
protected

Referenced by copyData(), getTimestamp(), OcTreeNodeStamped(), OcTreeNodeStamped(), operator==(), setTimestamp(), and updateTimestamp().

◆ value

float octomap::OcTreeDataNode< float >::value
protectedinherited

stored data (payload)

Referenced by octomap::OcTreeNode::addValue(), octomap::OcTreeNode::getLogOdds(), octomap::OcTreeNode::getOccupancy(), octomap::ColorOcTreeNode::operator==(), octomap::OcTreeNodeStamped::operator==(), octomap::ColorOcTreeNode::readData(), octomap::OcTreeNode::setLogOdds(), and octomap::ColorOcTreeNode::writeData().

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