MaxDist.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 beyond a maximum distance measured on a specific axis. If dim is set to -1, points are filtered based on a maximum 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  {"maxDist", "maximum distance authorized. If dim is set to -1 (radius), the absolute value of minDist will be used. All points beyond that will be filtered.", "1", "-inf", "inf", &P::Comp<T>}
61  };
62  }
63 
64  const int dim;
65  const T maxDist;
66 
69  virtual DataPoints filter(const DataPoints& input);
70  virtual void inPlaceFilter(DataPoints& cloud);
71 };
MaxDistDataPointsFilter::ParametersDoc
Parametrizable::ParametersDoc ParametersDoc
Definition: MaxDist.h:47
MaxDistDataPointsFilter::description
static const std::string description()
Definition: MaxDist.h:52
DataPointsFilter
PM::DataPointsFilter DataPointsFilter
Definition: pypoint_matcher_helper.h:22
build_map.T
T
Definition: build_map.py:34
PointMatcher
Functions and classes that are dependant on scalar type are defined in this templatized class.
Definition: PointMatcher.h:130
MaxDistDataPointsFilter
Subsampling. Filter points beyond a maximum distance measured on a specific axis.
Definition: MaxDist.h:41
PointMatcher::DataPoints
A point cloud.
Definition: PointMatcher.h:207
MaxDistDataPointsFilter::maxDist
const T maxDist
Definition: MaxDist.h:65
testing::internal::string
::std::string string
Definition: gtest.h:1979
MaxDistDataPointsFilter::availableParameters
static const ParametersDoc availableParameters()
Definition: MaxDist.h:56
MaxDistDataPointsFilter::filter
virtual DataPoints filter(const DataPoints &input)
Apply filters to input point cloud. This is the non-destructive version and returns a copy.
Definition: MaxDist.cpp: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
MaxDistDataPointsFilter::P
PointMatcherSupport::Parametrizable P
Definition: MaxDist.h:44
MaxDistDataPointsFilter::ParameterDoc
Parametrizable::ParameterDoc ParameterDoc
Definition: MaxDist.h:46
PointMatcherSupport::Parametrizable::InvalidParameter
An exception thrown when one tries to fetch the value of an unexisting parameter.
Definition: Parametrizable.h:144
MaxDistDataPointsFilter::DataPoints
PointMatcher< T >::DataPoints DataPoints
Definition: MaxDist.h:50
MaxDistDataPointsFilter::dim
const int dim
Definition: MaxDist.h:64
PointMatcherSupport::Parametrizable
The superclass of classes that are constructed using generic parameters. This class provides the para...
Definition: Parametrizable.h:141
MaxDistDataPointsFilter::inPlaceFilter
virtual void inPlaceFilter(DataPoints &cloud)
Apply these filters to a point cloud without copying.
Definition: MaxDist.cpp:62
MaxDistDataPointsFilter::InvalidParameter
Parametrizable::InvalidParameter InvalidParameter
Definition: MaxDist.h:48
PointMatcherSupport::Parametrizable::ParameterDoc
The documentation of a parameter.
Definition: Parametrizable.h:160
MaxDistDataPointsFilter::Parametrizable
PointMatcherSupport::Parametrizable Parametrizable
Definition: MaxDist.h:43
MaxDistDataPointsFilter::Parameters
Parametrizable::Parameters Parameters
Definition: MaxDist.h:45
PointMatcher.h
public interface
PointMatcherSupport::Parametrizable::Parameters
std::map< std::string, Parameter > Parameters
Parameters stored as a map of string->string.
Definition: Parametrizable.h:199
MaxDistDataPointsFilter::MaxDistDataPointsFilter
MaxDistDataPointsFilter(const Parameters &params=Parameters())
Constructor, uses parameter interface.
Definition: MaxDist.cpp:42


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