Volume Cartographer 2.27.0
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
volcart::segmentation::RegionGrowingSegmentationAlgorithmBaseClass Class Referenceabstract

Base class for segmentation algorithms that create a segmentation by growing from a set of seed points. More...

#include <vc/segmentation/RegionGrowingSegmentationAlgorithmBaseClass.hpp>

Inheritance diagram for volcart::segmentation::RegionGrowingSegmentationAlgorithmBaseClass:
[legend]
Collaboration diagram for volcart::segmentation::RegionGrowingSegmentationAlgorithmBaseClass:
[legend]

Public Types

enum class  Status { Success , Failure , ReturnedEarly }
 
using SeedPoints = std::vector< cv::Vec3d >
 
using PointSet = volcart::PointSet< cv::Vec3d >
 

Public Member Functions

 RegionGrowingSegmentationAlgorithmBaseClass (const RegionGrowingSegmentationAlgorithmBaseClass &)=default
 
RegionGrowingSegmentationAlgorithmBaseClassoperator= (const RegionGrowingSegmentationAlgorithmBaseClass &)=default
 
 RegionGrowingSegmentationAlgorithmBaseClass (RegionGrowingSegmentationAlgorithmBaseClass &&)=default
 
RegionGrowingSegmentationAlgorithmBaseClassoperator= (RegionGrowingSegmentationAlgorithmBaseClass &&)=default
 
void setVolume (Volume::Pointer vol)
 Set the input Volume. More...
 
void setSeedPoints (SeedPoints p)
 Set the input seed points. More...
 
void setIterations (std::size_t i)
 Set the number of iterations. More...
 
virtual PointSet compute ()=0
 Compute the segmentation. More...
 
Status getStatus () const
 Get the status of the previous computation. More...
 
const PointSetgetPointSet () const
 Get the segmented points. More...
 
PointSetgetPointSet ()
 Get the segmented points. More...
 
std::size_t progressIterations () const override
 Returns the maximum progress value. More...
 
virtual std::size_t progressIterations () const =0
 

Protected Member Functions

 RegionGrowingSegmentationAlgorithmBaseClass ()=default
 

Protected Attributes

Volume::Pointer vol_
 
SeedPoints startingPoints_
 
PointSet result_
 
std::size_t iterations_ {0}
 
Status status_ {Status::Success}
 

Additional Inherited Members

- Public Attributes inherited from volcart::IterationsProgress
Signal progressStarted
 
Signal< std::size_t > progressUpdated
 
Signal progressComplete
 

Detailed Description

Base class for segmentation algorithms that create a segmentation by growing from a set of seed points.

Definition at line 20 of file RegionGrowingSegmentationAlgorithmBaseClass.hpp.

Member Typedef Documentation

◆ PointSet

◆ SeedPoints

Seed points type

Definition at line 34 of file RegionGrowingSegmentationAlgorithmBaseClass.hpp.

Member Enumeration Documentation

◆ Status

Computation result status

Definition at line 40 of file RegionGrowingSegmentationAlgorithmBaseClass.hpp.

Constructor & Destructor Documentation

◆ RegionGrowingSegmentationAlgorithmBaseClass()

volcart::segmentation::RegionGrowingSegmentationAlgorithmBaseClass::RegionGrowingSegmentationAlgorithmBaseClass ( )
protecteddefault

Default constructor

Member Function Documentation

◆ compute()

virtual PointSet volcart::segmentation::RegionGrowingSegmentationAlgorithmBaseClass::compute ( )
pure virtual

Compute the segmentation.

Implemented in volcart::segmentation::ThinnedFloodFillSegmentation.

◆ getPointSet() [1/2]

PointSet & volcart::segmentation::RegionGrowingSegmentationAlgorithmBaseClass::getPointSet ( )
inline

Get the segmented points.

Definition at line 61 of file RegionGrowingSegmentationAlgorithmBaseClass.hpp.

◆ getPointSet() [2/2]

const PointSet & volcart::segmentation::RegionGrowingSegmentationAlgorithmBaseClass::getPointSet ( ) const
inline

Get the segmented points.

Definition at line 58 of file RegionGrowingSegmentationAlgorithmBaseClass.hpp.

◆ getStatus()

Status volcart::segmentation::RegionGrowingSegmentationAlgorithmBaseClass::getStatus ( ) const
inline

Get the status of the previous computation.

Definition at line 55 of file RegionGrowingSegmentationAlgorithmBaseClass.hpp.

◆ progressIterations()

std::size_t volcart::segmentation::RegionGrowingSegmentationAlgorithmBaseClass::progressIterations ( ) const
inlineoverridevirtual

Returns the maximum progress value.

Implements volcart::IterationsProgress.

Definition at line 64 of file RegionGrowingSegmentationAlgorithmBaseClass.hpp.

◆ setIterations()

void volcart::segmentation::RegionGrowingSegmentationAlgorithmBaseClass::setIterations ( std::size_t  i)
inline

Set the number of iterations.

Definition at line 49 of file RegionGrowingSegmentationAlgorithmBaseClass.hpp.

◆ setSeedPoints()

void volcart::segmentation::RegionGrowingSegmentationAlgorithmBaseClass::setSeedPoints ( SeedPoints  p)
inline

Set the input seed points.

Definition at line 46 of file RegionGrowingSegmentationAlgorithmBaseClass.hpp.

◆ setVolume()

void volcart::segmentation::RegionGrowingSegmentationAlgorithmBaseClass::setVolume ( Volume::Pointer  vol)
inline

Set the input Volume.

Definition at line 43 of file RegionGrowingSegmentationAlgorithmBaseClass.hpp.

Member Data Documentation

◆ iterations_

std::size_t volcart::segmentation::RegionGrowingSegmentationAlgorithmBaseClass::iterations_ {0}
protected

◆ result_

PointSet volcart::segmentation::RegionGrowingSegmentationAlgorithmBaseClass::result_
protected

Result

Definition at line 75 of file RegionGrowingSegmentationAlgorithmBaseClass.hpp.

◆ startingPoints_

SeedPoints volcart::segmentation::RegionGrowingSegmentationAlgorithmBaseClass::startingPoints_
protected

Seed points

Definition at line 73 of file RegionGrowingSegmentationAlgorithmBaseClass.hpp.

◆ status_

Status volcart::segmentation::RegionGrowingSegmentationAlgorithmBaseClass::status_ {Status::Success}
protected

Computation status

Definition at line 78 of file RegionGrowingSegmentationAlgorithmBaseClass.hpp.

◆ vol_

Volume::Pointer volcart::segmentation::RegionGrowingSegmentationAlgorithmBaseClass::vol_
protected

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