mmcfilters::NodeDistanceField Class Reference

Self-contained compact per-pixel distance field for one live node. More...

#include <NodeDistanceField.hpp>

Public Member Functions
	NodeDistanceField (NodeId node, int rows, int columns, DistanceTransformAccuracy accuracy, std::vector< PixelId > supportPixels, std::vector< std::int64_t > squaredDistances)
	Constructs a self-contained compact node field.
NodeId	node () const noexcept
	Returns the represented live internal node id.
int	rows () const noexcept
	Returns the original domain height.
int	columns () const noexcept
	Returns the original domain width.
DistanceTransformAccuracy	accuracy () const noexcept
	Returns the numerical backend used to produce the field.
std::size_t	size () const noexcept
	Returns the number of compact support samples.
std::span< const PixelId >	supportPixels () const noexcept
	Returns the row-major support pixel ids.
std::span< const std::int64_t >	squaredDistances () const noexcept
	Returns squared distances aligned with supportPixels().
std::vector< std::int64_t >	denseSquaredDistances (std::int64_t outsideValue=-1) const
	Returns a full-domain row-major field with outsideValue off support.

Detailed Description

Self-contained compact per-pixel distance field for one live node.

Definition at line 14 of file NodeDistanceField.hpp.

Constructor & Destructor Documentation

NodeDistanceField()

mmcfilters::NodeDistanceField::NodeDistanceField ( NodeId  node, int  rows, int  columns, DistanceTransformAccuracy  accuracy, std::vector< PixelId >  supportPixels, std::vector< std::int64_t >  squaredDistances  )

inline

Constructs a self-contained compact node field.

Parameters

node	Live internal node represented by the samples.
rows	Number of rows in the original image domain.
columns	Number of columns in the original image domain.
accuracy	Numerical backend that produced the samples.
supportPixels	Row-major support pixel ids.
squaredDistances	Squared distances aligned with supportPixels.

Definition at line 25 of file NodeDistanceField.hpp.

Member Function Documentation

accuracy()

DistanceTransformAccuracy mmcfilters::NodeDistanceField::accuracy ( ) const

inlinenoexcept

Returns the numerical backend used to produce the field.

Returns

Accuracy selection.

Definition at line 48 of file NodeDistanceField.hpp.

columns()

int mmcfilters::NodeDistanceField::columns ( ) const

inlinenoexcept

Returns the original domain width.

Returns

Number of columns.

Definition at line 46 of file NodeDistanceField.hpp.

denseSquaredDistances()

std::vector< std::int64_t > mmcfilters::NodeDistanceField::denseSquaredDistances ( std::int64_t  outsideValue = -1 ) const

inline

Returns a full-domain row-major field with outsideValue off support.

Parameters

outsideValue

Value assigned to pixels outside the represented support.

Returns

Dense row-major squared-distance field.

Definition at line 61 of file NodeDistanceField.hpp.

node()

NodeId mmcfilters::NodeDistanceField::node ( ) const

inlinenoexcept

Returns the represented live internal node id.

Returns

Node id.

Definition at line 42 of file NodeDistanceField.hpp.

rows()

int mmcfilters::NodeDistanceField::rows ( ) const

inlinenoexcept

Returns the original domain height.

Returns

Number of rows.

Definition at line 44 of file NodeDistanceField.hpp.

size()

std::size_t mmcfilters::NodeDistanceField::size ( ) const

inlinenoexcept

Returns the number of compact support samples.

Returns

Sample count.

Definition at line 50 of file NodeDistanceField.hpp.

squaredDistances()

std::span< const std::int64_t > mmcfilters::NodeDistanceField::squaredDistances ( ) const

inlinenoexcept

Returns squared distances aligned with supportPixels().

Returns

Borrowed squared-distance span.

Definition at line 54 of file NodeDistanceField.hpp.

supportPixels()

std::span< const PixelId > mmcfilters::NodeDistanceField::supportPixels ( ) const

inlinenoexcept

Returns the row-major support pixel ids.

Returns

Borrowed support span.

Definition at line 52 of file NodeDistanceField.hpp.

---

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

• mmcfilters/distanceTransform/NodeDistanceField.hpp