Classifier.h

Go to the documentation of this file.

/*  Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.

    This file is part of the TerraLib - a Framework for building GIS enabled applications.

    TerraLib is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License,
    or (at your option) any later version.

    TerraLib is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with TerraLib. See COPYING. If not, write to
    TerraLib Team at <terralib-team@terralib.org>.
 */
/*!
  \file terralib/rp/Classifier.h

  \brief Raster classification.
 */

#ifndef __TERRALIB_RP_INTERNAL_CLASSIFIER_H
#define __TERRALIB_RP_INTERNAL_CLASSIFIER_H

// TerraLib
#include "Algorithm.h"
#include "Config.h"
#include "Matrix.h"
#include "ClassifierStrategyParameters.h"
#include "../raster/BandProperty.h"

#include <map>

namespace te
{
  namespace rst
  {
    class Raster;
    class Band;
  }

  namespace gm
  {
    class Polygon;
  }

  namespace rp
  {
    /*!
      \class Classifier

      \brief Raster classification.

      \details Raster classification following the choosed strategy.

      \note The created label image will be written to the raster instance
      pointed by m_outRasterPtr (in this case the output band must also be
      passed by m_outRasterBand).

      \ingroup rp_class
    */
    class TERPEXPORT Classifier : public Algorithm
    {
      public:

        /*!
          \class InputParameters

          \brief Classifier input parameters
        */

        class TERPEXPORT InputParameters : public AlgorithmInputParameters
        {
          public:

            /*! \brief Default constructor. */
            InputParameters();

            /*!
              \brief Copy constructor.

              \param rhs The right-hand side Raster.
            */
            InputParameters(const InputParameters& rhs);

            ~InputParameters();

            /*!
              \brief Set specific classifier strategy parameters.

              \param p The specific classifier strategy parameters.
            */
            void setClassifierStrategyParams(const ClassifierStrategyParameters& p);

            /*!
              \brief Returns a pointer to the internal specific classifier strategy parameters, or null if no parameters are present.
            */
            ClassifierStrategyParameters const* getClassifierStrategyParams() const;

            //overload
            void reset() throw(te::rp::Exception);

            //overload
            const Classifier::InputParameters& operator=(const Classifier::InputParameters& params);

            //overload
            te::common::AbstractParameters* clone() const;

          public:

            te::rst::Raster const* m_inputRasterPtr;                      //!< Input raster.
            bool m_enableProgressInterface;                               //!< Enable (true) or disable (false) the use of a progress interface (default: disabled).
            bool m_createRasterPalette;                                   //!< Enable (true) or disable (false) the creation of a paletted output raster (default:true).
            bool m_enableRasterCache;                                     //!< Enable (true) or disable (false) the use of memory raster data cache (default:true).
            bool m_enableMultiThread;                                     //!< Enable (true) or disable (false) the use multiple threads (default:true).
            std::vector<unsigned int> m_inputRasterBands;                 //!< Bands to be processed from the input raster.
            std::vector<te::gm::Polygon*> m_inputPolygons;                //!< The polygons to be classified when using object-based image analysis (OBIA).
            std::string m_strategyName;                                   //!< The classifier strategy name see each te::rp::ClassifierStrategyFactory inherited classes documentation for reference.
            ClassifierStrategyParameters* m_classifierStrategyParamsPtr;  //!< Internal specific classifier strategy parameters.
            std::vector< te::rst::BandProperty::ColorEntry > m_userOutputPalette;  //!< User output raster palette (it must be large enough to accomodate all classifyier generated classes or an empty vector to automatically generate an random palette.

        };

        /*!
          \class OutputParameters

          \brief Classifier output parameters
        */

        class TERPEXPORT OutputParameters : public AlgorithmOutputParameters
        {
          public:

            /*! \brief Default constructor. */
            OutputParameters();

            /*!
              \brief Copy constructor.

              \param rhs The right-hand side Raster.
            */
            OutputParameters(const OutputParameters& rhs);

            ~OutputParameters();

            //overload
            void reset() throw(te::rp::Exception);

            //overload
            const Classifier::OutputParameters& operator=(const Classifier::OutputParameters& params);

            //overload
            te::common::AbstractParameters* clone() const;

          public:

            std::string m_rType;                                          //!< Output raster data source type (as described in te::raster::RasterFactory ).
            std::map< std::string, std::string > m_rInfo;                 //!< The necessary information to create the raster (as described in te::raster::RasterFactory).
            mutable std::unique_ptr<te::rst::Raster> m_outputRasterPtr;     //!< A pointer to the generated output raster (label image).
            std::map< std::string, std::string > m_metadata;              //!< Extra strategy-dependent generated metadata.
        };

        Classifier();

        ~Classifier();

        //overload
        bool execute(AlgorithmOutputParameters& outputParams) throw(te::rp::Exception);

        //overload
        void reset() throw(te::rp::Exception);

        //overload
        bool initialize(const AlgorithmInputParameters& inputParams) throw(te::rp::Exception);

        bool isInitialized() const;

      protected :

        bool m_instanceInitialized;                        //!< Is this instance already initialized?
        Classifier::InputParameters m_inputParameters;     //!< Classifier execution parameters.
    };

  } // end namespace rp
}   // end namespace te

#endif