File ATORimagecomparison Documentation

Automatically generated with Code Structure Viewer (CS), Project Version: 3o4d 17-November-2020

Copyright © 2020, BAI Research. All Rights Reserved.

File Name: ATORimagecomparison.cpp/.hpp

File Description: ATOR imagecomparison

File Function List


File Diagram (functions hierarchy)


Function ATORimagecomparisonClass::disablePixelsThatAreNotContainedInTheObjectTriangle2DOD()

Function Summary
namereturn typedescription
disablePixelsThatAreNotContainedInTheObjectTriangle2DODvoiddisable pixels that are not contained in the object triangle 2DOD

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
rgbMap uchar* rgb map

Function Reference List


Function Trace
locationcurrent function being traced
ATORmethod.hppdisablePixelsThatAreNotContainedInTheObjectTriangle2DOD
ATORmethod.hppgenerateNormalisedSnapshotsUsingPolyList
ATORmethod.hppATORmethodTrainOrTest
ATORmain.hppATORmethodTrain
ATORmethod.hppATORmethodTrainOrTest

Trace Diagram (magenta)


Function ATORimagecomparisonClass::applyGaussianKernelToRGBmap()

Function Summary
namereturn typedescription
applyGaussianKernelToRGBmapvoidapply gaussian kernel to RGB map

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
sigma const double sigma
rgbMap const uchar* rgb map
rgbMapWithGaussianApplied uchar* rgb map with gaussian applied

Function Reference List


Function Trace
locationcurrent function being traced
ATORmethod.hppapplyGaussianKernelToRGBmap
ATORmethod.hppgenerateNormalisedSnapshotsUsingPolyList
ATORmethod.hppATORmethodTrainOrTest
ATORmain.hppATORmethodTrain
ATORmethod.hppATORmethodTrainOrTest

Trace Diagram (magenta)


Function ATORimagecomparisonClass::applyGaussianKernelToLuminosityMapOrRGBmapComponent()

Function Summary
namereturn typedescription
applyGaussianKernelToLuminosityMapOrRGBmapComponentvoidapply gaussian kernel to luminosity map or RGB map component

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
sigma const double sigma
luminosityMap const double* luminosity map
luminosityMapWithGaussianApplied double* luminosity map with gaussian applied
rgbMap const uchar* rgb map
rgbMapWithGaussianApplied uchar* rgb map with gaussian applied
useRGBmapComponent const bool use RGB map component
rgbMapComponentNumber const int rgb map component number

Function Reference List


Function Trace
locationcurrent function being traced
ATORimagecomparison.hppapplyGaussianKernelToLuminosityMapOrRGBmapComponent
ATORmethod.hppapplyGaussianKernelToRGBmap
ATORmethod.hppgenerateNormalisedSnapshotsUsingPolyList
ATORmethod.hppATORmethodTrainOrTest
ATORmain.hppATORmethodTrain
ATORmethod.hppATORmethodTrainOrTest

Trace Diagram (magenta)


Function ATORimagecomparisonClass::createNormalisedHueContrastMapUsingRGBmapAndCalculateAllContrastValues()

Function Summary
namereturn typedescription
createNormalisedHueContrastMapUsingRGBmapAndCalculateAllContrastValuesvoidcreate normalised hue contrast map using RGB map and calculate all contrast values

Function Arguments
nametypedescription
imageWidthint image width
imageHeight int image height
rgbMap uchar* rgb map
normalisedHueContrastMap double* normalised hue contrast map
normalisedAverageHueContrastR double* normalised average hue contrast R
normalisedAverageHueContrastG double* normalised average hue contrast G
normalisedAverageHueContrastB double* normalised average hue contrast B
averageContrastWithRespectToAverageColour double* average contrast with respect to average colour
averageStarkContrastWithRespectToAverageColour double* average stark contrast with respect to average colour
averageLocalContrast double* average local contrast
averageLocalStarkContrast double* average local stark contrast

Function Reference List


Function Trace
locationcurrent function being traced
ATORmethod.hppcreateNormalisedHueContrastMapUsingRGBmapAndCalculateAllContrastValues
ATORmethod.hppgenerateNormalisedSnapshotsUsingPolyList
ATORmethod.hppATORmethodTrainOrTest
ATORmain.hppATORmethodTrain
ATORmethod.hppATORmethodTrainOrTest
ATORcomparison.hppcreateNormalisedHueContrastMapUsingRGBmapAndCalculateAllContrastValues
ATORmethod.hppcompareNormalisedSnapshots

Trace Diagram (magenta)


Function ATORimagecomparisonClass::checkImageHasContrastValuesOnly()

Function Summary
namereturn typedescription
checkImageHasContrastValuesOnlyboolcheck image has contrast values only

Function Arguments
nametypedescription
averageContrastWithRespectToAverageColourconst double average contrast with respect to average colour
averageStarkContrastWithRespectToAverageColour const double average stark contrast with respect to average colour
averageLocalContrast const double average local contrast
averageLocalStarkContrast const double average local stark contrast

Function Reference List
N/A


Function Trace
locationcurrent function being traced
ATORmethod.hppcheckImageHasContrastValuesOnly
ATORmethod.hppgenerateNormalisedSnapshotsUsingPolyList
ATORmethod.hppATORmethodTrainOrTest
ATORmain.hppATORmethodTrain
ATORmethod.hppATORmethodTrainOrTest

Trace Diagram (magenta)


Function ATORimagecomparisonClass::calculateAverageColour()

Function Summary
namereturn typedescription
calculateAverageColourvoidcalculate average colour

Function Arguments
nametypedescription
imageWidthint image width
imageHeight int image height
rgbMap uchar* rgb map
avgCol colour* avg col

Function Reference List


Function Trace
locationcurrent function being traced
ATORcomparison.hppcalculateAverageColour
ATORmethod.hppcompareNormalisedSnapshots
ATORmethod.hppATORmethodCompareTestWithTrain
ATORmain.hppATORmethodTest

Trace Diagram (magenta)


Function ATORimagecomparisonClass::compareImagesRGBsmallNoKernel()

Function Summary
namereturn typedescription
compareImagesRGBsmallNoKerneldoublecompare images RGB small no kernel

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
rgbMapTest uchar* rgb map test
rgbMapTrain uchar* rgb map train

Function Reference List


Function Trace
locationcurrent function being traced
ATORcomparison.hppcompareImagesRGBsmallNoKernel
ATORmethod.hppcompareNormalisedSnapshots
ATORmethod.hppATORmethodCompareTestWithTrain
ATORmain.hppATORmethodTest

Trace Diagram (magenta)


Function ATORimagecomparisonClass::compareImagesRGBwithPosDev()

Function Summary
namereturn typedescription
compareImagesRGBwithPosDevdoublecompare images RGB with pos dev

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
rgbMapTest uchar* rgb map test
rgbMapTrain uchar* rgb map train

Function Reference List


Function Trace
locationcurrent function being traced
ATORcomparison.hppcompareImagesRGBwithPosDev
ATORmethod.hppcompareNormalisedSnapshots
ATORmethod.hppATORmethodCompareTestWithTrain
ATORmain.hppATORmethodTest

Trace Diagram (magenta)


Function ATORimagecomparisonClass::checkImageHasContrast()

Function Summary
namereturn typedescription
checkImageHasContrastboolcheck image has contrast

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
rgbMap uchar* rgb map

Function Reference List


Function Trace
locationcurrent function being traced
ATORcomparison.hppcheckImageHasContrast
ATORmethod.hppcompareNormalisedSnapshots
ATORmethod.hppATORmethodCompareTestWithTrain
ATORmain.hppATORmethodTest

Trace Diagram (magenta)


Function ATORimagecomparisonClass::compareImagesRGBwithPosDevAndLocalStarkContAndHueDev()

Function Summary
namereturn typedescription
compareImagesRGBwithPosDevAndLocalStarkContAndHueDevdoublecompare images RGB with pos dev and local stark cont and hue dev

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
rgbMapTest uchar* rgb map test
rgbMapTrain uchar* rgb map train

Function Reference List


Function Trace
locationcurrent function being traced
ATORcomparison.hppcompareImagesRGBwithPosDevAndLocalStarkContAndHueDev
ATORmethod.hppcompareNormalisedSnapshots
ATORmethod.hppATORmethodCompareTestWithTrain
ATORmain.hppATORmethodTest

Trace Diagram (magenta)


Function ATORimagecomparisonClass::compareImagesRGBwithPosDevAndLocalStarkContAndHueDevCalculateAveragesOnly()

Function Summary
namereturn typedescription
compareImagesRGBwithPosDevAndLocalStarkContAndHueDevCalculateAveragesOnlydoublecompare images RGB with pos dev and local stark cont and hue dev calculate averages only

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
rgbMapTest uchar* rgb map test
rgbMapTrain uchar* rgb map train
averageHueDeviationR double* average hue deviation R
averageHueDeviationG double* average hue deviation G
averageHueDeviationB double* average hue deviation B
averageXkernelRelativePositionForLowestErrorMatch double* average xkernel relative position for lowest error match
averageYkernelRelativePositionForLowestErrorMatch double* average ykernel relative position for lowest error match

Function Reference List


Function Trace
locationcurrent function being traced
ATORimagecomparison.hppcompareImagesRGBwithPosDevAndLocalStarkContAndHueDevCalculateAveragesOnly
ATORcomparison.hppcompareImagesRGBwithPosDevAndLocalStarkContAndHueDev
ATORmethod.hppcompareNormalisedSnapshots
ATORmethod.hppATORmethodCompareTestWithTrain
ATORmain.hppATORmethodTest

Trace Diagram (magenta)


Function ATORimagecomparisonClass::compareRGBpixelsForMatchHueOnly()

Function Summary
namereturn typedescription
compareRGBpixelsForMatchHueOnlydoublecompare RGB pixels for match hue only

Function Arguments
nametypedescription
testImagePixelColourcolour* test image pixel colour
trainImagePixelColour colour* train image pixel colour

Function Reference List


Function Trace
locationcurrent function being traced
ATORimagecomparison.hppcompareRGBpixelsForMatchHueOnly
ATORcomparison.hppcompareImagesRGBwithPosDev
ATORmethod.hppcompareNormalisedSnapshots
ATORmethod.hppATORmethodCompareTestWithTrain
ATORmain.hppATORmethodTest

Trace Diagram (magenta)


Function ATORimagecomparisonClass::compareRGBpixelsForMatchLumContrastOnly()

Function Summary
namereturn typedescription
compareRGBpixelsForMatchLumContrastOnlydoublecompare RGB pixels for match lum contrast only

Function Arguments
nametypedescription
testImagePixelColourcolour* test image pixel colour
trainImagePixelColour colour* train image pixel colour

Function Reference List


Function Trace
locationcurrent function being traced
ATORfeatureGeneration.hppcompareRGBpixelsForMatchLumContrastOnly
ATORmethod.hppgenerateFeatureListFromRGBMap
ATORmethod.hppaddCornerFeaturesToFeatureListUsingRGBmap
ATORmethod.hppcreateOrAddPointsToFeaturesList
ATORmethod.hppcreateOrAddToInterpolatedMeshAndFeaturesList
ATORmethod.hppATORmethodTrainOrTest
ATORmain.hppATORmethodTrain
ATORmethod.hppATORmethodTrainOrTest

Trace Diagram (magenta)


Function ATORimagecomparisonClass::calculateHueError()

Function Summary
namereturn typedescription
calculateHueErrorvoidcalculate hue error

Function Arguments
nametypedescription
testImagePixelColourcolour* test image pixel colour
trainImagePixelColour colour* train image pixel colour
hueError double* hue error
nonHueError double* non hue error

Function Reference List
N/A


Function Trace
locationcurrent function being traced
ATORimagecomparison.hppcalculateHueError
ATORfeatureGeneration.hppcompareRGBpixelsForMatchLumContrastOnly
ATORmethod.hppgenerateFeatureListFromRGBMap
ATORmethod.hppaddCornerFeaturesToFeatureListUsingRGBmap
ATORmethod.hppcreateOrAddPointsToFeaturesList
ATORmethod.hppcreateOrAddToInterpolatedMeshAndFeaturesList
ATORmethod.hppATORmethodTrainOrTest
ATORmain.hppATORmethodTrain
ATORmethod.hppATORmethodTrainOrTest
ATORimagecomparison.hppcalculateHueError
ATORimagecomparison.hppcompareRGBpixelsForMatchHueOnly
ATORcomparison.hppcompareImagesRGBwithPosDev
ATORmethod.hppcompareNormalisedSnapshots

Trace Diagram (magenta)


Function ATORimagecomparisonClass::compareRGBpixelsForMatchBAD()

Function Summary
namereturn typedescription
compareRGBpixelsForMatchBADdoublecompare RGB pixels for match BAD

Function Arguments
nametypedescription
testImagePixelColourconst colour* test image pixel colour
trainImagePixelColour const colour* train image pixel colour

Function Reference List


Function Trace
locationcurrent function being traced
ATORimagecomparison.hppcompareRGBpixelsForMatchBAD
ATORcomparison.hppcompareImagesRGBsmallNoKernel
ATORmethod.hppcompareNormalisedSnapshots
ATORmethod.hppATORmethodCompareTestWithTrain
ATORmain.hppATORmethodTest
ATORimagecomparison.hppcompareRGBpixelsForMatchBAD
ATORimagecomparison.hppcompareRGBpixelsForMatchBAD
ATORimagecomparison.hppcompareImagesRGBwithPosDevAndLocalStarkContAndHueDevCalculateAveragesOnly

Trace Diagram (magenta)


Function ATORimagecomparisonClass::calculateHueErrorNormalisedBAD()

Function Summary
namereturn typedescription
calculateHueErrorNormalisedBADdoublecalculate hue error normalised BAD

Function Arguments
nametypedescription
testImagePixelColourconst colour* test image pixel colour
trainImagePixelColour const colour* train image pixel colour
hueError double* hue error
nonHueErrorNormalised double* non hue error normalised

Function Reference List
N/A


Function Trace
locationcurrent function being traced
ATORimagecomparison.hppcalculateHueErrorNormalisedBAD
ATORimagecomparison.hppcompareRGBpixelsForMatchBAD
ATORcomparison.hppcompareImagesRGBsmallNoKernel
ATORmethod.hppcompareNormalisedSnapshots
ATORmethod.hppATORmethodCompareTestWithTrain
ATORmain.hppATORmethodTest
ATORimagecomparison.hppcompareRGBpixelsForMatchBAD
ATORimagecomparison.hppcompareRGBpixelsForMatchBAD
ATORimagecomparison.hppcompareImagesRGBwithPosDevAndLocalStarkContAndHueDevCalculateAveragesOnly

Trace Diagram (magenta)