MorphologicalAttributeFilters
Public API documentation
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
mmcfilters::GridDomain2D Struct Reference

Shape metadata optionally attached to the pixel domain. More...

#include <ProperPartDomain.hpp>

Public Member Functions

constexpr GridDomain2D () noexcept=default
 Creates an empty domain.
 
constexpr GridDomain2D (int numRows, int numColumns) noexcept
 Creates a domain with the supplied row and column counts.
 
std::size_t size (const char *context) const
 Returns the number of grid elements after validating the shape.
 

Public Attributes

int rows = 0
 Number of grid rows.
 
int columns = 0
 Number of grid columns.
 

Detailed Description

Shape metadata optionally attached to the pixel domain.

A connected-subset tree model only requires a finite pixel domain. A regular 2D grid is therefore an optional capability used by image reconstruction and geometric algorithms, not part of the core topology contract.

Definition at line 17 of file ProperPartDomain.hpp.

Constructor & Destructor Documentation

◆ GridDomain2D()

constexpr mmcfilters::GridDomain2D::GridDomain2D ( int  numRows,
int  numColumns 
)
inlineconstexprnoexcept

Creates a domain with the supplied row and column counts.

Parameters
numRowsNumber of rows in the domain.
numColumnsNumber of columns in the domain.

Definition at line 34 of file ProperPartDomain.hpp.

Member Function Documentation

◆ size()

std::size_t mmcfilters::GridDomain2D::size ( const char context) const
inline

Returns the number of grid elements after validating the shape.

Parameters
contextOperation context or diagnostic label.
Returns
The number of grid elements after validating the shape.

Definition at line 42 of file ProperPartDomain.hpp.

Member Data Documentation

◆ columns

int mmcfilters::GridDomain2D::columns = 0

Number of grid columns.

Definition at line 21 of file ProperPartDomain.hpp.

◆ rows

int mmcfilters::GridDomain2D::rows = 0

Number of grid rows.

Definition at line 19 of file ProperPartDomain.hpp.


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