MinDist.h
Go to the documentation of this file.
1 // kate: replace-tabs off; indent-width 4; indent-mode normal
2 // vim: ts=4:sw=4:noexpandtab
3 /*
4 
5 Copyright (c) 2010--2018,
6 Fran├žois Pomerleau and Stephane Magnenat, ASL, ETHZ, Switzerland
7 You can contact the authors at <f dot pomerleau at gmail dot com> and
8 <stephane at magnenat dot net>
9 
10 All rights reserved.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
14  * Redistributions of source code must retain the above copyright
15  notice, this list of conditions and the following disclaimer.
16  * Redistributions in binary form must reproduce the above copyright
17  notice, this list of conditions and the following disclaimer in the
18  documentation and/or other materials provided with the distribution.
19  * Neither the name of the <organization> nor the
20  names of its contributors may be used to endorse or promote products
21  derived from this software without specific prior written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
24 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26 DISCLAIMED. IN NO EVENT SHALL ETH-ASL BE LIABLE FOR ANY
27 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
30 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 #pragma once
36 
37 #include "PointMatcher.h"
38 
40 template< typename T>
42 {
49 
51 
52  inline static const std::string description()
53  {
54  return "Subsampling. Filter points before a minimum distance measured on a specific axis. If dim is set to -1, points are filtered based on a minimum radius.";
55  }
56  inline static const ParametersDoc availableParameters()
57  {
58  return {
59  {"dim", "dimension on which the filter will be applied. x=0, y=1, z=2, radius=-1", "-1", "-1", "2", &P::Comp<int>},
60  {"minDist", "minimum value authorized. If dim is set to -1 (radius), the absolute value of minDist will be used. All points before that will be filtered.", "1", "-inf", "inf", &P::Comp<T>}
61  };
62  }
63 
64  const int dim;
65  const T minDist;
66 
69  virtual DataPoints filter(const DataPoints& input);
70  virtual void inPlaceFilter(DataPoints& cloud);
71 };
MinDistDataPointsFilter::P
PointMatcherSupport::Parametrizable P
Definition: MinDist.h:44
DataPointsFilter
PM::DataPointsFilter DataPointsFilter
Definition: pypoint_matcher_helper.h:22
MinDistDataPointsFilter::ParameterDoc
Parametrizable::ParameterDoc ParameterDoc
Definition: MinDist.h:46
MinDistDataPointsFilter
Subsampling. Filter points before a minimum distance measured on a specific axis.
Definition: MinDist.h:41
MinDistDataPointsFilter::minDist
const T minDist
Definition: MinDist.h:65
build_map.T
T
Definition: build_map.py:34
MinDistDataPointsFilter::availableParameters
static const ParametersDoc availableParameters()
Definition: MinDist.h:56
MinDistDataPointsFilter::InvalidParameter
Parametrizable::InvalidParameter InvalidParameter
Definition: MinDist.h:48
PointMatcher
Functions and classes that are dependant on scalar type are defined in this templatized class.
Definition: PointMatcher.h:130
PointMatcher::DataPoints
A point cloud.
Definition: PointMatcher.h:207
MinDistDataPointsFilter::DataPoints
PointMatcher< T >::DataPoints DataPoints
Definition: MinDist.h:50
testing::internal::string
::std::string string
Definition: gtest.h:1979
MinDistDataPointsFilter::description
static const std::string description()
Definition: MinDist.h:52
PointMatcherSupport::Parametrizable::ParametersDoc
std::vector< ParameterDoc > ParametersDoc
The documentation of all parameters.
Definition: Parametrizable.h:187
align_sequence.params
params
Definition: align_sequence.py:13
MinDistDataPointsFilter::ParametersDoc
Parametrizable::ParametersDoc ParametersDoc
Definition: MinDist.h:47
PointMatcherSupport::Parametrizable::InvalidParameter
An exception thrown when one tries to fetch the value of an unexisting parameter.
Definition: Parametrizable.h:144
PointMatcherSupport::Parametrizable
The superclass of classes that are constructed using generic parameters. This class provides the para...
Definition: Parametrizable.h:141
MinDistDataPointsFilter::Parametrizable
PointMatcherSupport::Parametrizable Parametrizable
Definition: MinDist.h:43
MinDistDataPointsFilter::Parameters
Parametrizable::Parameters Parameters
Definition: MinDist.h:45
PointMatcherSupport::Parametrizable::ParameterDoc
The documentation of a parameter.
Definition: Parametrizable.h:160
MinDistDataPointsFilter::MinDistDataPointsFilter
MinDistDataPointsFilter(const Parameters &params=Parameters())
Constructor, uses parameter interface.
Definition: MinDist.cpp:42
PointMatcher.h
public interface
MinDistDataPointsFilter::dim
const int dim
Definition: MinDist.h:64
MinDistDataPointsFilter::inPlaceFilter
virtual void inPlaceFilter(DataPoints &cloud)
Apply these filters to a point cloud without copying.
Definition: MinDist.cpp:62
PointMatcherSupport::Parametrizable::Parameters
std::map< std::string, Parameter > Parameters
Parameters stored as a map of string->string.
Definition: Parametrizable.h:199
MinDistDataPointsFilter::filter
virtual DataPoints filter(const DataPoints &input)
Apply filters to input point cloud. This is the non-destructive version and returns a copy.
Definition: MinDist.cpp:52


libpointmatcher
Author(s):
autogenerated on Mon Jan 1 2024 03:24:43