Point Cloud Library (PCL)
1.11.1-dev
pcl
visualization
common
float_image_utils.h
1
/*
2
* Software License Agreement (BSD License)
3
*
4
* Copyright (c) 2010, Willow Garage, Inc.
5
* All rights reserved.
6
*
7
* Redistribution and use in source and binary forms, with or without
8
* modification, are permitted provided that the following conditions
9
* are met:
10
*
11
* * Redistributions of source code must retain the above copyright
12
* notice, this list of conditions and the following disclaimer.
13
* * Redistributions in binary form must reproduce the above
14
* copyright notice, this list of conditions and the following
15
* disclaimer in the documentation and/or other materials provided
16
* with the distribution.
17
* * Neither the name of Willow Garage, Inc. nor the names of its
18
* contributors may be used to endorse or promote products derived
19
* from this software without specific prior written permission.
20
*
21
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32
* POSSIBILITY OF SUCH DAMAGE.
33
*/
34
35
#pragma once
36
37
#include <pcl/pcl_config.h>
38
#include <
pcl/pcl_macros.h
>
39
40
#include <limits>
41
42
namespace
pcl
43
{
44
namespace
visualization
45
{
46
/** @b Provide some gerneral functionalities regarding 2d float arrays, e.g., for visualization purposes
47
* \author Bastian Steder
48
* \ingroup visualization
49
*/
50
class
PCL_EXPORTS
FloatImageUtils
51
{
52
public
:
53
// =====STATIC METHODS=====
54
/** Get RGB color values for a given float in [0, 1] or special cases like -INFINITY(light green), INFINITY(light blue), NAN(light red) */
55
static
void
56
getColorForFloat (
float
value,
unsigned
char
& r,
unsigned
char
& g,
unsigned
char
& b);
57
58
/** Get RGB color values for a given float in [-PI, PI] or special cases like -INFINITY(light green), INFINITY(light blue), NAN(light red)
59
* The colors are black(-PI) -> blue(-PI/2) -> white(0) -> green(PI/2) -> black(PI) with accordant values in between */
60
static
void
61
getColorForAngle (
float
value,
unsigned
char
& r,
unsigned
char
& g,
unsigned
char
& b);
62
63
/** Get RGB color values for a given float in [0, PI] or special cases like -INFINITY(light green), INFINITY(light blue), NAN(light red)
64
* The colors are black(-PI/2) -> blue(-PI/4) -> white(0) -> green(PI/4) -> black(PI/2) with accordant values in between */
65
static
void
66
getColorForHalfAngle (
float
value,
unsigned
char
& r,
unsigned
char
& g,
unsigned
char
& b);
67
68
/** Use getColorForFloat for all elements of the given arrays, whereas the values are first normalized to [0,1],
69
* either using the given min/max values or based on the actual minimal and maximal values existing in the array.
70
* The output is a byte array of size 3*width*height containing the colors in RGB order.
71
* If gray_scale is true, the outcome will still be an RGB image, but all colors apart for the special colors of
72
* non-finite numbers, will be gray values */
73
static
unsigned
char
*
74
getVisualImage (
const
float
* float_image,
int
width,
int
height,
float
min_value=-std::numeric_limits<float>::infinity (),
float
max_value=std::numeric_limits<float>::infinity (),
bool
gray_scale=
false
);
75
76
/** Use getColorForFloat for all elements of the given arrays, whereas the values are normalized to [0,1]
77
* with the given min/max values.
78
* The output is a byte array of size 3*width*height containing the colors in RGB order.
79
* If gray_scale is true, the outcome will still be an RGB image, but all colors will be gray values. */
80
static
unsigned
char
*
81
getVisualImage (
const
unsigned
short
* float_image,
int
width,
int
height,
82
unsigned
short
min_value=0,
83
unsigned
short
max_value=std::numeric_limits<unsigned short>::max (),
84
bool
gray_scale=
false
);
85
86
/** Use getColorForAngle for all elements of the given arrays. */
87
static
unsigned
char
*
88
getVisualAngleImage (
const
float
* angle_image,
int
width,
int
height);
89
90
/** Use getColorForHalfAngle for all elements of the given arrays. */
91
static
unsigned
char
*
92
getVisualHalfAngleImage (
const
float
* angle_image,
int
width,
int
height);
93
};
94
95
}
// namespace end
96
}
pcl_macros.h
Defines all the PCL and non-PCL macros used.
pcl
Definition:
convolution.h:46
pcl::visualization::FloatImageUtils
Provide some gerneral functionalities regarding 2d float arrays, e.g., for visualization purposes
Definition:
float_image_utils.h:50
PCL_EXPORTS
#define PCL_EXPORTS
Definition:
pcl_macros.h:323