Point Cloud Library (PCL)
1.7.0
|
Implementation of the GrabCut segmentation in "GrabCut — Interactive Foreground Extraction using Iterated Graph Cuts" by Carsten Rother, Vladimir Kolmogorov and Andrew Blake. More...
#include <pcl/segmentation/grabcut.h>
Classes | |
struct | NLinks |
Public Types | |
typedef pcl::search::Search < PointT > | KdTree |
typedef pcl::search::Search < PointT >::Ptr | KdTreePtr |
typedef PCLBase< PointT > ::PointCloudConstPtr | PointCloudConstPtr |
typedef PCLBase< PointT > ::PointCloudPtr | PointCloudPtr |
Public Member Functions | |
GrabCut (uint32_t K=5, float lambda=50.f) | |
Constructor. | |
virtual | ~GrabCut () |
Desctructor. | |
void | setInputCloud (const PointCloudConstPtr &cloud) |
Provide a pointer to the input dataset. | |
void | setBackgroundPoints (const PointCloudConstPtr &background_points) |
Set background points, foreground points = points \ background points. | |
void | setBackgroundPointsIndices (int x1, int y1, int x2, int y2) |
Set background indices, foreground indices = indices \ background indices. | |
void | setBackgroundPointsIndices (const PointIndicesConstPtr &indices) |
Set background indices, foreground indices = indices \ background indices. | |
virtual void | refine () |
Run Grabcut refinement on the hard segmentation. | |
virtual int | refineOnce () |
float | getLambda () |
void | setLambda (float lambda) |
Set lambda parameter to user given value. | |
uint32_t | getK () |
void | setK (uint32_t K) |
Set K parameter to user given value. | |
void | setSearchMethod (const KdTreePtr &tree) |
Provide a pointer to the search object. | |
KdTreePtr | getSearchMethod () |
Get a pointer to the search method used. | |
void | setNumberOfNeighbours (int nb_neighbours) |
Allows to set the number of neighbours to find. | |
int | getNumberOfNeighbours () const |
Returns the number of neighbours to find. | |
void | extract (std::vector< pcl::PointIndices > &clusters) |
This method launches the segmentation algorithm and returns the clusters that were obtained during the segmentation. | |
Protected Types | |
typedef pcl::segmentation::grabcut::BoykovKolmogorov::vertex_descriptor | vertex_descriptor |
Protected Member Functions | |
bool | initCompute () |
This method should get called before starting the actual computation. | |
void | computeBeta () |
Update hard segmentation after running GraphCut,. | |
void | computeL () |
Compute L parameter from given lambda. | |
void | computeNLinks () |
Compute NLinks. | |
float | computeNLink (uint32_t x1, uint32_t y1, uint32_t x2, uint32_t y2) |
Compute NLinks at a specific rectangular location. | |
void | setTrimap (const PointIndicesConstPtr &indices, segmentation::grabcut::TrimapValue t) |
Edit Trimap. | |
int | updateHardSegmentation () |
virtual void | fitGMMs () |
Fit Gaussian Multi Models. | |
void | initGraph () |
Build the graph for GraphCut. | |
void | addEdge (vertex_descriptor v1, vertex_descriptor v2, float capacity, float rev_capacity) |
Add an edge to the graph, graph must be oriented so we add the edge and its reverse. | |
void | setTerminalWeights (vertex_descriptor v, float source_capacity, float sink_capacity) |
Set the weights of SOURCE --> v and v --> SINK. | |
bool | isSource (vertex_descriptor v) |
Protected Attributes | |
uint32_t | width_ |
image width | |
uint32_t | height_ |
image height | |
uint32_t | K_ |
Number of GMM components. | |
float | lambda_ |
lambda = 50. This value was suggested the GrabCut paper. | |
float | beta_ |
beta = 1/2 * average of the squared color distances between all pairs of 8-neighboring pixels. | |
float | L_ |
L = a large value to force a pixel to be foreground or background. | |
KdTreePtr | tree_ |
Pointer to the spatial search object. | |
int | nb_neighbours_ |
Number of neighbours. | |
bool | initialized_ |
is segmentation initialized | |
std::vector< NLinks > | n_links_ |
Precomputed N-link weights. | |
segmentation::grabcut::Image::Ptr | image_ |
Converted input. | |
std::vector < segmentation::grabcut::TrimapValue > | trimap_ |
std::vector< std::size_t > | GMM_component_ |
std::vector < segmentation::grabcut::SegmentationValue > | hard_segmentation_ |
std::vector< float > | soft_segmentation_ |
segmentation::grabcut::GMM | background_GMM_ |
segmentation::grabcut::GMM | foreground_GMM_ |
pcl::segmentation::grabcut::BoykovKolmogorov | graph_ |
Graph for Graphcut. | |
std::vector< vertex_descriptor > | graph_nodes_ |
Graph nodes. |
Implementation of the GrabCut segmentation in "GrabCut — Interactive Foreground Extraction using Iterated Graph Cuts" by Carsten Rother, Vladimir Kolmogorov and Andrew Blake.
typedef pcl::search::Search<PointT> pcl::GrabCut< PointT >::KdTree |
typedef pcl::search::Search<PointT>::Ptr pcl::GrabCut< PointT >::KdTreePtr |
typedef PCLBase<PointT>::PointCloudConstPtr pcl::GrabCut< PointT >::PointCloudConstPtr |
Reimplemented from pcl::PCLBase< PointT >.
typedef PCLBase<PointT>::PointCloudPtr pcl::GrabCut< PointT >::PointCloudPtr |
Reimplemented from pcl::PCLBase< PointT >.
typedef pcl::segmentation::grabcut::BoykovKolmogorov::vertex_descriptor pcl::GrabCut< PointT >::vertex_descriptor [protected] |
pcl::GrabCut< PointT >::GrabCut | ( | uint32_t | K = 5 , |
float | lambda = 50.f |
||
) | [inline] |
virtual pcl::GrabCut< PointT >::~GrabCut | ( | ) | [inline, virtual] |
void pcl::GrabCut< PointT >::addEdge | ( | vertex_descriptor | v1, |
vertex_descriptor | v2, | ||
float | capacity, | ||
float | rev_capacity | ||
) | [protected] |
Add an edge to the graph, graph must be oriented so we add the edge and its reverse.
Definition at line 89 of file grabcut.hpp.
void pcl::GrabCut< PointT >::computeBeta | ( | ) | [protected] |
Update hard segmentation after running GraphCut,.
Definition at line 321 of file grabcut.hpp.
References pcl::GrabCut< PointT >::NLinks::dists, pcl::GrabCut< PointT >::NLinks::indices, pcl::isFinite(), pcl::GrabCut< PointT >::NLinks::nb_links, pcl::squaredEuclideanDistance(), and pcl::GrabCut< PointT >::NLinks::weights.
void pcl::GrabCut< PointT >::computeL | ( | ) | [protected] |
Compute L parameter from given lambda.
Definition at line 362 of file grabcut.hpp.
float pcl::GrabCut< PointT >::computeNLink | ( | uint32_t | x1, |
uint32_t | y1, | ||
uint32_t | x2, | ||
uint32_t | y2 | ||
) | [protected] |
Compute NLinks at a specific rectangular location.
void pcl::GrabCut< PointT >::computeNLinks | ( | ) | [protected] |
Compute NLinks.
Definition at line 294 of file grabcut.hpp.
References pcl::GrabCut< PointT >::NLinks::dists, pcl::GrabCut< PointT >::NLinks::indices, pcl::GrabCut< PointT >::NLinks::nb_links, and pcl::GrabCut< PointT >::NLinks::weights.
void pcl::GrabCut< PointT >::extract | ( | std::vector< pcl::PointIndices > & | clusters | ) |
This method launches the segmentation algorithm and returns the clusters that were obtained during the segmentation.
The indices of points belonging to the object will be stored in the cluster with index 1, other indices will be stored in the cluster with index 0.
[out] | clusters | clusters that were obtained. Each cluster is an array of point indices. |
Definition at line 368 of file grabcut.hpp.
References pcl::segmentation::grabcut::SegmentationForeground.
void pcl::GrabCut< PointT >::fitGMMs | ( | ) | [protected, virtual] |
Fit Gaussian Multi Models.
Definition at line 143 of file grabcut.hpp.
References pcl::segmentation::grabcut::buildGMMs().
uint32_t pcl::GrabCut< PointT >::getK | ( | ) | [inline] |
Definition at line 371 of file grabcut.h.
References pcl::GrabCut< PointT >::K_.
float pcl::GrabCut< PointT >::getLambda | ( | ) | [inline] |
Definition at line 363 of file grabcut.h.
References pcl::GrabCut< PointT >::lambda_.
int pcl::GrabCut< PointT >::getNumberOfNeighbours | ( | ) | const [inline] |
Returns the number of neighbours to find.
Definition at line 392 of file grabcut.h.
References pcl::GrabCut< PointT >::nb_neighbours_.
KdTreePtr pcl::GrabCut< PointT >::getSearchMethod | ( | ) | [inline] |
Get a pointer to the search method used.
Definition at line 384 of file grabcut.h.
References pcl::GrabCut< PointT >::tree_.
bool pcl::GrabCut< PointT >::initCompute | ( | ) | [protected] |
This method should get called before starting the actual computation.
Internally, initCompute() does the following:
Reimplemented from pcl::PCLBase< PointT >.
Definition at line 29 of file grabcut.hpp.
References pcl::segmentation::grabcut::SegmentationBackground, and pcl::segmentation::grabcut::TrimapUnknown.
void pcl::GrabCut< PointT >::initGraph | ( | ) | [protected] |
Build the graph for GraphCut.
Definition at line 228 of file grabcut.hpp.
References pcl::GrabCut< PointT >::NLinks::indices, pcl::GrabCut< PointT >::NLinks::nb_links, pcl::segmentation::grabcut::TrimapBackground, pcl::segmentation::grabcut::TrimapUnknown, and pcl::GrabCut< PointT >::NLinks::weights.
bool pcl::GrabCut< PointT >::isSource | ( | vertex_descriptor | v | ) | [inline, protected] |
Definition at line 451 of file grabcut.h.
References pcl::GrabCut< PointT >::graph_, and pcl::segmentation::grabcut::BoykovKolmogorov::inSourceTree().
void pcl::GrabCut< PointT >::refine | ( | ) | [virtual] |
Run Grabcut refinement on the hard segmentation.
Definition at line 170 of file grabcut.hpp.
int pcl::GrabCut< PointT >::refineOnce | ( | ) | [virtual] |
Definition at line 153 of file grabcut.hpp.
References pcl::segmentation::grabcut::learnGMMs().
void pcl::GrabCut< PointT >::setBackgroundPoints | ( | const PointCloudConstPtr & | background_points | ) |
Set background points, foreground points = points \ background points.
void pcl::GrabCut< PointT >::setBackgroundPointsIndices | ( | int | x1, |
int | y1, | ||
int | x2, | ||
int | y2 | ||
) |
Set background indices, foreground indices = indices \ background indices.
void pcl::GrabCut< PointT >::setBackgroundPointsIndices | ( | const PointIndicesConstPtr & | indices | ) |
Set background indices, foreground indices = indices \ background indices.
Definition at line 121 of file grabcut.hpp.
References pcl::segmentation::grabcut::SegmentationBackground, pcl::segmentation::grabcut::SegmentationForeground, pcl::segmentation::grabcut::TrimapBackground, and pcl::segmentation::grabcut::TrimapUnknown.
void pcl::GrabCut< PointT >::setInputCloud | ( | const PointCloudConstPtr & | cloud | ) | [virtual] |
Provide a pointer to the input dataset.
[in] | cloud | the const boost shared pointer to a PointCloud message |
Reimplemented from pcl::PCLBase< PointT >.
Definition at line 23 of file grabcut.hpp.
void pcl::GrabCut< PointT >::setK | ( | uint32_t | K | ) | [inline] |
Set K parameter to user given value.
Suggested value by the authors is 5
[in] | K | the number of components used in GMM |
Definition at line 376 of file grabcut.h.
References pcl::K, and pcl::GrabCut< PointT >::K_.
void pcl::GrabCut< PointT >::setLambda | ( | float | lambda | ) | [inline] |
Set lambda parameter to user given value.
Suggested value by the authors is 50
[in] | lambda |
Definition at line 368 of file grabcut.h.
References pcl::GrabCut< PointT >::lambda_.
void pcl::GrabCut< PointT >::setNumberOfNeighbours | ( | int | nb_neighbours | ) | [inline] |
Allows to set the number of neighbours to find.
[in] | number_of_neighbours | new number of neighbours |
Definition at line 389 of file grabcut.h.
References pcl::GrabCut< PointT >::nb_neighbours_.
void pcl::GrabCut< PointT >::setSearchMethod | ( | const KdTreePtr & | tree | ) | [inline] |
Provide a pointer to the search object.
tree | a pointer to the spatial search object. |
Definition at line 381 of file grabcut.h.
References pcl::GrabCut< PointT >::tree_.
void pcl::GrabCut< PointT >::setTerminalWeights | ( | vertex_descriptor | v, |
float | source_capacity, | ||
float | sink_capacity | ||
) | [protected] |
Set the weights of SOURCE --> v and v --> SINK.
Definition at line 95 of file grabcut.hpp.
void pcl::GrabCut< PointT >::setTrimap | ( | const PointIndicesConstPtr & | indices, |
segmentation::grabcut::TrimapValue | t | ||
) | [protected] |
Edit Trimap.
Definition at line 210 of file grabcut.hpp.
References pcl::segmentation::grabcut::SegmentationBackground, pcl::segmentation::grabcut::SegmentationForeground, pcl::segmentation::grabcut::TrimapBackground, and pcl::segmentation::grabcut::TrimapForeground.
int pcl::GrabCut< PointT >::updateHardSegmentation | ( | ) | [protected] |
Definition at line 179 of file grabcut.hpp.
References pcl::segmentation::grabcut::SegmentationBackground, pcl::segmentation::grabcut::SegmentationForeground, pcl::segmentation::grabcut::TrimapBackground, and pcl::segmentation::grabcut::TrimapForeground.
segmentation::grabcut::GMM pcl::GrabCut< PointT >::background_GMM_ [protected] |
float pcl::GrabCut< PointT >::beta_ [protected] |
segmentation::grabcut::GMM pcl::GrabCut< PointT >::foreground_GMM_ [protected] |
std::vector<std::size_t> pcl::GrabCut< PointT >::GMM_component_ [protected] |
pcl::segmentation::grabcut::BoykovKolmogorov pcl::GrabCut< PointT >::graph_ [protected] |
Graph for Graphcut.
Definition at line 483 of file grabcut.h.
Referenced by pcl::GrabCut< PointT >::isSource().
std::vector<vertex_descriptor> pcl::GrabCut< PointT >::graph_nodes_ [protected] |
std::vector<segmentation::grabcut::SegmentationValue> pcl::GrabCut< PointT >::hard_segmentation_ [protected] |
uint32_t pcl::GrabCut< PointT >::height_ [protected] |
segmentation::grabcut::Image::Ptr pcl::GrabCut< PointT >::image_ [protected] |
bool pcl::GrabCut< PointT >::initialized_ [protected] |
uint32_t pcl::GrabCut< PointT >::K_ [protected] |
Number of GMM components.
Definition at line 458 of file grabcut.h.
Referenced by pcl::GrabCut< PointT >::getK(), and pcl::GrabCut< PointT >::setK().
float pcl::GrabCut< PointT >::L_ [protected] |
float pcl::GrabCut< PointT >::lambda_ [protected] |
lambda = 50. This value was suggested the GrabCut paper.
Definition at line 460 of file grabcut.h.
Referenced by pcl::GrabCut< PointT >::getLambda(), and pcl::GrabCut< PointT >::setLambda().
std::vector<NLinks> pcl::GrabCut< PointT >::n_links_ [protected] |
int pcl::GrabCut< PointT >::nb_neighbours_ [protected] |
Number of neighbours.
Definition at line 468 of file grabcut.h.
Referenced by pcl::GrabCut< PointT >::getNumberOfNeighbours(), and pcl::GrabCut< PointT >::setNumberOfNeighbours().
std::vector<float> pcl::GrabCut< PointT >::soft_segmentation_ [protected] |
KdTreePtr pcl::GrabCut< PointT >::tree_ [protected] |
Pointer to the spatial search object.
Definition at line 466 of file grabcut.h.
Referenced by pcl::GrabCut< PointT >::getSearchMethod(), and pcl::GrabCut< PointT >::setSearchMethod().
std::vector<segmentation::grabcut::TrimapValue> pcl::GrabCut< PointT >::trimap_ [protected] |
uint32_t pcl::GrabCut< PointT >::width_ [protected] |