Aim: This class precomputes the Voronoi Covariance Measure of a set of points. It can compute the covariance measure of an arbitrary function with given support.
More...
#include <DGtal/geometry/volumes/estimation/VoronoiCovarianceMeasure.h>
template<typename TSpace, typename TSeparableMetric>
class DGtal::VoronoiCovarianceMeasure< TSpace, TSeparableMetric >
Aim: This class precomputes the Voronoi Covariance Measure of a set of points. It can compute the covariance measure of an arbitrary function with given support.
Description of template class 'VoronoiCovarianceMeasure'
You may obtain the whole sequence (Point,VCM) by accessing the map vcmMap.
- Note
- Documentation in Computing the Voronoi Covariance Measure of a point set.
- Template Parameters
-
- Examples
- geometry/volumes/dvcm-2d.cpp.
Definition at line 79 of file VoronoiCovarianceMeasure.h.
◆ CharacteristicSet
template<typename TSpace, typename TSeparableMetric>
◆ Domain
template<typename TSpace, typename TSeparableMetric>
◆ Integer
template<typename TSpace, typename TSeparableMetric>
◆ MatrixNN
template<typename TSpace, typename TSeparableMetric>
◆ Metric
template<typename TSpace, typename TSeparableMetric>
◆ NotPredicate
template<typename TSpace, typename TSeparableMetric>
◆ Point
template<typename TSpace, typename TSeparableMetric>
◆ Point2MatrixNN
template<typename TSpace, typename TSeparableMetric>
◆ PointContainer
template<typename TSpace, typename TSeparableMetric>
◆ ProximityStructure
template<typename TSpace, typename TSeparableMetric>
◆ Scalar
template<typename TSpace, typename TSeparableMetric>
◆ Size
template<typename TSpace, typename TSeparableMetric>
◆ Space
template<typename TSpace, typename TSeparableMetric>
◆ VectorN
template<typename TSpace, typename TSeparableMetric>
◆ Voronoi
template<typename TSpace, typename TSeparableMetric>
◆ VoronoiCovarianceMeasure() [1/3]
template<typename TSpace, typename TSeparableMetric>
Constructor.
- Parameters
-
_R | the offset radius for the set of points. Voronoi cells are intersected with this offset. The unit corresponds to a step in the digital space. |
_r | (an upper bound of) the radius of the support of forthcoming kernel functions ( \chi_r ). The unit corresponds to a step in the digital space. This parameter is used for preparing the data structure that answers to proximity queries. |
aMetric | an instance of the metric. |
verbose | if 'true' displays information on ongoing computation. |
◆ ~VoronoiCovarianceMeasure()
template<typename TSpace, typename TSeparableMetric>
◆ VoronoiCovarianceMeasure() [2/3]
template<typename TSpace, typename TSeparableMetric>
Constructor. Forbidden by default (protected to avoid g++ warnings).
◆ VoronoiCovarianceMeasure() [3/3]
template<typename TSpace, typename TSeparableMetric>
Copy constructor.
- Parameters
-
other | the object to clone. Forbidden by default. |
◆ BOOST_CONCEPT_ASSERT() [1/2]
template<typename TSpace, typename TSeparableMetric>
◆ BOOST_CONCEPT_ASSERT() [2/2]
template<typename TSpace, typename TSeparableMetric>
◆ clean()
template<typename TSpace, typename TSeparableMetric>
Cleans intermediate data structure likes the characteristic set and the voronoi map.
- Note
- Further calls to voronoiMap are no more valid.
◆ domain()
template<typename TSpace, typename TSeparableMetric>
- Returns
- the domain of computation
◆ init()
template<typename TSpace, typename TSeparableMetric>
template<typename PointInputIterator>
Computes the Voronoi Covariance Measure for the set of points given by range [itb,ite)
- Template Parameters
-
PointInputIterator | an input iterator on digital points. |
- Parameters
-
itb | the start of the range |
ite | the end of the range. |
- Precondition
- itb != ite.
-
[itb,ite) is a valid range (ite can be reached from itb).
◆ isValid()
template<typename TSpace, typename TSeparableMetric>
Checks the validity/consistency of the object.
- Returns
- 'true' if the object is valid, 'false' otherwise.
◆ measure()
template<typename TSpace, typename TSeparableMetric>
template<typename Point2ScalarFunction>
Computes the Voronoi Covariance Measure of the function chi_r.
- Template Parameters
-
- Parameters
-
chi_r | the kernel function whose support is included in the cube centered on the origin with edge size 2r (see VoronoiCovarianceMeasure). |
p | the point where the kernel function is moved. It must lie within domain. |
◆ operator=()
template<typename TSpace, typename TSeparableMetric>
Assignment.
- Parameters
-
- Returns
- a reference on 'this'. Forbidden by default.
◆ R()
template<typename TSpace, typename TSeparableMetric>
- Returns
- the parameter R in the VCM, i.e. the offset radius for the compact set K.
◆ r()
template<typename TSpace, typename TSeparableMetric>
- Returns
- the parameter r in VCM(chi_r), i.e. an upper bound for the diameter of the support of kernel functions.
◆ selfDisplay()
template<typename TSpace, typename TSeparableMetric>
Writes/Displays the object on an output stream.
- Parameters
-
out | the output stream where the object is written. |
◆ vcmMap()
template<typename TSpace, typename TSeparableMetric>
- Returns
- the Voronoi Covariance Matrix of each Voronoi cell as a map Point -> Matrix
- Note
- empty if init has not been called.
◆ voronoiMap()
template<typename TSpace, typename TSeparableMetric>
- Returns
- the current Voronoi map
- Precondition
- init must have been called before.
◆ myBigR
template<typename TSpace, typename TSeparableMetric>
◆ myCharSet
template<typename TSpace, typename TSeparableMetric>
◆ myDomain
template<typename TSpace, typename TSeparableMetric>
◆ myMetric
template<typename TSpace, typename TSeparableMetric>
◆ myProximityStructure
template<typename TSpace, typename TSeparableMetric>
◆ mySmallR
template<typename TSpace, typename TSeparableMetric>
The parameter r in VCM(chi_r), i.e. an upper bound for the diameter of the support of kernel functions.
Definition at line 227 of file VoronoiCovarianceMeasure.h.
◆ myVCM
template<typename TSpace, typename TSeparableMetric>
◆ myVerbose
template<typename TSpace, typename TSeparableMetric>
◆ myVoronoi
template<typename TSpace, typename TSeparableMetric>
The documentation for this class was generated from the following file: