Public Member Functions | Private Attributes
rail::segmentation::SegmentationZone Class Reference

The criteria for a segmentation zone. More...

#include <SegmentationZone.h>

List of all members.

Public Member Functions

const std::string & getBoundingFrameID () const
 Segmentation frame ID value accessor.
const std::string & getChildFrameID () const
 Child frame ID value accessor.
const std::string & getName () const
 Name value accessor.
const std::string & getParentFrameID () const
 Parent frame ID value accessor.
double getPitchMax () const
 Pitch max value accessor.
double getPitchMin () const
 Pitch min value accessor.
bool getRemoveSurface () const
 Remove surface value accessor.
double getRollMax () const
 Roll max value accessor.
double getRollMin () const
 Roll min value accessor.
const std::string & getSegmentationFrameID () const
 Segmentation frame ID value accessor.
double getXMax () const
 X max value accessor.
double getXMin () const
 X min value accessor.
double getYawMax () const
 Yaw max value accessor.
double getYawMin () const
 Yaw min value accessor.
double getYMax () const
 Y max value accessor.
double getYMin () const
 Y min value accessor.
double getZMax () const
 Z max value accessor.
double getZMin () const
 Z min value accessor.
 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.
void setBoundingFrameID (const std::string &bounding_frame_id)
 Bounding frame ID value mutator.
void setChildFrameID (const std::string &child_frame_id)
 Child frame ID value mutator.
void setName (const std::string &name)
 Name value mutator.
void setParentFrameID (const std::string &parent_frame_id)
 Parent frame ID value mutator.
void setPitchMax (const double pitch_max)
 Pitch max value mutator.
void setPitchMin (const double pitch_min)
 Pitch min value mutator.
void setRemoveSurface (const bool remove_surface)
 Remove surface value mutator.
void setRollMax (const double roll_max)
 Roll max value mutator.
void setRollMin (const double roll_min)
 Roll min value mutator.
void setSegmentationFrameID (const std::string &segmentation_frame_id)
 Segmentation frame ID value mutator.
void setXMax (const double x_max)
 X max value mutator.
void setXMin (const double x_min)
 X min value mutator.
void setYawMax (const double yaw_max)
 Yaw max value mutator.
void setYawMin (const double yaw_min)
 Yaw min value mutator.
void setYMax (const double y_max)
 Y max value mutator.
void setYMin (const double y_min)
 Y min value mutator.
void setZMax (const double z_max)
 Z max value mutator.
void setZMin (const double z_min)
 Z min value mutator.

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_
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 ( 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:
nameThe name of the zone (defaults to the empty string).
parent_frame_idThe parent frame of the transform to monitor (defaults to the empty string).
child_frame_idThe child frame of the transform to monitor (defaults to the empty string).
bounding_frame_idThe frame the X, Y, and Z bounds are defined in (defaults to the empty string).
segmentation_frame_idThe frame that segmented objects should be defined in (defaults to the empty string).

Definition at line 21 of file SegmentationZone.cpp.


Member Function Documentation

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 100 of file SegmentationZone.cpp.

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 80 of file SegmentationZone.cpp.

const string & SegmentationZone::getName ( ) const

Name value accessor.

Get the name value of this SegmentationZone.

Returns:
The name value.

Definition at line 60 of file SegmentationZone.cpp.

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 70 of file SegmentationZone.cpp.

Pitch max value accessor.

Get the pitch max value of this SegmentationZone.

Returns:
The pitch max value.

Definition at line 140 of file SegmentationZone.cpp.

Pitch min value accessor.

Get the pitch min value of this SegmentationZone.

Returns:
The pitch min value.

Definition at line 130 of file SegmentationZone.cpp.

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 50 of file SegmentationZone.cpp.

double SegmentationZone::getRollMax ( ) const

Roll max value accessor.

Get the roll max value of this SegmentationZone.

Returns:
The roll max value.

Definition at line 120 of file SegmentationZone.cpp.

double SegmentationZone::getRollMin ( ) const

Roll min value accessor.

Get the roll min value of this SegmentationZone.

Returns:
The roll min value.

Definition at line 110 of file SegmentationZone.cpp.

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 90 of file SegmentationZone.cpp.

double SegmentationZone::getXMax ( ) const

X max value accessor.

Get the x max value of this SegmentationZone.

Returns:
The x max value.

Definition at line 181 of file SegmentationZone.cpp.

double SegmentationZone::getXMin ( ) const

X min value accessor.

Get the x min value of this SegmentationZone.

Returns:
The x min value.

Definition at line 171 of file SegmentationZone.cpp.

double SegmentationZone::getYawMax ( ) const

Yaw max value accessor.

Get the yaw max value of this SegmentationZone.

Returns:
The yaw max value.

Definition at line 160 of file SegmentationZone.cpp.

double SegmentationZone::getYawMin ( ) const

Yaw min value accessor.

Get the yaw min value of this SegmentationZone.

Returns:
The yaw min value.

Definition at line 150 of file SegmentationZone.cpp.

double SegmentationZone::getYMax ( ) const

Y max value accessor.

Get the y max value of this SegmentationZone.

Returns:
The y max value.

Definition at line 201 of file SegmentationZone.cpp.

double SegmentationZone::getYMin ( ) const

Y min value accessor.

Get the y min value of this SegmentationZone.

Returns:
The y min value.

Definition at line 191 of file SegmentationZone.cpp.

double SegmentationZone::getZMax ( ) const

Z max value accessor.

Get the z max value of this SegmentationZone.

Returns:
The z max value.

Definition at line 221 of file SegmentationZone.cpp.

double SegmentationZone::getZMin ( ) const

Z min value accessor.

Get the z min value of this SegmentationZone.

Returns:
The z min value.

Definition at line 211 of file SegmentationZone.cpp.

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_idThe new bounding frame ID value.

Definition at line 95 of file SegmentationZone.cpp.

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_idThe new child frame ID value.

Definition at line 75 of file SegmentationZone.cpp.

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

Name value mutator.

Set the name value of this SegmentationZone.

Parameters:
nameThe new name ID value.

Definition at line 55 of file SegmentationZone.cpp.

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_idThe new parent frame ID value.

Definition at line 65 of file SegmentationZone.cpp.

void SegmentationZone::setPitchMax ( const double  pitch_max)

Pitch max value mutator.

Set the pitch max of this SegmentationZone.

Parameters:
pitch_maxThe new pitch max ID value.

Definition at line 135 of file SegmentationZone.cpp.

void SegmentationZone::setPitchMin ( const double  pitch_min)

Pitch min value mutator.

Set the pitch min of this SegmentationZone.

Parameters:
pitch_minThe new pitch min ID value.

Definition at line 125 of file SegmentationZone.cpp.

void SegmentationZone::setRemoveSurface ( const bool  remove_surface)

Remove surface value mutator.

Set the remove surface value of this SegmentationZone.

Parameters:
remove_surfaceThe new remove surface value.

Definition at line 45 of file SegmentationZone.cpp.

void SegmentationZone::setRollMax ( const double  roll_max)

Roll max value mutator.

Set the roll max of this SegmentationZone.

Parameters:
roll_maxThe new roll max ID value.

Definition at line 115 of file SegmentationZone.cpp.

void SegmentationZone::setRollMin ( const double  roll_min)

Roll min value mutator.

Set the roll min of this SegmentationZone.

Parameters:
roll_minThe new roll min ID value.

Definition at line 105 of file SegmentationZone.cpp.

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_idThe new segmentation frame ID value.

Definition at line 85 of file SegmentationZone.cpp.

void SegmentationZone::setXMax ( const double  x_max)

X max value mutator.

Set the x max of this SegmentationZone.

Parameters:
x_maxThe new x max ID value.

Definition at line 176 of file SegmentationZone.cpp.

void SegmentationZone::setXMin ( const double  x_min)

X min value mutator.

Set the x min of this SegmentationZone.

Parameters:
x_minThe new x min ID value.

Definition at line 166 of file SegmentationZone.cpp.

void SegmentationZone::setYawMax ( const double  yaw_max)

Yaw max value mutator.

Set the yaw max of this SegmentationZone.

Parameters:
yaw_maxThe new yaw max ID value.

Definition at line 155 of file SegmentationZone.cpp.

void SegmentationZone::setYawMin ( const double  yaw_min)

Yaw min value mutator.

Set the yaw min of this SegmentationZone.

Parameters:
yaw_minThe new yaw min ID value.

Definition at line 145 of file SegmentationZone.cpp.

void SegmentationZone::setYMax ( const double  y_max)

Y max value mutator.

Set the y max of this SegmentationZone.

Parameters:
y_maxThe new y max ID value.

Definition at line 196 of file SegmentationZone.cpp.

void SegmentationZone::setYMin ( const double  y_min)

Y min value mutator.

Set the y min of this SegmentationZone.

Parameters:
y_minThe new y min ID value.

Definition at line 186 of file SegmentationZone.cpp.

void SegmentationZone::setZMax ( const double  z_max)

Z max value mutator.

Set the z max of this SegmentationZone.

Parameters:
z_maxThe new z max ID value.

Definition at line 216 of file SegmentationZone.cpp.

void SegmentationZone::setZMin ( const double  z_min)

Z min value mutator.

Set the z min of this SegmentationZone.

Parameters:
z_minThe new z min ID value.

Definition at line 206 of file SegmentationZone.cpp.


Member Data Documentation

Definition at line 377 of file SegmentationZone.h.

Definition at line 377 of file SegmentationZone.h.

The associated name and frame information for this zone.

Definition at line 377 of file SegmentationZone.h.

Definition at line 377 of file SegmentationZone.h.

Definition at line 379 of file SegmentationZone.h.

Definition at line 379 of file SegmentationZone.h.

If a surface removal should be done.

Definition at line 375 of file SegmentationZone.h.

Definition at line 379 of file SegmentationZone.h.

The limits for this zone.

Definition at line 379 of file SegmentationZone.h.

Definition at line 377 of file SegmentationZone.h.

Definition at line 379 of file SegmentationZone.h.

Definition at line 379 of file SegmentationZone.h.

Definition at line 379 of file SegmentationZone.h.

Definition at line 379 of file SegmentationZone.h.

Definition at line 379 of file SegmentationZone.h.

Definition at line 379 of file SegmentationZone.h.

Definition at line 379 of file SegmentationZone.h.

Definition at line 379 of file SegmentationZone.h.


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


rail_segmentation
Author(s): Russell Toris , David Kent
autogenerated on Tue Sep 20 2016 03:52:24