LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
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#include <string>
12
13namespace lsst {
14namespace afw {
15namespace image {
16
23class Color final {
24public:
26 Color() noexcept
27 : _color_value(std::numeric_limits<double>::quiet_NaN()),
28 _color_type(),
29 _indeterminate(true) {}
30
32 Color(double color_value, std::string const & color_type) noexcept
33 : _color_value(color_value), _color_type(color_type), _indeterminate(false) {}
34
35 Color(Color const &) = default;
36 Color(Color &&) = default;
37 Color &operator=(Color const &) = default;
38 Color &operator=(Color &&) = default;
39 ~Color() noexcept = default;
40
42 bool isIndeterminate() const noexcept { return _indeterminate; }
43
45 double getColorValue() const noexcept { return _color_value; }
46
48 std::string const & getColorType() const noexcept { return _color_type; }
49
56 bool operator==(Color const & other) const noexcept {
57 if (_indeterminate && other._indeterminate) {
58 return true;
59 }
60 if (_indeterminate != other._indeterminate) {
61 return false;
62 }
63 return _color_value == other._color_value && _color_type == other._color_type;
64 }
65 bool operator!=(Color const & other) const noexcept { return !(*this == other); }
66
67private:
68 double _color_value;
69 std::string _color_type;
70 bool _indeterminate;
71};
72
73} // namespace image
74} // namespace afw
75} // namespace lsst
76
77#endif
std::string const & getColorType() const noexcept
The color type string (e.g. "g-r"); only valid if !isIndeterminate().
Definition Color.h:48
bool operator==(Color const &other) const noexcept
Equality comparison for colors.
Definition Color.h:56
Color(Color &&)=default
~Color() noexcept=default
Color & operator=(Color const &)=default
Color(double color_value, std::string const &color_type) noexcept
Fully-specified color: both a numeric value and its type string.
Definition Color.h:32
Color(Color const &)=default
Color() noexcept
Default: indeterminate color.
Definition Color.h:26
double getColorValue() const noexcept
The numeric color value; only valid if !isIndeterminate().
Definition Color.h:45
bool isIndeterminate() const noexcept
Whether this Color was default‑constructed (i.e. has no value/type).
Definition Color.h:42
bool operator!=(Color const &other) const noexcept
Definition Color.h:65
Color & operator=(Color &&)=default
STL namespace.