SelectedChannel.h
Go to the documentation of this file.
1 /* Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.
2 
3  This file is part of the TerraLib - a Framework for building GIS enabled applications.
4 
5  TerraLib is free software: you can redistribute it and/or modify
6  it under the terms of the GNU Lesser General Public License as published by
7  the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  TerraLib is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU Lesser General Public License for more details.
14 
15  You should have received a copy of the GNU Lesser General Public License
16  along with TerraLib. See COPYING. If not, write to
17  TerraLib Team at <terralib-team@terralib.org>.
18  */
19 
20 /*!
21  \file terralib/se/SelectedChannel.h
22 
23  \brief A selected channel to be display.
24 */
25 
26 #ifndef __TERRALIB_SE_INTERNAL_SELECTEDCHANNEL_H
27 #define __TERRALIB_SE_INTERNAL_SELECTEDCHANNEL_H
28 
29 // TerraLib
30 #include "Config.h"
31 
32 // STL
33 #include <string>
34 
35 // Boost
36 #include <boost/noncopyable.hpp>
37 
38 namespace te
39 {
40  namespace se
41  {
42 // Forward declaration
43  class ContrastEnhancement;
44 
45  /*!
46  \class SelectedChannel
47 
48  \brief A selected channel to be display.
49 
50  \sa ChannelSelection, ContrastEnhancement
51  */
52  class TESEEXPORT SelectedChannel : public boost::noncopyable
53  {
54  public:
55 
56  /** @name Initializer Methods
57  * Methods related to instantiation and destruction.
58  */
59  //@{
60 
61  /*! \brief It initializes a new SelectedChannel. */
63 
64  /*! \brief Destructor. */
65  ~SelectedChannel();
66 
67  //@}
68 
69  /** @name Accessor methods
70  * Methods used to get or set properties.
71  */
72  //@{
73 
74  void setSourceChannelName(const std::string& name);
75 
76  std::string getSourceChannelName() const { return m_sourceChannelName; }
77 
78  void setContrastEnhancement(ContrastEnhancement* c);
79 
80  ContrastEnhancement* getContrastEnhancement() const { return m_contrastEnhancement; }
81 
82  //@}
83 
84  /*! \brief It creates a new copy of this object. */
85  SelectedChannel* clone() const;
86 
87  private:
88 
89  std::string m_sourceChannelName; //!< Channels are identified by a system and data-dependent character identifier. Commonly, channels will be labelled as "1", "2" and so on. (Mandatory)
90  ContrastEnhancement* m_contrastEnhancement; //!< Contrast enhancement that can be applied to a channel in isolation. (Optional)
91  };
92 
93  } // end namespace se
94 } // end namespace te
95 
96 #endif // __TERRALIB_SE_INTERNAL_SELECTEDCHANNEL_H
A selected channel to be display.
std::string getSourceChannelName() const
URI C++ Library.
ContrastEnhancement defines the 'stretching' of contrast for a channel of a false-color image or for ...
#define TESEEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:187
Configuration flags for the Symbology Encoding support of TerraLib.
ContrastEnhancement * m_contrastEnhancement
Contrast enhancement that can be applied to a channel in isolation. (Optional)
ContrastEnhancement * getContrastEnhancement() const
std::string m_sourceChannelName
Channels are identified by a system and data-dependent character identifier. Commonly, channels will be labelled as "1", "2" and so on. (Mandatory)