lsst.afw ge15bfa9975+e3573e3735
Loading...
Searching...
No Matches
Color.h
Go to the documentation of this file.
1// -*- lsst-c++ -*-
2/*
3 * Capture the colour of an object
4 */
5
6#ifndef LSST_AFW_IMAGE_COLOR_H
7#define LSST_AFW_IMAGE_COLOR_H
8
9#include <cmath>
10#include <limits>
11
12namespace lsst {
13namespace afw {
14namespace image {
15
25class Color final {
26public:
27 explicit Color(double g_r = std::numeric_limits<double>::quiet_NaN()) : _g_r(g_r) {}
28
29 Color(Color const &) = default;
30 Color(Color &&) = default;
31 Color &operator=(Color const &) = default;
32 Color &operator=(Color &&) = default;
33 ~Color() noexcept = default;
34
36 bool isIndeterminate() const noexcept { return std::isnan(_g_r); }
37
39
49 bool operator==(Color const &other) const noexcept {
50 return (isIndeterminate() && other.isIndeterminate()) || other._g_r == _g_r;
51 }
52 bool operator!=(Color const &other) const noexcept { return !operator==(other); }
54
56 std::size_t hash_value() const noexcept { return isIndeterminate() ? 42 : std::hash<double>()(_g_r); }
57
58private:
59 double _g_r;
60};
61} // namespace image
62} // namespace afw
63} // namespace lsst
64
65namespace std {
66template <>
67struct hash<lsst::afw::image::Color> {
70 size_t operator()(argument_type const &obj) const noexcept { return obj.hash_value(); }
71};
72} // namespace std
73
74#endif
Describe the colour of a source.
Definition: Color.h:25
bool operator==(Color const &other) const noexcept
Equality comparison for colors.
Definition: Color.h:49
Color(Color &&)=default
~Color() noexcept=default
Color(double g_r=std::numeric_limits< double >::quiet_NaN())
Definition: Color.h:27
Color & operator=(Color const &)=default
Color(Color const &)=default
std::size_t hash_value() const noexcept
Return a hash of this object.
Definition: Color.h:56
bool isIndeterminate() const noexcept
Whether the color is the special value that indicates that it is unspecified.
Definition: Color.h:36
bool operator!=(Color const &other) const noexcept
Definition: Color.h:52
Color & operator=(Color &&)=default
T isnan(T... args)
STL namespace.
size_t operator()(argument_type const &obj) const noexcept
Definition: Color.h:70