isce3::matchtemplate::pycuampcor::cuAmpcorParameter Class Reference

Class container for all parameters. More...

#include <cuAmpcorParameter.h>

Public Member Functions
	cuAmpcorParameter (const cuAmpcorParameter &)=delete
cuAmpcorParameter &	operator= (const cuAmpcorParameter &)=delete
	cuAmpcorParameter (cuAmpcorParameter &&)=delete
cuAmpcorParameter &	operator= (cuAmpcorParameter &&)=delete
	cuAmpcorParameter ()
	Constructor for cuAmpcorParameter class also sets the default/initial values of various parameters.
void	allocateArrays ()
void	setStartPixels (int *, int *, int *, int *)
	Set starting pixels for reference and secondary windows from arrays set also gross offsets between reference and secondary windows.
void	setStartPixels (int, int, int *, int *)
	set starting pixels for each window with a varying gross offset
void	setStartPixels (int, int, int, int)
	set starting pixels for each window with a constant gross offset
void	setChunkStartPixels ()
	set starting pixels for each chunk
void	checkPixelInImageRange ()
	check whether reference and secondary windows are within the image range
void	setupParameters ()
	To determine other process parameters after reading essential parameters from python.

Public Attributes
int	algorithm
	Cross-correlation algorithm: 0=freq domain (default) 1=time domain.
int	deviceID
	Targeted GPU device ID: use -1 to auto select.
int	nStreams
	Number of streams to asynchonize data transfers and compute kernels.
int	derampMethod
	Method for deramping 0=None, 1=average.
int	windowSizeHeightRaw
	Template window height (original size)
int	windowSizeWidthRaw
	Template window width (original size)
int	searchWindowSizeHeightRaw
	Search window height (original size)
int	searchWindowSizeWidthRaw
	Search window width (orignal size)
int	halfSearchRangeDownRaw
	(searchWindowSizeHeightRaw-windowSizeHeightRaw)/2
int	halfSearchRangeAcrossRaw
	(searchWindowSizeWidthRaw-windowSizeWidthRaw)/2
int	searchWindowSizeHeightRawZoomIn
	search window height used for zoom in
int	searchWindowSizeWidthRawZoomIn
	search window width used for zoom in
int	corrStatWindowSize
	correlation surface size used to estimate snr
int	corrRawZoomInHeight
	correlation surface height used for oversampling
int	corrRawZoomInWidth
	correlation surface width used for oversampling
int	rawDataOversamplingFactor
	Raw data overampling factor (from original size to oversampled size)
int	windowSizeHeight
	Template window length (oversampled size)
int	windowSizeWidth
	Template window width (original size)
int	searchWindowSizeHeight
	Search window height (oversampled size)
int	searchWindowSizeWidth
	Search window width (oversampled size)
int	skipSampleDownRaw
	Skip size between neighboring windows in Down direction (original size)
int	skipSampleAcrossRaw
	Skip size between neighboring windows in across direction (original size)
int	zoomWindowSize
	Zoom-in window size in correlation surface (same for down and across directions)
int	halfZoomWindowSizeRaw
	half of zoomWindowSize/rawDataOversamplingFactor
int	oversamplingFactor
	Oversampling factor for interpolating correlation surface.
int	oversamplingMethod
	correlation surface oversampling method 0 = fft (default) 1 = sinc
float	thresholdSNR
	Threshold of Signal noise ratio to remove noisy data.
std::string	referenceImageName
	reference SLC image name
int	imageDataType1
	reference image data type, 2=cfloat=complex=float2 1=float
int	referenceImageHeight
	reference image height
int	referenceImageWidth
	reference image width
std::string	secondaryImageName
	secondary SLC image name
int	imageDataType2
	secondary image data type, 2=cfloat=complex=float2 1=float
int	secondaryImageHeight
	secondary image height
int	secondaryImageWidth
	secondary image width
int	numberWindowDown
	number of total windows (down)
int	numberWindowAcross
	number of total windows (across)
int	numberWindows
	numberWindowDown*numberWindowAcross
int	numberWindowDownInChunk
	number of windows processed in a chunk (down)
int	numberWindowAcrossInChunk
	number of windows processed in a chunk (across)
int	numberWindowsInChunk
	numberWindowDownInChunk*numberWindowAcrossInChunk
int	numberChunkDown
	number of chunks (down)
int	numberChunkAcross
	number of chunks (across)
int	numberChunks
	total number of chunks
int	useMmap
	whether to use mmap 0=not 1=yes (default = 0)
int	mmapSizeInGB
	size for mmap buffer(useMmap=1) or a cpu memory buffer (useMmap=0)
int	referenceStartPixelDown0
	first starting pixel in reference image (down)
int	referenceStartPixelAcross0
	first starting pixel in reference image (across)
std::vector< int >	referenceStartPixelDown
	reference starting pixels for each window (down)
std::vector< int >	referenceStartPixelAcross
	reference starting pixels for each window (across)
std::vector< int >	secondaryStartPixelDown
	secondary starting pixels for each window (down)
std::vector< int >	secondaryStartPixelAcross
	secondary starting pixels for each window (across)
int	grossOffsetDown0
	gross offset static component (down)
int	grossOffsetAcross0
	gross offset static component (across)
std::vector< int >	grossOffsetDown
	Gross offsets between reference and secondary windows (down)
std::vector< int >	grossOffsetAcross
	Gross offsets between reference and secondary windows (across)
int	mergeGrossOffset
	whether to merge gross offsets into the final offsets
std::vector< int >	referenceChunkStartPixelDown
	reference starting pixels for each chunk (down)
std::vector< int >	referenceChunkStartPixelAcross
	reference starting pixels for each chunk (across)
std::vector< int >	secondaryChunkStartPixelDown
	secondary starting pixels for each chunk (down)
std::vector< int >	secondaryChunkStartPixelAcross
	secondary starting pixels for each chunk (across)
std::vector< int >	referenceChunkHeight
	reference chunk height
std::vector< int >	referenceChunkWidth
	reference chunk width
std::vector< int >	secondaryChunkHeight
	secondary chunk height
std::vector< int >	secondaryChunkWidth
	secondary chunk width
int	maxReferenceChunkHeight
int	maxReferenceChunkWidth
	max reference chunk size
int	maxSecondaryChunkHeight
int	maxSecondaryChunkWidth
	max secondary chunk size
std::string	grossOffsetImageName
	gross offset output filename
std::string	offsetImageName
	Offset fields output filename.
std::string	snrImageName
	Output SNR filename.
std::string	covImageName
	Output variance filename.
std::string	corrImageName
	Output cross-correlation peak filename.

Detailed Description

Class container for all parameters.

Note

The dimension/direction names used are: The inner-most dimension: x, row, height, down, azimuth, along the track. The outer-most dimension: y, column, width, across, range, along the sight. C/C++/Python use row-major indexing: a[i][j] -> a[i*WIDTH+j] FORTRAN/BLAS/CUBLAS use column-major indexing: a[i][j]->a[i+j*LENGTH]

Common procedures to use cuAmpcorParameter

1. Create an instance of cuAmpcorParameter: param = new cuAmpcorParameter()
2. Provide/set constant parameters, including numberWindows such as : param->numberWindowDown = 100
3. Call setupParameters() to determine related parameters and allocate starting pixels for each window: param->setupParameters()
4. Provide/set Reference window starting pixel(s), and gross offset(s): param->setStartPixels(referenceStartDown, referenceStartAcross, grossOffsetDown, grossOffsetAcross) 4a. Optionally, check the range of windows is within the SLC image range: param->checkPixelInImageRange() Steps 1, 3, 4 are mandatory. If step 2 is missing, default values will be used

---

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

• /home/runner/work/isce3/isce3/cxx/isce3/matchtemplate/pycuampcor/cuAmpcorParameter.h
• /home/runner/work/isce3/isce3/cxx/isce3/matchtemplate/pycuampcor/cuAmpcorParameter.cpp