Loading...
Searching...
No Matches
This modules includes classes and methods for Spatial Partitioning and queries. More...
Classes | |
| struct | Ponca::QueryInputBase |
| Base class for queries input type. More... | |
| struct | Ponca::QueryOutputBase |
| Base class for queries output types. More... | |
| struct | Ponca::QueryOutputBase::DummyOutputParameter |
| struct | Ponca::QueryInput< InputType_ > |
| Base class for Query input type. More... | |
| struct | Ponca::QueryInputIsIndex< Index > |
Extension of QueryInput that handles an index based search, in a partitioning structure. More... | |
| struct | Ponca::QueryInputIsPosition< DataPoint > |
Extension of QueryInput that handles a position based search, in a partitioning structure. More... | |
| struct | Ponca::QueryOutputIsRange< Index, Scalar > |
| Class to construct the range query output. More... | |
| struct | Ponca::QueryOutputIsNearest< Index, Scalar > |
| Class to construct the nearest query output. More... | |
| struct | Ponca::QueryOutputIsKNearest< Index, Scalar, MAX_KNN_SIZE > |
| Class to construct the knearest queries. More... | |
| struct | Ponca::Query< Input_, Output_ > |
| Composes the Query object depending on an input type and output type. More... | |
Macros | |
| #define | POINT_QUERY_DOC(OUT_TYPE) |
| #define | INDEX_QUERY_DOC(OUT_TYPE) |
| Base Query class combining QueryInputIsPosition and QueryOutputIs##OUT_TYPE##. | |
Detailed Description
This modules includes classes and methods for Spatial Partitioning and queries.
Class Documentation
◆ Ponca::QueryInputBase
| struct Ponca::QueryInputBase |
◆ Ponca::QueryOutputBase
| struct Ponca::QueryOutputBase |
Base class for queries output types.
QueryOutput objects are the return types of the searches of the accelerating structures defined in the SpatialPartitioning module.
They are used for easy access to the result outputs. (e.g. to iterate over the neighbors of the evaluated point using a rangeNeighborsQuery request).
Inheritance diagram for Ponca::QueryOutputBase: Collaboration diagram for Ponca::QueryOutputBase:◆ Ponca::QueryOutputBase::DummyOutputParameter
| struct Ponca::QueryOutputBase::DummyOutputParameter |
◆ Ponca::QueryInput
| struct Ponca::QueryInput |
Base class for Query input type.
Stores internally a value that is related to the point about to be evaluated (e.g. the position of the point, or its index)
- Warning
- This class has to be specialized for a specific input type, and can't be used as is.
- See also
- QueryInputIsIndex, QueryInputIsPosition
Inheritance diagram for Ponca::QueryInput< InputType_ >: Collaboration diagram for Ponca::QueryInput< InputType_ >:Public Types | |
| using | InputType = InputType_ |
| Alias to the templated input type. | |
Public Member Functions | |
| QueryInput (InputType input) | |
| Default constructor that initialize the input field. | |
| const InputType & | input () const |
| Read access to the input. | |
Protected Member Functions | |
| void | setInput (const InputType &input) |
| Edit the input. | |
Member Typedef Documentation
◆ InputType
template<typename InputType_ >
| using Ponca::QueryInput< InputType_ >::InputType = InputType_ |
Constructor & Destructor Documentation
◆ QueryInput()
template<typename InputType_ >
|
inline |
Member Function Documentation
◆ input()
template<typename InputType_ >
|
inline |
◆ setInput()
template<typename InputType_ >
|
inlineprotected |
Edit the input.
- Warning
- Need to be used carefully. Modifying a query input while iterating on the query will result in undefined behavior. Simplest way to avoid this is to restart the iteration on the query. Usefull to avoid query reallocation between different requests.
◆ Ponca::QueryInputIsIndex
| struct Ponca::QueryInputIsIndex |
template<typename Index>
struct Ponca::QueryInputIsIndex< Index >
struct Ponca::QueryInputIsIndex< Index >
Extension of QueryInput that handles an index based search, in a partitioning structure.
Stores internally the index of the evaluated point.
- See also
- QueryInput
Inheritance diagram for Ponca::QueryInputIsIndex< Index >: Collaboration diagram for Ponca::QueryInputIsIndex< Index >:Public Types | |
| using | Base = QueryInput< Index > |
| Alias to the inherited type. | |
| using | InputType = typename Base::InputType |
| Alias to the templated input type (Index) | |
| Public Types inherited from Ponca::QueryInput< Index > | |
| using | InputType = Index |
| Alias to the templated input type. | |
Public Member Functions | |
| QueryInputIsIndex (const InputType &point=-1) | |
| Default constructor that initialize the input index. | |
| void | operator() (const InputType &point=InputType::Zero()) |
| Access operator that resets the input index. | |
| Public Member Functions inherited from Ponca::QueryInput< Index > | |
| QueryInput (InputType input) | |
| Default constructor that initialize the input field. | |
| const InputType & | input () const |
| Read access to the input. | |
Protected Member Functions | |
| template<typename IndexType > | |
| bool | skipIndexFunctor (IndexType idx) const |
| Functor used to check if a given Idx must be skipped. | |
| template<typename VectorType , typename Container > | |
| const VectorType | getInputPosition (const Container &c) |
| Generic method to access input position. The VectorType needs to be passed as a template argument. | |
| Protected Member Functions inherited from Ponca::QueryInput< Index > | |
| void | setInput (const InputType &input) |
| Edit the input. | |
Member Typedef Documentation
◆ Base
template<typename Index >
| using Ponca::QueryInputIsIndex< Index >::Base = QueryInput<Index> |
◆ InputType
template<typename Index >
| using Ponca::QueryInputIsIndex< Index >::InputType = typename Base::InputType |
Constructor & Destructor Documentation
◆ QueryInputIsIndex()
template<typename Index >
|
inline |
Member Function Documentation
◆ getInputPosition()
template<typename Index >
|
inlineprotected |
◆ operator()()
template<typename Index >
|
inline |
◆ skipIndexFunctor()
◆ Ponca::QueryInputIsPosition
| struct Ponca::QueryInputIsPosition |
template<typename DataPoint>
struct Ponca::QueryInputIsPosition< DataPoint >
struct Ponca::QueryInputIsPosition< DataPoint >
Extension of QueryInput that handles a position based search, in a partitioning structure.
Stores internally the position of the evaluated point.
- See also
- QueryInput
Inheritance diagram for Ponca::QueryInputIsPosition< DataPoint >: Collaboration diagram for Ponca::QueryInputIsPosition< DataPoint >:Public Types | |
| using | Base = QueryInput< typename DataPoint::VectorType > |
| Alias to the inherited type. | |
| using | InputType = typename Base::InputType |
| Alias to the templated input type (Index) | |
| Public Types inherited from Ponca::QueryInput< DataPoint::VectorType > | |
| using | InputType = DataPoint::VectorType |
| Alias to the templated input type. | |
Public Member Functions | |
| QueryInputIsPosition (const InputType &point=InputType::Zero()) | |
| Default constructor that initialize the input position. | |
| void | operator() (const InputType &point=InputType::Zero()) |
| Access operator that resets the input point. | |
| Public Member Functions inherited from Ponca::QueryInput< DataPoint::VectorType > | |
| QueryInput (InputType input) | |
| Default constructor that initialize the input field. | |
| const InputType & | input () const |
| Read access to the input. | |
Protected Member Functions | |
| template<typename IndexType > | |
| bool | skipIndexFunctor (IndexType idx) const |
| Functor used to check if a given Idx must be skipped. | |
| template<typename VectorType = typename DataPoint::VectorType, typename Container > | |
| const VectorType | getInputPosition (const Container &) |
| Generic method to access input position. The VectorType needs to be passed as a template argument. | |
| Protected Member Functions inherited from Ponca::QueryInput< DataPoint::VectorType > | |
| void | setInput (const InputType &input) |
| Edit the input. | |
Member Typedef Documentation
◆ Base
template<typename DataPoint >
| using Ponca::QueryInputIsPosition< DataPoint >::Base = QueryInput<typename DataPoint::VectorType> |
◆ InputType
template<typename DataPoint >
| using Ponca::QueryInputIsPosition< DataPoint >::InputType = typename Base::InputType |
Constructor & Destructor Documentation
◆ QueryInputIsPosition()
template<typename DataPoint >
|
inline |
Member Function Documentation
◆ getInputPosition()
template<typename DataPoint >
|
inlineprotected |
◆ operator()()
template<typename DataPoint >
|
inline |
◆ skipIndexFunctor()
◆ Ponca::QueryOutputIsRange
| struct Ponca::QueryOutputIsRange |
Class to construct the range query output.
Stores internally the radius value of a range request.
- See also
- QueryOutputBase
Inheritance diagram for Ponca::QueryOutputIsRange< Index, Scalar >: Collaboration diagram for Ponca::QueryOutputIsRange< Index, Scalar >:Public Types | |
| using | OutputParameter = Scalar |
| Alias to Output type. | |
Public Member Functions | |
| QueryOutputIsRange (OutputParameter radius=OutputParameter(0)) | |
| Default constructor that initialize the output parameter value. | |
| void | operator() (OutputParameter radius) |
| Access operator that resets the output parameter. | |
| Scalar | radius () const |
| Generic method to access the radius. | |
| Scalar | squaredRadius () const |
| Generic method to access the radius squared. | |
| void | setRadius (Scalar radius) |
| Set the radius distance of the query. | |
| void | setSquaredRadius (Scalar radius) |
| Set the squared radius distance of the query. | |
Protected Member Functions | |
| void | reset () |
| Reset Query for a new search. | |
| Scalar | descentDistanceThreshold () const |
| Distance threshold used during tree descent to select nodes to explore. | |
Protected Attributes | |
| Scalar | m_squared_radius {0} |
| Radius used for the search. | |
Member Typedef Documentation
◆ OutputParameter
| using Ponca::QueryOutputIsRange< Index, Scalar >::OutputParameter = Scalar |
Constructor & Destructor Documentation
◆ QueryOutputIsRange()
|
inline |
Member Function Documentation
◆ descentDistanceThreshold()
|
inlineprotected |
◆ operator()()
|
inline |
◆ radius()
|
inline |
Generic method to access the radius.
- Warning
- This getter method is more expensive to process than
squaredRadius, because it computes the square root of the squared radius each time it is called. This is done this way to avoid having to store internally two values related to the radius.
squaredRadius is overall better for distance comparison.
- See also
- squaredRadius
◆ reset()
|
inlineprotected |
◆ setRadius()
|
inline |
◆ setSquaredRadius()
|
inline |
◆ squaredRadius()
|
inline |
Member Data Documentation
◆ m_squared_radius
|
protected |
◆ Ponca::QueryOutputIsNearest
| struct Ponca::QueryOutputIsNearest |
Class to construct the nearest query output.
Stores internally the nearest neighbor and the Distance threshold (for tree descent).
- See also
- QueryOutputBase
Inheritance diagram for Ponca::QueryOutputIsNearest< Index, Scalar >: Collaboration diagram for Ponca::QueryOutputIsNearest< Index, Scalar >:Public Types | |
| using | OutputParameter = typename QueryOutputBase::DummyOutputParameter |
| Alias to Output type. | |
Public Member Functions | |
| QueryOutputIsNearest () | |
| Default constructor. | |
| void | operator() () |
| Access operator. | |
| Index | get () const |
| Get the closest points. | |
Protected Member Functions | |
| void | reset () |
| Reset Query for a new search. | |
| Scalar | descentDistanceThreshold () const |
| Distance threshold used during tree descent to select nodes to explore. | |
Protected Attributes | |
| Index | m_nearest {-1} |
| Index of the nearest neighbor. | |
| Scalar | m_squared_distance {std:: numeric_limits < Scalar > ::max()} |
| Distance to the nearest neighbor. | |
Member Typedef Documentation
◆ OutputParameter
| using Ponca::QueryOutputIsNearest< Index, Scalar >::OutputParameter = typename QueryOutputBase::DummyOutputParameter |
Constructor & Destructor Documentation
◆ QueryOutputIsNearest()
|
inline |
Member Function Documentation
◆ descentDistanceThreshold()
|
inlineprotected |
◆ get()
|
inline |
◆ operator()()
|
inline |
◆ reset()
|
inlineprotected |
Member Data Documentation
◆ m_nearest
|
protected |
◆ m_squared_distance
|
protected |
◆ Ponca::QueryOutputIsKNearest
| struct Ponca::QueryOutputIsKNearest |
template<typename Index, typename Scalar, int MAX_KNN_SIZE>
struct Ponca::QueryOutputIsKNearest< Index, Scalar, MAX_KNN_SIZE >
struct Ponca::QueryOutputIsKNearest< Index, Scalar, MAX_KNN_SIZE >
Class to construct the knearest queries.
Stores internally the neighbors collection of the knn request and the Distance threshold (for tree descent).
- See also
- QueryOutputBase
- Template Parameters
-
MAX_KNN_SIZE Maximum size of the K-neighborhood
Inheritance diagram for Ponca::QueryOutputIsKNearest< Index, Scalar, MAX_KNN_SIZE >: Collaboration diagram for Ponca::QueryOutputIsKNearest< Index, Scalar, MAX_KNN_SIZE >:Public Types | |
| using | OutputParameter = Index |
| Alias to Output type. | |
| using | Queue = LimitedPriorityQueue< IndexSquaredDistance< Index, Scalar >, MAX_KNN_SIZE > |
| Alias to LimitedPriorityQueue. | |
Public Member Functions | |
| QueryOutputIsKNearest (OutputParameter k=0) | |
| Default constructor that initialize the output parameter value. | |
| void | operator() (OutputParameter k) |
| Access operator that resets the output parameter. | |
| Queue & | queue () |
| Access to the priority queue storing the neighbors. | |
Protected Member Functions | |
| void | reset () |
| Reset Query for a new search. | |
| Scalar | descentDistanceThreshold () const |
| Distance threshold used during tree descent to select nodes to explore. | |
Protected Attributes | |
| Queue | m_queue |
| Queue storing the neighbors. | |
Member Typedef Documentation
◆ OutputParameter
| using Ponca::QueryOutputIsKNearest< Index, Scalar, MAX_KNN_SIZE >::OutputParameter = Index |
◆ Queue
| using Ponca::QueryOutputIsKNearest< Index, Scalar, MAX_KNN_SIZE >::Queue = LimitedPriorityQueue<IndexSquaredDistance<Index, Scalar>, MAX_KNN_SIZE> |
Alias to LimitedPriorityQueue.
Constructor & Destructor Documentation
◆ QueryOutputIsKNearest()
|
inline |
Member Function Documentation
◆ descentDistanceThreshold()
|
inlineprotected |
◆ operator()()
|
inline |
◆ queue()
|
inline |
◆ reset()
|
inlineprotected |
Member Data Documentation
◆ m_queue
◆ Ponca::Query
| struct Ponca::Query |
Composes the Query object depending on an input type and output type.
- Template Parameters
-
Input_ The query input type corresponds to the value used for the search. Output_ The query output type corresponds to the results of the search (it can be iterated over).
Inheritance diagram for Ponca::Query< Input_, Output_ >: Collaboration diagram for Ponca::Query< Input_, Output_ >:Public Types | |
| using | QueryInType = Input_ |
| Alias to the input type. | |
| using | QueryOutType = Output_ |
| Alias to the output type. | |
Public Member Functions | |
| Query (const typename QueryInType::InputType &in) | |
| Default constructor that initialize the input parameter only. | |
| Query (const typename QueryOutType::OutputParameter &outParam, const typename QueryInType::InputType &in) | |
| Default constructor that initialize the input and output parameters. | |
| template<typename Base , typename... outputType> | |
| Base & | operator() (const typename QueryInType::InputType &in, outputType &&... out) |
| Access operator that resets the input and output parameters. | |
| template<typename Base > | |
| Base & | operator() (const typename QueryInType::InputType &in) |
| Access operator that resets the input parameter only. | |
Member Typedef Documentation
◆ QueryInType
| using Ponca::Query< Input_, Output_ >::QueryInType = Input_ |
◆ QueryOutType
| using Ponca::Query< Input_, Output_ >::QueryOutType = Output_ |
Constructor & Destructor Documentation
◆ Query() [1/2]
|
inline |
◆ Query() [2/2]
|
inline |
Member Function Documentation
◆ operator()() [1/2]
template<typename Base >
|
inline |
◆ operator()() [2/2]
template<typename Base , typename... outputType>
|
inline |
Macro Definition Documentation
◆ INDEX_QUERY_DOC
| #define INDEX_QUERY_DOC | ( | OUT_TYPE | ) |
Base Query class combining QueryInputIsPosition and QueryOutputIs##OUT_TYPE##.
PointQuery objects acts as a Range that can be iterated over.
They are used as the return type for the index searches
and they allow easy access to the result outputs.
This specialization of the PointQuery concept is used to iterate over the neighbors of a given point \ position, using a ##OUT_TYPE## Point Query request.
◆ POINT_QUERY_DOC
Typedef Documentation
◆ KNearestIndexQuery
| using Ponca::KNearestIndexQuery = typedef Query<QueryInputIsIndex<Index>, QueryOutputIsKNearest<Index, Scalar, MAX_KNN_SIZE> > |
◆ KNearestPointQuery
| using Ponca::KNearestPointQuery = typedef Query<QueryInputIsPosition<DataPoint>, QueryOutputIsKNearest<Index, typename DataPoint::Scalar, MAX_KNN_SIZE> > |
Base Query alias combining QueryInputIsIndex and QueryOutputIs##OUT_TYPE##.
IndexQuery objects acts as a Range that can be iterated over.
They are used as the return type for the index searches
and they allow easy access to the result outputs.
This specialization of the IndexQuery concept is used to iterate over the neighbors of a given point index, \ using a ##OUT_TYPE## Index Query request.
- Template Parameters
-
MAX_KNN_SIZE Maximum size of the K-neighborhood
◆ NearestIndexQuery
| using Ponca::NearestIndexQuery = typedef Query<QueryInputIsIndex<Index>, QueryOutputIsNearest<Index, Scalar> > |
◆ NearestPointQuery
| using Ponca::NearestPointQuery = typedef Query<QueryInputIsPosition<DataPoint>, QueryOutputIsNearest<Index, typename DataPoint::Scalar> > |
◆ RangeIndexQuery
| using Ponca::RangeIndexQuery = typedef Query<QueryInputIsIndex<Index>, QueryOutputIsRange<Index, Scalar> > |
◆ RangePointQuery
| using Ponca::RangePointQuery = typedef Query<QueryInputIsPosition<DataPoint>, QueryOutputIsRange<Index, typename DataPoint::Scalar> > |
