Volume Cartographer 2.27.0
|
Class for generating box-like neighborhoods from a point in a Volume. More...
#include <vc/core/neighborhood/CuboidGenerator.hpp>
Public Types | |
using | Pointer = std::shared_ptr< CuboidGenerator > |
![]() | |
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... | |
![]() | |
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 | |
![]() | |
NeighborhoodGenerator (std::size_t dim) | |
![]() | |
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} |
Class for generating box-like neighborhoods from a point in a Volume.
Definition at line 15 of file CuboidGenerator.hpp.
using volcart::CuboidGenerator::Pointer = std::shared_ptr<CuboidGenerator> |
Pointer type
Definition at line 19 of file CuboidGenerator.hpp.
|
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.
|
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.
|
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.
|
inlinestatic |
Definition at line 26 of file CuboidGenerator.hpp.