Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
te::sa::KernelRatioOperation Class Reference

Class used to calculate the kernel ratio of a datasets. More...

#include <KernelRatioOperation.h>

Inheritance diagram for te::sa::KernelRatioOperation:
te::sa::KernelOperation

Public Member Functions

virtual void execute ()
 Function to execute the kernel operation. More...
 
 KernelRatioOperation ()
 Default constructor. More...
 
void setInputParameters (te::sa::KernelInputParams *inParamsA, te::sa::KernelInputParams *inParamsB)
 
void setOutputParameters (te::sa::KernelOutputParams *outParams)
 
 ~KernelRatioOperation ()
 Virtual destructor. More...
 

Protected Member Functions

std::unique_ptr< te::rst::Raster > buildRaster (te::sa::KernelInputParams *inputParams, te::sa::KernelTree &kTree, std::string driver)
 
virtual void buildTree ()
 
std::unique_ptr< te::mem::DataSet > createDataSet (te::da::DataSet *inputDataSet, te::da::DataSetType *dsType)
 
std::unique_ptr< te::da::DataSetType > createDataSetType (te::da::DataSetType *dsType)
 
std::unique_ptr< te::mem::DataSet > runDataSetKernel (te::sa::KernelInputParams *inputParams, te::sa::KernelTree &kTree, te::sa::KernelMap &kMap, te::da::DataSetType *dsType)
 
void runRasterKernel (te::sa::KernelInputParams *inputParams, te::sa::KernelTree &kTree, te::sa::KernelMap &kMap, te::rst::Raster *raster)
 
void saveDataSet (te::da::DataSet *dataSet, te::da::DataSetType *dsType)
 

Protected Attributes

std::unique_ptr< te::sa::KernelInputParams > m_inputParamsA
 Kernel input parameters A. More...
 
std::unique_ptr< te::sa::KernelInputParams > m_inputParamsB
 Kernel input parameters B. More...
 
te::sa::KernelMap m_kMapA
 Kernel map with input data A. More...
 
te::sa::KernelMap m_kMapB
 Kernel map with input data B. More...
 
te::sa::KernelTree m_kTree
 Attribute used to locate near geometries. More...
 
std::unique_ptr< te::sa::KernelOutputParams > m_outputParams
 Attribute with the kernel output parameters. More...
 

Detailed Description

Class used to calculate the kernel ratio of a datasets.

See also
KernelOperation

Definition at line 53 of file KernelRatioOperation.h.

Constructor & Destructor Documentation

◆ KernelRatioOperation()

te::sa::KernelRatioOperation::KernelRatioOperation ( )

Default constructor.

◆ ~KernelRatioOperation()

te::sa::KernelRatioOperation::~KernelRatioOperation ( )

Virtual destructor.

Member Function Documentation

◆ buildRaster()

std::unique_ptr<te::rst::Raster> te::sa::KernelOperation::buildRaster ( te::sa::KernelInputParams *  inputParams,
te::sa::KernelTree &  kTree,
std::string  driver 
)
protectedinherited

Function used to create the output raster

◆ buildTree()

virtual void te::sa::KernelRatioOperation::buildTree ( )
protectedvirtual

Function used to build the tree with data set information

Implements te::sa::KernelOperation.

◆ createDataSet()

std::unique_ptr<te::mem::DataSet> te::sa::KernelOperation::createDataSet ( te::da::DataSet *  inputDataSet,
te::da::DataSetType *  dsType 
)
protectedinherited

Function used to create the output dataset

◆ createDataSetType()

std::unique_ptr<te::da::DataSetType> te::sa::KernelOperation::createDataSetType ( te::da::DataSetType *  dsType)
protectedinherited

Function used to create the output dataset type

◆ execute()

virtual void te::sa::KernelRatioOperation::execute ( )
virtual

Function to execute the kernel operation.

Implements te::sa::KernelOperation.

◆ runDataSetKernel()

std::unique_ptr<te::mem::DataSet> te::sa::KernelOperation::runDataSetKernel ( te::sa::KernelInputParams *  inputParams,
te::sa::KernelTree &  kTree,
te::sa::KernelMap &  kMap,
te::da::DataSetType *  dsType 
)
protectedinherited

Function used to run kernel when output data is dataset

◆ runRasterKernel()

void te::sa::KernelOperation::runRasterKernel ( te::sa::KernelInputParams *  inputParams,
te::sa::KernelTree &  kTree,
te::sa::KernelMap &  kMap,
te::rst::Raster *  raster 
)
protectedinherited

Function used to run kernel when output data is a raster

◆ saveDataSet()

void te::sa::KernelOperation::saveDataSet ( te::da::DataSet *  dataSet,
te::da::DataSetType *  dsType 
)
protectedinherited

Function used to save the output dataset

◆ setInputParameters()

void te::sa::KernelRatioOperation::setInputParameters ( te::sa::KernelInputParams *  inParamsA,
te::sa::KernelInputParams *  inParamsB 
)

◆ setOutputParameters()

void te::sa::KernelOperation::setOutputParameters ( te::sa::KernelOutputParams *  outParams)
inherited

Member Data Documentation

◆ m_inputParamsA

std::unique_ptr<te::sa::KernelInputParams> te::sa::KernelRatioOperation::m_inputParamsA
protected

Kernel input parameters A.

Definition at line 80 of file KernelRatioOperation.h.

◆ m_inputParamsB

std::unique_ptr<te::sa::KernelInputParams> te::sa::KernelRatioOperation::m_inputParamsB
protected

Kernel input parameters B.

Definition at line 81 of file KernelRatioOperation.h.

◆ m_kMapA

te::sa::KernelMap te::sa::KernelRatioOperation::m_kMapA
protected

Kernel map with input data A.

Definition at line 77 of file KernelRatioOperation.h.

◆ m_kMapB

te::sa::KernelMap te::sa::KernelRatioOperation::m_kMapB
protected

Kernel map with input data B.

Definition at line 78 of file KernelRatioOperation.h.

◆ m_kTree

te::sa::KernelTree te::sa::KernelOperation::m_kTree
protectedinherited

Attribute used to locate near geometries.

Definition at line 102 of file KernelOperation.h.

◆ m_outputParams

std::unique_ptr<te::sa::KernelOutputParams> te::sa::KernelOperation::m_outputParams
protectedinherited

Attribute with the kernel output parameters.

Definition at line 100 of file KernelOperation.h.

The documentation for this class was generated from the following file: