mmcfilters::ContourTraceView Class Reference

Borrowed ordered contour trace for one tree node. More...

#include <ContourTrace.hpp>

Public Member Functions
std::span< const ContourBoundary >	boundaries () const noexcept
	Returns all ordered boundary descriptors.
ContourBoundary	externalBoundary () const
	Returns the unique external boundary.
ContourEdgeRange	edges () const noexcept
	Returns every contour edge in boundary order.
ContourEdgeRange	boundaryEdges (const ContourBoundary &boundary) const
	Returns the ordered edges of one boundary.
ContourPixelRange	boundaryPixels (const ContourBoundary &boundary) const
	Returns one support pixel for each ordered boundary edge.

Friends
class	ContourTrace
class	ContourTraceComputation
class	contours::detail::ContourTraceTraversal

Detailed Description

Borrowed ordered contour trace for one tree node.

A view contains all ordered external and internal boundaries without owning their storage. A computation iterator's view remains valid until that iterator or one of its copies advances, or their shared traversal is destroyed. A callback's view is valid only during the callback. Views of an owned ContourTrace require its edge and boundary storage to remain alive and unchanged. The same limits apply to spans and ranges obtained from a view.

Definition at line 248 of file ContourTrace.hpp.

Member Function Documentation

boundaries()

std::span< const ContourBoundary > mmcfilters::ContourTraceView::boundaries ( ) const

inlinenoexcept

Returns all ordered boundary descriptors.

Returns

Borrowed boundary descriptor span.

Definition at line 253 of file ContourTrace.hpp.

boundaryEdges()

ContourEdgeRange mmcfilters::ContourTraceView::boundaryEdges ( const ContourBoundary &  boundary ) const

inline

Returns the ordered edges of one boundary.

Parameters

boundary

Boundary descriptor from this trace.

Returns

Ordered edge range selected by the descriptor.

Definition at line 285 of file ContourTrace.hpp.

boundaryPixels()

ContourPixelRange mmcfilters::ContourTraceView::boundaryPixels ( const ContourBoundary &  boundary ) const

inline

Returns one support pixel for each ordered boundary edge.

Parameters

boundary

Boundary descriptor from this trace.

Returns

Ordered support-pixel projection, including repetitions.

Definition at line 294 of file ContourTrace.hpp.

edges()

ContourEdgeRange mmcfilters::ContourTraceView::edges ( ) const

inlinenoexcept

Returns every contour edge in boundary order.

Returns

Ordered edge range.

Definition at line 278 of file ContourTrace.hpp.

externalBoundary()

ContourBoundary mmcfilters::ContourTraceView::externalBoundary ( ) const

inline

Returns the unique external boundary.

Returns

Unique external boundary descriptor.

Exceptions

std::logic_error

If zero or multiple external boundaries exist.

Definition at line 260 of file ContourTrace.hpp.

Friends And Related Symbol Documentation

contours::detail::ContourTraceTraversal

friend class contours::detail::ContourTraceTraversal

friend

Definition at line 301 of file ContourTrace.hpp.

ContourTrace

friend class ContourTrace

friend

Definition at line 299 of file ContourTrace.hpp.

ContourTraceComputation

friend class ContourTraceComputation

friend

Definition at line 300 of file ContourTrace.hpp.

---

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

• mmcfilters/contours/ContourTrace.hpp