Isis 3 Programmer Reference
Hillshade.h
1 #ifndef Hillshade_H
2 #define Hillshade_H
3 
8 /* SPDX-License-Identifier: CC0-1.0 */
9 
10 class QDebug;
11 class QString;
12 
13 namespace Isis {
14  class Angle;
15  class Buffer;
16 
37  class Hillshade {
38  public:
39  Hillshade();
41  Hillshade(const Hillshade &other);
42  ~Hillshade();
43 
44  void setAzimuth(Angle azimuth);
45  void setZenith(Angle zenith);
46  void setResolution(double resolution);
47 
48  Angle azimuth() const;
49  Angle zenith() const;
50  double resolution() const;
51 
52  double shadedValue(Buffer &input) const;
53 
54  void swap(Hillshade &other);
55  Hillshade &operator=(const Hillshade &rhs);
56 
57  QString toString() const;
58 
59  private:
66  };
67 
68  QDebug operator<<(QDebug, const Hillshade &hillshade);
69 }
70 
71 #endif
Isis::Hillshade::Hillshade
Hillshade()
Create a default-constructed Hillshade.
Definition: Hillshade.cpp:24
Isis::operator<<
QDebug operator<<(QDebug debug, const Hillshade &hillshade)
Print this class out to a QDebug object.
Definition: Hillshade.cpp:314
Isis::Hillshade::setResolution
void setResolution(double resolution)
The resolution is the meters per pixel of the input to shadedValue().
Definition: Hillshade.cpp:115
Isis::Hillshade::zenith
Angle zenith() const
Get the current zenith angle.
Definition: Hillshade.cpp:140
Isis::Hillshade::setAzimuth
void setAzimuth(Angle azimuth)
The azimuth is the direction of the light.
Definition: Hillshade.cpp:82
Isis::Hillshade::swap
void swap(Hillshade &other)
Swap class data with other; this cannot throw an exception.
Definition: Hillshade.cpp:294
Isis::Hillshade::m_zenith
Angle * m_zenith
This is the altitide of the light, with 0 directly overhead and 90 at the horizon.
Definition: Hillshade.h:63
Isis::Hillshade::m_pixelResolution
double m_pixelResolution
meters per pixel
Definition: Hillshade.h:65
Isis::Buffer
Buffer for reading and writing cube data.
Definition: Buffer.h:53
Isis::Hillshade::m_azimuth
Angle * m_azimuth
This is direction of the light, with 0 at north.
Definition: Hillshade.h:61
Isis::Hillshade::azimuth
Angle azimuth() const
Get the current azimuth angle.
Definition: Hillshade.cpp:125
Isis::Hillshade::setZenith
void setZenith(Angle zenith)
The zenith is the altitude/solar elevation of the light.
Definition: Hillshade.cpp:99
Isis::Hillshade::resolution
double resolution() const
Get the current resolution (meters per pixel).
Definition: Hillshade.cpp:155
Isis::Angle
Defines an angle and provides unit conversions.
Definition: Angle.h:45
Isis::Hillshade::operator=
Hillshade & operator=(const Hillshade &rhs)
Assignment operator.
Definition: Hillshade.cpp:304
Isis::Hillshade::shadedValue
double shadedValue(Buffer &input) const
Calculate the shaded value from a 3x3x1 window.
Definition: Hillshade.cpp:163
Isis::Hillshade
Calculate light intensity reflected off a local slope of DEM.
Definition: Hillshade.h:37
Isis
This is free and unencumbered software released into the public domain.
Definition: Apollo.h:16