GDAL
Classes | Typedefs | Enumerations | Functions
gdalpansharpen.h File Reference

GDAL pansharpening related entry points and definitions. More...

#include "gdal.h"
#include <vector>
#include "gdal_priv.h"
#include "cpl_worker_thread_pool.h"

Go to the source code of this file.

Classes

struct  GDALPansharpenOptions
 Pansharpening options. More...
 
class  GDALPansharpenOperation
 Pansharpening operation class. More...
 

Typedefs

typedef void * GDALPansharpenOperationH
 

Enumerations

enum  GDALPansharpenAlg { GDAL_PSH_WEIGHTED_BROVEY }
 Pansharpening algorithms. More...
 

Functions

GDALPansharpenOptionsGDALCreatePansharpenOptions (void)
 Create pansharpening options. More...
 
void GDALDestroyPansharpenOptions (GDALPansharpenOptions *)
 Destroy pansharpening options. More...
 
GDALPansharpenOptionsGDALClonePansharpenOptions (const GDALPansharpenOptions *psOptions)
 Clone pansharpening options. More...
 
GDALPansharpenOperationH GDALCreatePansharpenOperation (const GDALPansharpenOptions *)
 Instantiate a pansharpening operation. More...
 
void GDALDestroyPansharpenOperation (GDALPansharpenOperationH)
 Destroy a pansharpening operation. More...
 
CPLErr GDALPansharpenProcessRegion (GDALPansharpenOperationH hOperation, int nXOff, int nYOff, int nXSize, int nYSize, void *pDataBuf, GDALDataType eBufDataType)
 Executes a pansharpening operation on a rectangular region of the resulting dataset. More...
 

Detailed Description

GDAL pansharpening related entry points and definitions.

Since
GDAL 2.1

Typedef Documentation

typedef void* GDALPansharpenOperationH

Pansharpening operation handle.

Enumeration Type Documentation

Pansharpening algorithms.

Enumerator
GDAL_PSH_WEIGHTED_BROVEY 

Weighted Brovery.

Function Documentation

GDALPansharpenOptions* GDALClonePansharpenOptions ( const GDALPansharpenOptions psOptions)

Clone pansharpening options.

Parameters
psOptionsa pansharpening option structure allocated with GDALCreatePansharpenOptions()
Returns
a newly allocated pansharpening option structure that must be freed with GDALDestroyPansharpenOptions().
Since
GDAL 2.1
GDALPansharpenOperationH GDALCreatePansharpenOperation ( const GDALPansharpenOptions psOptions)

Instantiate a pansharpening operation.

The passed options are validated.

Parameters
psOptionsa pansharpening option structure allocated with GDALCreatePansharpenOptions(). It is duplicated by this function.
Returns
a valid pansharpening operation handle, or NULL in case of failure.
Since
GDAL 2.1
GDALPansharpenOptions* GDALCreatePansharpenOptions ( void  )

Create pansharpening options.

Returns
a newly allocated pansharpening option structure that must be freed with GDALDestroyPansharpenOptions().
Since
GDAL 2.1
void GDALDestroyPansharpenOperation ( GDALPansharpenOperationH  hOperation)

Destroy a pansharpening operation.

Parameters
hOperationa valid pansharpening operation.
Since
GDAL 2.1
void GDALDestroyPansharpenOptions ( GDALPansharpenOptions psOptions)

Destroy pansharpening options.

Parameters
psOptionsa pansharpening option structure allocated with GDALCreatePansharpenOptions()
Since
GDAL 2.1
CPLErr GDALPansharpenProcessRegion ( GDALPansharpenOperationH  hOperation,
int  nXOff,
int  nYOff,
int  nXSize,
int  nYSize,
void *  pDataBuf,
GDALDataType  eBufDataType 
)

Executes a pansharpening operation on a rectangular region of the resulting dataset.

The window is expressed with respect to the dimensions of the panchromatic band.

Spectral bands are upsampled and merged with the panchromatic band according to the select algorithm and options.

Parameters
hOperationa valid pansharpening operation.
nXOffpixel offset.
nYOffpixel offset.
nXSizewidth of the pansharpened region to compute.
nYSizeheight of the pansharpened region to compute.
pDataBufoutput buffer. Must be nXSize * nYSize * GDALGetDataTypeSizeBytes(eBufDataType) * psOptions->nOutPansharpenedBands large. It begins with all values of the first output band, followed by values of the second output band, etc...
eBufDataTypedata type of the output buffer
Returns
CE_None in case of success, CE_Failure in case of failure.
Since
GDAL 2.1

Generated for GDAL by doxygen 1.8.8.