TiePointsLocatorInputParameters.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/TiePointsLocatorInputParameters.h
  \brief TiePointsLocator input parameters.
 */

#ifndef __TERRALIB_RP_INTERNAL_TIEPOINTSLOCATORINPUTPARAMETERS_H
#define __TERRALIB_RP_INTERNAL_TIEPOINTSLOCATORINPUTPARAMETERS_H

#include "Config.h"
#include "Exception.h"
#include "AlgorithmInputParameters.h"
#include "TiePointsLocatorStrategyParameters.h"
#include "../geometry/GeometricTransformation.h"
#include "../raster/Raster.h"
#include "../raster/Interpolator.h"

#include <vector>
#include <string>
#include <memory>

namespace te
{
  namespace rp
  {
    /*!
      \class TiePointsLocatorInputParameters
      \brief TiePointsLocator input parameters
     */        
    class TERPEXPORT TiePointsLocatorInputParameters : public AlgorithmInputParameters
    {
      public:
        
        std::string m_interesPointsLocationStrategyName; //!< The strategy used to locate interest points (default:Moravec).
        
        te::rst::Raster const* m_inRaster1Ptr; //!< Input raster 1.
        
        te::rst::Raster const* m_inMaskRaster1Ptr; //!< Optional one band input mask raster 1 (tie-points will not be generated inside mask image areas marked with zeroes).
        
        std::vector< unsigned int > m_inRaster1Bands; //!< Bands to be used from the input raster 1.
        
        unsigned int m_raster1TargetAreaLineStart; //!< The first line of the raster 1 target area to process (default:0 - The entire raster will be considered).
        
        unsigned int m_raster1TargetAreaColStart; //!< The first column of the raster 2 target area to process (default:0 - The entire raster will be considered).

        unsigned int m_raster1TargetAreaWidth; //!< The raster 1 target area width (default:0 - The entire raster will be considered).
        
        unsigned int m_raster1TargetAreaHeight; //!< The raster 1 target area height (default:0 - The entire raster will be considered).
        
        te::rst::Raster const* m_inRaster2Ptr; //!< Input raster 2.
        
        te::rst::Raster const* m_inMaskRaster2Ptr; //!< Optional one band input mask raster 2 (tie-points will not be generated inside mask image areas marked with zeroes).
        
        std::vector< unsigned int > m_inRaster2Bands; //!< Bands to be used from the input raster 2.
        
        unsigned int m_raster2TargetAreaLineStart; //!< The first line of the raster 2 target area to process (default:0 - The entire raster will be considered).
        
        unsigned int m_raster2TargetAreaColStart; //!< The first column of the raster 2 target area to process (default:0 - The entire raster will be considered).

        unsigned int m_raster2TargetAreaWidth; //!< The raster 2 target area width (default:0 - The entire raster will be considered).
        
        unsigned int m_raster2TargetAreaHeight; //!< The raster 2 target area height (default:0 - The entire raster will be considered).
        
        bool m_enableMultiThread; //!< Enable/Disable the use of multi-threads (default:true).
        
        bool m_enableProgress; //!< Enable/Disable the progress interface (default:false).
        
        unsigned int m_maxTiePoints; //!< The maximum number of tie-points to generate (0:Automatically calculated, default:2500).
        
        double m_pixelSizeXRelation; //!< The pixel resolution relation m_pixelSizeXRelation = raster1_pixel_res_x / raster2_pixel_res_x (default=1.0).
        
        double m_pixelSizeYRelation; //!< The pixel resolution relation m_pixelSizeYRelation = raster1_pixel_res_y / raster2_pixel_res_y (default=1.0).
        
        std::string m_geomTransfName; //!< The name of the geometric transformation used to ensure tie-points consistency (see each te::gm::GTFactory inherited classes to find each factory key/name, default:Affine).
        
        double m_geomTransfMaxError; //!< The maximum allowed transformation error (pixel units, default:2).
        
        bool m_enableGeometryFilter; //!< Enable/disable the geometry filter/outliers remotion (default:true).
        
        double m_geometryFilterAssurance; //!< Geometry assurance (the error-free selection percent assurance) - Use Lower values for good tie-points sets - Higher values may increase the number of iterations - valid range (0-1) - default:0.75.
        
        double m_subSampleOptimizationRescaleFactor; //!< Sub-sampled optimization tie-points search rescale factor (Tie-ponts will be searched into a subsabmpled image and refined before using the original image - Defaul: 1 - subsample optimization disabled, valid range: non-zero positive values).
        
        double m_subSampleOptimizationMinTPAreaCoverage; //!< Sub-sampled optimization - mininumum required tie-points covered area percent of each raster area - valid range [0,100] (default:25).
        
        double m_subSampleOptimizationMinTPNumberFactor; //!< Sub-sampled optimization - mininumum required tie-points number factor - valid range [1,inf] (default:2).
        
        te::rst::Interpolator::Method m_interpMethod; //!< The raster interpolator method (default:NearestNeighbor).
        
        unsigned int m_tiePointsSubSectorsSplitFactor; //!< The algorithm will try to generate tie-points distributed over image sectors ( Default: 3 - 3x3 sub-sectors, minimum: 1).
        
        TiePointsLocatorInputParameters();
        
        TiePointsLocatorInputParameters( const TiePointsLocatorInputParameters& );
        
        ~TiePointsLocatorInputParameters();
        
        //overload
        void reset() throw( te::rp::Exception );
        
        //overload
        const  TiePointsLocatorInputParameters& operator=( const TiePointsLocatorInputParameters& params );
        
        //overload
        AbstractParameters* clone() const;
        
        /*!
          \brief Set specific tie-points locator strategy parameters.
          \param specStratParams The specific tie-points locator strategy parameters.
        */            
        void setSpecStrategyParams( 
          const TiePointsLocatorStrategyParameters& specStratParams );

        /*!
          \brief Returns a pointer to the internal specific tie-points locator strategy parameters.
          \return A pointer to the internal specific tie-points locator strategy parameters, or
          null if no parameters are present.
        */                                
        TiePointsLocatorStrategyParameters const* getSpecStrategyParams() const;        
        
        /*!
          \brief Returns a pointer to the internal specific tie-points locator strategy parameters.
          \return A pointer to the internal specific tie-points locator strategy parameters, or
          null if no parameters are present.
        */                                
        TiePointsLocatorStrategyParameters* getSpecStrategyParams();          
        
    protected :
      
        /*!
          \brief A pointer to the internal specific segmenter strategy parameters or
          NULL if no parameters are present.
        */               
        std::unique_ptr< TiePointsLocatorStrategyParameters > m_specStratParamsPtr;
    };

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

#endif