The criteria for a segmentation zone. More...

#include <SegmentationZone.h>

Public Member Functions
const std::string &	getBoundingFrameID () const
	Segmentation frame ID value accessor. More...

const std::string &	getChildFrameID () const
	Child frame ID value accessor. More...

const std::string &	getName () const
	Name value accessor. More...

const std::string &	getParentFrameID () const
	Parent frame ID value accessor. More...

double	getPitchMax () const
	Pitch max value accessor. More...

double	getPitchMin () const
	Pitch min value accessor. More...

bool	getRemoveSurface () const
	Remove surface value accessor. More...

bool	getRequireSurface () const
	Remove surface value accessor. More...

double	getRollMax () const
	Roll max value accessor. More...

double	getRollMin () const
	Roll min value accessor. More...

const std::string &	getSegmentationFrameID () const
	Segmentation frame ID value accessor. More...

double	getXMax () const
	X max value accessor. More...

double	getXMin () const
	X min value accessor. More...

double	getYawMax () const
	Yaw max value accessor. More...

double	getYawMin () const
	Yaw min value accessor. More...

double	getYMax () const
	Y max value accessor. More...

double	getYMin () const
	Y min value accessor. More...

double	getZMax () const
	Z max value accessor. More...

double	getZMin () const
	Z min value accessor. More...

	SegmentationZone (const std::string &name="", const std::string &parent_frame_id="", const std::string &child_frame_id="", const std::string &bounding_frame_id="", const std::string &segmentation_frame_id="")
	Create a SegmentationZone with the given frame information. More...

void	setBoundingFrameID (const std::string &bounding_frame_id)
	Bounding frame ID value mutator. More...

void	setChildFrameID (const std::string &child_frame_id)
	Child frame ID value mutator. More...

void	setName (const std::string &name)
	Name value mutator. More...

void	setParentFrameID (const std::string &parent_frame_id)
	Parent frame ID value mutator. More...

void	setPitchMax (const double pitch_max)
	Pitch max value mutator. More...

void	setPitchMin (const double pitch_min)
	Pitch min value mutator. More...

void	setRemoveSurface (const bool remove_surface)
	Remove surface value mutator. More...

void	setRequireSurface (const bool require_surface)
	Require surface value mutator. More...

void	setRollMax (const double roll_max)
	Roll max value mutator. More...

void	setRollMin (const double roll_min)
	Roll min value mutator. More...

void	setSegmentationFrameID (const std::string &segmentation_frame_id)
	Segmentation frame ID value mutator. More...

void	setXMax (const double x_max)
	X max value mutator. More...

void	setXMin (const double x_min)
	X min value mutator. More...

void	setYawMax (const double yaw_max)
	Yaw max value mutator. More...

void	setYawMin (const double yaw_min)
	Yaw min value mutator. More...

void	setYMax (const double y_max)
	Y max value mutator. More...

void	setYMin (const double y_min)
	Y min value mutator. More...

void	setZMax (const double z_max)
	Z max value mutator. More...

void	setZMin (const double z_min)
	Z min value mutator. More...

Private Attributes
std::string	bounding_frame_id_

std::string	child_frame_id_

std::string	name_

std::string	parent_frame_id_

double	pitch_max_

double	pitch_min_

bool	remove_surface_

bool	require_surface_

double	roll_max_

double	roll_min_

std::string	segmentation_frame_id_

double	x_max_

double	x_min_

double	y_max_

double	y_min_

double	yaw_max_

double	yaw_min_

double	z_max_

double	z_min_

Detailed Description

The criteria for a segmentation zone.

Segmentation zones are defined by X, Y, and Z bounds for use in segmenation. There are determined by bounds placed on the RPY of a given transform. Each zone also has associated frame information.

Definition at line 30 of file SegmentationZone.h.

Constructor & Destructor Documentation

◆ SegmentationZone()

SegmentationZone::SegmentationZone	(	const std::string &	name = `""`,
		const std::string &	parent_frame_id = `""`,
		const std::string &	child_frame_id = `""`,
		const std::string &	bounding_frame_id = `""`,
		const std::string &	segmentation_frame_id = `""`
	)

Create a SegmentationZone with the given frame information.

Creates a new segmenation zone with the given frame information. Default minimum values will be -infinity and default maximum values will be infinity. The remove surface flag also defaults to true.

Parameters

name	The name of the zone (defaults to the empty string).
parent_frame_id	The parent frame of the transform to monitor (defaults to the empty string).
child_frame_id	The child frame of the transform to monitor (defaults to the empty string).
bounding_frame_id	The frame the X, Y, and Z bounds are defined in (defaults to the empty string).
segmentation_frame_id	The frame that segmented objects should be defined in (defaults to the empty string).

Definition at line 21 of file SegmentationZone.cpp.

Member Function Documentation

◆ getBoundingFrameID()

const string & SegmentationZone::getBoundingFrameID ( ) const

Segmentation frame ID value accessor.

Get the bounding frame ID value of this SegmentationZone.

Returns: The bounding frame ID value.

Definition at line 111 of file SegmentationZone.cpp.

◆ getChildFrameID()

const string & SegmentationZone::getChildFrameID ( ) const

Child frame ID value accessor.

Get the child frame ID value of this SegmentationZone.

Returns: The child frame ID value.

Definition at line 91 of file SegmentationZone.cpp.

◆ getName()

const string & SegmentationZone::getName ( ) const

Name value accessor.

Get the name value of this SegmentationZone.

Returns: The name value.

Definition at line 71 of file SegmentationZone.cpp.

◆ getParentFrameID()

const string & SegmentationZone::getParentFrameID ( ) const

Parent frame ID value accessor.

Get the parent frame ID value of this SegmentationZone.

Returns: The parent frame ID value.

Definition at line 81 of file SegmentationZone.cpp.

◆ getPitchMax()

double SegmentationZone::getPitchMax ( ) const

Pitch max value accessor.

Get the pitch max value of this SegmentationZone.

Returns: The pitch max value.

Definition at line 151 of file SegmentationZone.cpp.

◆ getPitchMin()

double SegmentationZone::getPitchMin ( ) const

Pitch min value accessor.

Get the pitch min value of this SegmentationZone.

Returns: The pitch min value.

Definition at line 141 of file SegmentationZone.cpp.

◆ getRemoveSurface()

bool SegmentationZone::getRemoveSurface ( ) const

Remove surface value accessor.

Check if a surface detection and removal should be performed in this zone.

Returns: The remove surface value value.

Definition at line 51 of file SegmentationZone.cpp.

◆ getRequireSurface()

bool SegmentationZone::getRequireSurface ( ) const

Remove surface value accessor.

Check if surface detection is required to succeed before segmentation continues. Only used if remove_surface_ is true.

Returns: The require surface value value.

Definition at line 61 of file SegmentationZone.cpp.

◆ getRollMax()

double SegmentationZone::getRollMax ( ) const

Roll max value accessor.

Get the roll max value of this SegmentationZone.

Returns: The roll max value.

Definition at line 131 of file SegmentationZone.cpp.

◆ getRollMin()

double SegmentationZone::getRollMin ( ) const

Roll min value accessor.

Get the roll min value of this SegmentationZone.

Returns: The roll min value.

Definition at line 121 of file SegmentationZone.cpp.

◆ getSegmentationFrameID()

const string & SegmentationZone::getSegmentationFrameID ( ) const

Segmentation frame ID value accessor.

Get the segmentation frame ID value of this SegmentationZone.

Returns: The segmentation frame ID value.

Definition at line 101 of file SegmentationZone.cpp.

◆ getXMax()

double SegmentationZone::getXMax ( ) const

X max value accessor.

Get the x max value of this SegmentationZone.

Returns: The x max value.

Definition at line 192 of file SegmentationZone.cpp.

◆ getXMin()

double SegmentationZone::getXMin ( ) const

X min value accessor.

Get the x min value of this SegmentationZone.

Returns: The x min value.

Definition at line 182 of file SegmentationZone.cpp.

◆ getYawMax()

double SegmentationZone::getYawMax ( ) const

Yaw max value accessor.

Get the yaw max value of this SegmentationZone.

Returns: The yaw max value.

Definition at line 171 of file SegmentationZone.cpp.

◆ getYawMin()

double SegmentationZone::getYawMin ( ) const

Yaw min value accessor.

Get the yaw min value of this SegmentationZone.

Returns: The yaw min value.

Definition at line 161 of file SegmentationZone.cpp.

◆ getYMax()

double SegmentationZone::getYMax ( ) const

Y max value accessor.

Get the y max value of this SegmentationZone.

Returns: The y max value.

Definition at line 212 of file SegmentationZone.cpp.

◆ getYMin()

double SegmentationZone::getYMin ( ) const

Y min value accessor.

Get the y min value of this SegmentationZone.

Returns: The y min value.

Definition at line 202 of file SegmentationZone.cpp.

◆ getZMax()

double SegmentationZone::getZMax ( ) const

Z max value accessor.

Get the z max value of this SegmentationZone.

Returns: The z max value.

Definition at line 232 of file SegmentationZone.cpp.

◆ getZMin()

double SegmentationZone::getZMin ( ) const

Z min value accessor.

Get the z min value of this SegmentationZone.

Returns: The z min value.

Definition at line 222 of file SegmentationZone.cpp.

◆ setBoundingFrameID()

void SegmentationZone::setBoundingFrameID ( const std::string & bounding_frame_id )

Bounding frame ID value mutator.

Set the bounding frame ID value of this SegmentationZone.

Parameters

bounding_frame_id The new bounding frame ID value.

Definition at line 106 of file SegmentationZone.cpp.

◆ setChildFrameID()

void SegmentationZone::setChildFrameID ( const std::string & child_frame_id )

Child frame ID value mutator.

Set the child frame ID value of this SegmentationZone.

Parameters

child_frame_id The new child frame ID value.

Definition at line 86 of file SegmentationZone.cpp.

◆ setName()

void SegmentationZone::setName ( const std::string & name )

Name value mutator.

Set the name value of this SegmentationZone.

Parameters

name	The new name ID value.

Definition at line 66 of file SegmentationZone.cpp.

◆ setParentFrameID()

void SegmentationZone::setParentFrameID ( const std::string & parent_frame_id )

Parent frame ID value mutator.

Set the parent frame ID value of this SegmentationZone.

Parameters

parent_frame_id The new parent frame ID value.

Definition at line 76 of file SegmentationZone.cpp.

◆ setPitchMax()

void SegmentationZone::setPitchMax ( const double pitch_max )

Pitch max value mutator.

Set the pitch max of this SegmentationZone.

Parameters

pitch_max The new pitch max ID value.

Definition at line 146 of file SegmentationZone.cpp.

◆ setPitchMin()

void SegmentationZone::setPitchMin ( const double pitch_min )

Pitch min value mutator.

Set the pitch min of this SegmentationZone.

Parameters

pitch_min The new pitch min ID value.

Definition at line 136 of file SegmentationZone.cpp.

◆ setRemoveSurface()

void SegmentationZone::setRemoveSurface ( const bool remove_surface )

Remove surface value mutator.

Set the remove surface value of this SegmentationZone.

Parameters

remove_surface The new remove surface value.

Definition at line 46 of file SegmentationZone.cpp.

◆ setRequireSurface()

void SegmentationZone::setRequireSurface ( const bool require_surface )

Require surface value mutator.

Set the require surface value of this SegmentationZone.

Parameters

require_surface The new require surface value.

Definition at line 56 of file SegmentationZone.cpp.

◆ setRollMax()

void SegmentationZone::setRollMax ( const double roll_max )

Roll max value mutator.

Set the roll max of this SegmentationZone.

Parameters

roll_max The new roll max ID value.

Definition at line 126 of file SegmentationZone.cpp.

◆ setRollMin()

void SegmentationZone::setRollMin ( const double roll_min )

Roll min value mutator.

Set the roll min of this SegmentationZone.

Parameters

roll_min The new roll min ID value.

Definition at line 116 of file SegmentationZone.cpp.

◆ setSegmentationFrameID()

void SegmentationZone::setSegmentationFrameID ( const std::string & segmentation_frame_id )

Segmentation frame ID value mutator.

Set the segmentation frame ID value of this SegmentationZone.

Parameters

segmentation_frame_id The new segmentation frame ID value.

Definition at line 96 of file SegmentationZone.cpp.

◆ setXMax()

void SegmentationZone::setXMax ( const double x_max )

X max value mutator.

Set the x max of this SegmentationZone.

Parameters

x_max The new x max ID value.

Definition at line 187 of file SegmentationZone.cpp.

◆ setXMin()

void SegmentationZone::setXMin ( const double x_min )

X min value mutator.

Set the x min of this SegmentationZone.

Parameters

x_min The new x min ID value.

Definition at line 177 of file SegmentationZone.cpp.

◆ setYawMax()

void SegmentationZone::setYawMax ( const double yaw_max )

Yaw max value mutator.

Set the yaw max of this SegmentationZone.

Parameters

yaw_max The new yaw max ID value.

Definition at line 166 of file SegmentationZone.cpp.

◆ setYawMin()

void SegmentationZone::setYawMin ( const double yaw_min )

Yaw min value mutator.

Set the yaw min of this SegmentationZone.

Parameters

yaw_min The new yaw min ID value.

Definition at line 156 of file SegmentationZone.cpp.

◆ setYMax()

void SegmentationZone::setYMax ( const double y_max )

Y max value mutator.

Set the y max of this SegmentationZone.

Parameters

y_max The new y max ID value.

Definition at line 207 of file SegmentationZone.cpp.

◆ setYMin()

void SegmentationZone::setYMin ( const double y_min )

Y min value mutator.

Set the y min of this SegmentationZone.

Parameters

y_min The new y min ID value.

Definition at line 197 of file SegmentationZone.cpp.

◆ setZMax()

void SegmentationZone::setZMax ( const double z_max )

Z max value mutator.

Set the z max of this SegmentationZone.

Parameters

z_max The new z max ID value.

Definition at line 227 of file SegmentationZone.cpp.

◆ setZMin()

void SegmentationZone::setZMin ( const double z_min )

Z min value mutator.

Set the z min of this SegmentationZone.

Parameters

z_min The new z min ID value.

Definition at line 217 of file SegmentationZone.cpp.

Member Data Documentation

◆ bounding_frame_id_

std::string rail::segmentation::SegmentationZone::bounding_frame_id_

private

Definition at line 396 of file SegmentationZone.h.

◆ child_frame_id_

std::string rail::segmentation::SegmentationZone::child_frame_id_

private

Definition at line 396 of file SegmentationZone.h.

◆ name_

std::string rail::segmentation::SegmentationZone::name_

private

The associated name and frame information for this zone.

Definition at line 396 of file SegmentationZone.h.

◆ parent_frame_id_

std::string rail::segmentation::SegmentationZone::parent_frame_id_

private

Definition at line 396 of file SegmentationZone.h.

◆ pitch_max_

double rail::segmentation::SegmentationZone::pitch_max_

private

Definition at line 398 of file SegmentationZone.h.

◆ pitch_min_

double rail::segmentation::SegmentationZone::pitch_min_

private

Definition at line 398 of file SegmentationZone.h.

◆ remove_surface_

bool rail::segmentation::SegmentationZone::remove_surface_

private

If a surface removal should be done.

Definition at line 394 of file SegmentationZone.h.

◆ require_surface_

bool rail::segmentation::SegmentationZone::require_surface_

private

Definition at line 394 of file SegmentationZone.h.

◆ roll_max_

double rail::segmentation::SegmentationZone::roll_max_

private

Definition at line 398 of file SegmentationZone.h.

◆ roll_min_

double rail::segmentation::SegmentationZone::roll_min_

private

The limits for this zone.

Definition at line 398 of file SegmentationZone.h.

◆ segmentation_frame_id_

std::string rail::segmentation::SegmentationZone::segmentation_frame_id_

private

Definition at line 396 of file SegmentationZone.h.

◆ x_max_

double rail::segmentation::SegmentationZone::x_max_

private

Definition at line 398 of file SegmentationZone.h.

◆ x_min_

double rail::segmentation::SegmentationZone::x_min_

private

Definition at line 398 of file SegmentationZone.h.

◆ y_max_

double rail::segmentation::SegmentationZone::y_max_

private

Definition at line 398 of file SegmentationZone.h.

◆ y_min_

double rail::segmentation::SegmentationZone::y_min_

private

Definition at line 398 of file SegmentationZone.h.

◆ yaw_max_

double rail::segmentation::SegmentationZone::yaw_max_

private

Definition at line 398 of file SegmentationZone.h.

◆ yaw_min_

double rail::segmentation::SegmentationZone::yaw_min_

private

Definition at line 398 of file SegmentationZone.h.

◆ z_max_

double rail::segmentation::SegmentationZone::z_max_

private

Definition at line 398 of file SegmentationZone.h.

◆ z_min_

double rail::segmentation::SegmentationZone::z_min_

private

Definition at line 398 of file SegmentationZone.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SegmentationZone()

Member Function Documentation

◆ getBoundingFrameID()

◆ getChildFrameID()

◆ getName()

◆ getParentFrameID()

◆ getPitchMax()

◆ getPitchMin()

◆ getRemoveSurface()

◆ getRequireSurface()

◆ getRollMax()

◆ getRollMin()

◆ getSegmentationFrameID()

◆ getXMax()

◆ getXMin()

◆ getYawMax()

◆ getYawMin()

◆ getYMax()

◆ getYMin()

◆ getZMax()

◆ getZMin()

◆ setBoundingFrameID()

◆ setChildFrameID()

◆ setName()

◆ setParentFrameID()

◆ setPitchMax()

◆ setPitchMin()

◆ setRemoveSurface()

◆ setRequireSurface()

◆ setRollMax()

◆ setRollMin()

◆ setSegmentationFrameID()

◆ setXMax()

◆ setXMin()

◆ setYawMax()

◆ setYawMin()

◆ setYMax()

◆ setYMin()

◆ setZMax()

◆ setZMin()

Member Data Documentation

◆ bounding_frame_id_

◆ child_frame_id_

◆ name_

◆ parent_frame_id_

◆ pitch_max_

◆ pitch_min_

◆ remove_surface_

◆ require_surface_

◆ roll_max_

◆ roll_min_

◆ segmentation_frame_id_

◆ x_max_

◆ x_min_

◆ y_max_

◆ y_min_

◆ yaw_max_

◆ yaw_min_

◆ z_max_

◆ z_min_