LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
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.