Class for generating box-like neighborhoods from a point in a Volume. More...

#include <vc/core/neighborhood/CuboidGenerator.hpp>

Inheritance diagram for volcart::CuboidGenerator:

Collaboration diagram for volcart::CuboidGenerator:

Public Types
using	Pointer = std::shared_ptr< CuboidGenerator >

Public Types inherited from volcart::NeighborhoodGenerator
using	Pointer = std::shared_ptr< NeighborhoodGenerator >

Public Member Functions

Neighborhood::Extent	extents () const override
	Get the size of the neighborhood returned by this class. More...


Neighborhood	compute (const Volume::Pointer &v, const cv::Vec3d &pt, const std::vector< cv::Vec3d > &axes) override
	Compute a neighborhood centered on a point. More...

Public Member Functions inherited from volcart::NeighborhoodGenerator
std::size_t	dim ()
	Get the dimensionality of the neighborhood generator. More...

void	setSamplingRadius (double r, std::size_t axis=0)
	Set the sampling search radius by axis. More...

void	setSamplingRadius (double r0, double r1, double r2)
	Set the sampling search radius for all axes. More...

void	setSamplingRadius (const cv::Vec3d &radii)

void	setSamplingInterval (double i)
	Set the sampling interval: how frequently along the radius (in Volume units) the samples are taken. More...

void	setSamplingDirection (Direction d)
	Set the filtering search direction. More...

void	setAutoGenAxes (bool b)
	Enable/Disable auto-generation of missing axes. More...

	CuboidGenerator ()
	Default Constructor. More...

static Pointer	New ()

Additional Inherited Members
Protected Member Functions inherited from volcart::NeighborhoodGenerator
	NeighborhoodGenerator (std::size_t dim)

Protected Attributes inherited from volcart::NeighborhoodGenerator
const std::size_t	dim_ {0}

cv::Vec3d	radius_ {1.0, 1.0, 1.0}

double	interval_ {1.0}

Direction	direction_ {Direction::Bidirectional}

bool	autoGenAxes_ {true}

Detailed Description

Class for generating box-like neighborhoods from a point in a Volume.

Definition at line 15 of file CuboidGenerator.hpp.

Member Typedef Documentation

◆ Pointer

using volcart::CuboidGenerator::Pointer = std::shared_ptr<CuboidGenerator>

Pointer type

Definition at line 19 of file CuboidGenerator.hpp.

Constructor & Destructor Documentation

◆ CuboidGenerator()

volcart::CuboidGenerator::CuboidGenerator ( )

inline

Default Constructor.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 23 of file CuboidGenerator.hpp.

Member Function Documentation

◆ compute()

Neighborhood volcart::CuboidGenerator::compute	(	const Volume::Pointer &	v,
		const cv::Vec3d &	pt,
		const std::vector< cv::Vec3d > &	axes
	)

overridevirtual

Compute a neighborhood centered on a point.

This method computes a cuboid (box-like) neighborhood, centered on a point embedded in a Volume. The orientation of the neighborhood is determined by the provided axes. At least one axis vector is required. Only the first 3 provided vectors will be used.

If setAutoGenAxes() is true, this method will automatically generate any missing axes using the cross product. For example, if one axis is provided, the 2nd and 3rd will be generated, but if two are provided, only the 3rd will be generated.

Implements volcart::NeighborhoodGenerator.

◆ extents()

Neighborhood::Extent volcart::CuboidGenerator::extents ( ) const

overridevirtual

Get the size of the neighborhood returned by this class.

The result of this function may vary based on the value of this class's parameters

Implements volcart::NeighborhoodGenerator.

◆ New()

static Pointer volcart::CuboidGenerator::New ( )

inlinestatic

Definition at line 26 of file CuboidGenerator.hpp.

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

vc/core/neighborhood/CuboidGenerator.hpp

Public Types

Public Member Functions

Additional Inherited Members