Software Project Documentation

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

Copyright © 2020, BAI Research. All Rights Reserved.


Software Project Code Structure - Files



Software Project Code Structure - Functions


File ATORmain Documentation

File Name: ATORmain.cpp/.hpp

File Description: ATOR main

File Function List


File Diagram (functions hierarchy)


Function main()

Function Summary
namereturn typedescription
mainintmain

Function Arguments
nametypedescription
argcconst int argc
*argvconst char* *argv

Function Reference List


Function ATORmainClass::printORcommandLineErrorMessage()

Function Summary
namereturn typedescription
printORcommandLineErrorMessagevoidprint OR command line error message

Function Reference List
N/A


File ATORmethod Documentation

File Name: ATORmethod.cpp/.hpp

File Description: ATOR method

File Function List


File Diagram (functions hierarchy)


Function ATORmethodClass::ATORmethodInitialise()

Function Summary
namereturn typedescription
ATORmethodInitialiseboolATOR method initialise

Function Arguments
nametypedescription
imageWidthFacingPolyconst int image width facing poly
imageHeightFacingPoly const int image height facing poly
initialiseTrain const bool initialise train
initialiseTest const bool initialise test
clearTrainTable const bool clear train table
dimension const int dimension
sqlIPaddress const string sql IP address
sqlUsername const string sql username
sqlPassword const string sql password

Function Reference List


Function ATORmethodClass::ATORmethodTrainOrTest()

Function Summary
namereturn typedescription
ATORmethodTrainOrTestboolATOR method train or test

Function Arguments
nametypedescription
dimensionint dimension
numberOfObjects const int number of objects
objectNameArray[] string object name array []
objectDataSource const int object data source
vi RTviewInfo* vi
imageWidthFacingPoly int image width facing poly
imageHeightFacingPoly int image height facing poly
maxNumberOfPolygons const int max number of polygons
numberOfViewIndiciesPerObject const int number of view indicies per object
numberOfViewIndiciesPerObjectWithUniquePolygons int number of view indicies per object with unique polygons
numberOfPolys int* number of polys
trainOrTest const int train or test
numberOfZoomIndicies int number of zoom indicies
viewNumber const int view number
multViewListFileName const string mult view list file name

Function Reference List


Function ATORmethodClass::createOrAddToInterpolatedMeshAndFeaturesList()

Function Summary
namereturn typedescription
createOrAddToInterpolatedMeshAndFeaturesListboolcreate or add to interpolated mesh and features list

Function Arguments
nametypedescription
initialReferenceInSceneFileLDreference* initial reference in scene file
vi RTviewInfo* vi
firstReferenceInInterpolatedMesh LDreference* first reference in interpolated mesh
firstMeshPointInMeshList ATORmeshPoint* first mesh point in mesh list
firstFeatureInList[] ATORfeature first feature in list []
trainOrTest const int train or test
viewIndex const int view index
objectName const string object name
dimension int dimension
objectDataSource const int object data source
numberOfZoomIndicies const int number of zoom indicies
useEdgeZeroCrossingMap const bool use edge zero crossing map

Function Reference List


Function ATORmethodClass::createRGBandPointMap()

Function Summary
namereturn typedescription
createRGBandPointMapboolcreate RGB and point map

Function Arguments
nametypedescription
initialReferenceInSceneFileLDreference* initial reference in scene file
pointMap double* point map
rgbMap uchar* rgb map
depthMap double* depth map
vi RTviewInfo* vi
trainOrTest const int train or test
viewIndex const int view index
objectName const string object name
dimension const int dimension
objectDataSource const int object data source

Function Reference List


Function ATORmethodClass::createOrAddToInterpolatedMeshReferenceListUsingPointAndRGBMap()

Function Summary
namereturn typedescription
createOrAddToInterpolatedMeshReferenceListUsingPointAndRGBMapboolcreate or add to interpolated mesh reference list using point and RGBM ap

Function Arguments
nametypedescription
pointMapdouble* point map
rgbMap uchar* rgb map
firstReferenceInInterpolatedMesh LDreference* first reference in interpolated mesh
vi RTviewInfo* vi
objectName const string object name
trainOrTest const int train or test
dimension const int dimension
viewIndex const int view index

Function Reference List


Function ATORmethodClass::createOrAddPointsToFeaturesList()

Function Summary
namereturn typedescription
createOrAddPointsToFeaturesListboolcreate or add points to features list

Function Arguments
nametypedescription
pointMapdouble* point map
rgbMap uchar* rgb map
depthMap double* depth map
firstFeatureInList[] ATORfeature first feature in list []
vi RTviewInfo* vi
trainOrTest const int train or test
viewIndex const int view index
objectName const string object name
dimension int dimension
numberOfZoomIndicies const int number of zoom indicies
firstMeshPointInMeshList ATORmeshPoint* first mesh point in mesh list
meshPointArray[] constEffective ATORmeshPoint* mesh point array []
useEdgeZeroCrossingMap const bool use edge zero crossing map

Function Reference List


Function ATORmethodClass::createInterpolatedMeshReferenceListUsingMeshList()

Function Summary
namereturn typedescription
createInterpolatedMeshReferenceListUsingMeshListboolcreate interpolated mesh reference list using mesh list

Function Arguments
nametypedescription
firstMeshPointInMeshListATORmeshPoint* first mesh point in mesh list
firstReferenceInInterpolatedMesh LDreference* first reference in interpolated mesh
vi RTviewInfo* vi
objectName const string object name
trainOrTest const int train or test
dimension const int dimension

Function Reference List


Function ATORmethodClass::convertMeshPointToReferences3DOD()

Function Summary
namereturn typedescription
convertMeshPointToReferences3DODLDreference*convert mesh point to references 3DOD

Function Arguments
nametypedescription
currentMeshPointInMeshListATORmeshPoint* current mesh point in mesh list
firstNewReferenceInInterpolatedMesh LDreference* first new reference in interpolated mesh

Function Reference List


Function ATORmethodClass::convertMeshPointToReferences2DOD()

Function Summary
namereturn typedescription
convertMeshPointToReferences2DODLDreference*convert mesh point to references 2DOD

Function Arguments
nametypedescription
currentMeshPointInMeshListconst ATORmeshPoint* current mesh point in mesh list
firstNewReferenceInInterpolatedMesh LDreference* first new reference in interpolated mesh

Function Reference List


Function ATORmethodClass::addCornerFeaturesToFeatureListUsingRGBmap()

Function Summary
namereturn typedescription
addCornerFeaturesToFeatureListUsingRGBmapbooladd corner features to feature list using RGB map

Function Arguments
nametypedescription
viRTviewInfo* vi
rgbMap uchar* rgb map
firstFeatureInList ATORfeature* first feature in list
trainOrTest const int train or test
mapFileName const string map file name
sensitivity const double sensitivity
dimension const int dimension
pointMap double* point map
depthMap const double* depth map
zoom int zoom
interpixelRGBmapType const bool interpixel RGB map type

Function Reference List


Function ATORmethodClass::ATORmethodCompareTestWithTrain()

Function Summary
namereturn typedescription
ATORmethodCompareTestWithTrainboolATOR method compare test with train

Function Arguments
nametypedescription
dimensionconst int dimension
numberOfTestObjects const int number of test objects
testObjectNameArray[] const string test object name array []
imageWidthFacingPoly int image width facing poly
imageHeightFacingPoly int image height facing poly
numberOfTestPolys const int* number of test polys
numberOfTestViewIndiciesPerObjectWithUniquePolygons const int number of test view indicies per object with unique polygons
numberOfTestZoomIndicies const int number of test zoom indicies
trainOrTest const int train or test
testViewNumber const int test view number

Function Reference List


Function ATORmethodClass::ATORmethodTrain()

Function Summary
namereturn typedescription
ATORmethodTrainboolATOR method train

Function Arguments
nametypedescription
dimensionint dimension
numberOfTrainObjects const int number of train objects
trainObjectNameArray[] string train object name array []
numberOfTrainPolys int* number of train polys
objectDataSource const int object data source
viTrain RTviewInfo* vi train
imageWidthFacingPoly int image width facing poly
imageHeightFacingPoly int image height facing poly
maxNumberOfPolygonsTrain const int max number of polygons train
numberOfTrainViewIndiciesPerObject const int number of train view indicies per object
numberOfTrainViewIndiciesPerObjectWithUniquePolygons int number of train view indicies per object with unique polygons
numberOfTrainZoomIndicies int number of train zoom indicies
trainOrTest const int train or test
sqlIPaddress const string sql IP address
sqlUsername const string sql username
sqlPassword const string sql password
clearTrainTable const bool clear train table
viewNumber const int view number
multViewListFileName const string mult view list file name

Function Reference List


Function ATORmethodClass::ATORmethodTest()

Function Summary
namereturn typedescription
ATORmethodTestboolATOR method test

Function Arguments
nametypedescription
dimensionint dimension
numberOfTestObjects const int number of test objects
testObjectNameArray[] string test object name array []
numberOfTestPolys int* number of test polys
objectDataSource const int object data source
viTest RTviewInfo* vi test
imageWidthFacingPoly int image width facing poly
imageHeightFacingPoly int image height facing poly
maxNumberOfPolygonsTest const int max number of polygons test
numberOfTestViewIndiciesPerObject const int number of test view indicies per object
numberOfTestViewIndiciesPerObjectWithUniquePolygons int number of test view indicies per object with unique polygons
numberOfTestZoomIndicies int number of test zoom indicies
trainOrTest const int train or test
sqlIPaddress const string sql IP address
sqlUsername const string sql username
sqlPassword const string sql password
clearTrainTable const bool clear train table
viewNumber const int view number
multViewListFileName const string mult view list file name

Function Reference List


Function ATORmethodClass::ATORmethodExit()

Function Summary
namereturn typedescription
ATORmethodExitboolATOR method exit

Function Reference List


Function ATORmethodClass::compareNormalisedSnapshotExperienceListWithNeuralNetwork()

Function Summary
namereturn typedescription
compareNormalisedSnapshotExperienceListWithNeuralNetworkdoublecompare normalised snapshot experience list with neural network

Function Arguments
nametypedescription
firstExperienceInTestListANNexperience* first experience in test list
firstInputNeuronInNetwork const ANNneuronContainer* first input neuron in network
firstOutputNeuronInNetwork const ANNneuronContainer* first output neuron in network
numberOfInputNeurons const int number of input neurons
numberOfOutputNeurons const int number of output neurons
numberOfTrainPolySides const int number of train poly sides

Function Reference List
N/A


Function ATORmethodClass::generateNormalisedSnapshotsUsingPolyList()

Function Summary
namereturn typedescription
generateNormalisedSnapshotsUsingPolyListboolgenerate normalised snapshots using poly list

Function Arguments
nametypedescription
firstReferenceInInterpolatedMeshLDreference* first reference in interpolated mesh
firstPolygonInList[] ATORpolygon first polygon in list []
imageWidthFacingPoly int image width facing poly
imageHeightFacingPoly int image height facing poly
maxNumberOfPolygonsTrainOrTest const int max number of polygons train or test
numberOfTrainOrTestPolys[] int number of train or test polys []
trainOrTest const int train or test
viewIndex const int view index
objectName const string object name
dimension const int dimension
firstFeatureInList ATORfeature* first feature in list
numberOfZoomIndicies const int number of zoom indicies

Function Reference List


Function ATORmethodClass::setNoiseArraysMethod2DOD()

Function Summary
namereturn typedescription
setNoiseArraysMethod2DODvoidset noise arrays method 2DOD

Function Reference List
N/A


Function ATORmethodClass::setNoiseArraysMethod3DOD()

Function Summary
namereturn typedescription
setNoiseArraysMethod3DODvoidset noise arrays method 3DOD

Function Reference List
N/A


Function ATORmethodClass::createViFromMultiViewList()

Function Summary
namereturn typedescription
createViFromMultiViewListintcreate vi from multi view list

Function Arguments
nametypedescription
viRTviewInfo* vi
fileName const string file name
multiViewViewIndex const int multi view view index
dimension const int dimension

Function Reference List


File SHAREDvars Documentation

File Name: SHAREDvars.cpp/.hpp

File Description: SHARED vars

File Function List


File Diagram (functions hierarchy)


Function SHAREDvarsClass::getTimeAsLong()

Function Summary
namereturn typedescription
getTimeAsLongint64_tget time as long

Function Reference List
N/A


Function SHAREDvarsClass::compareDoubles()

Function Summary
namereturn typedescription
compareDoublesboolcompare doubles

Function Arguments
nametypedescription
aconst double a
b const double b

Function Reference List
N/A


Function SHAREDvarsClass::compareDoublesArbitraryError()

Function Summary
namereturn typedescription
compareDoublesArbitraryErrorboolcompare doubles arbitrary error

Function Arguments
nametypedescription
aconst double a
b const double b
error const double error

Function Reference List
N/A


Function SHAREDvarsClass::maxInt()

Function Summary
namereturn typedescription
maxIntintmax int

Function Arguments
nametypedescription
aint a
b const int b

Function Reference List
N/A


Function SHAREDvarsClass::minInt()

Function Summary
namereturn typedescription
minIntintmin int

Function Arguments
nametypedescription
aint a
b const int b

Function Reference List
N/A


Function SHAREDvarsClass::minDouble()

Function Summary
namereturn typedescription
minDoubledoublemin double

Function Arguments
nametypedescription
adouble a
b const double b

Function Reference List
N/A


Function SHAREDvarsClass::maxDouble()

Function Summary
namereturn typedescription
maxDoubledoublemax double

Function Arguments
nametypedescription
adouble a
b const double b

Function Reference List
N/A


Function SHAREDvarsClass::absDouble()

Function Summary
namereturn typedescription
absDoubledoubleabs double

Function Arguments
nametypedescription
valconst double val

Function Reference List
N/A


Function SHAREDvarsClass::argumentExists()

Function Summary
namereturn typedescription
argumentExistsboolargument exists

Function Arguments
nametypedescription
argcconst int argc
argv const char** argv
keystr const string keystr

Function Reference List
N/A


Function SHAREDvarsClass::getFloatArgument()

Function Summary
namereturn typedescription
getFloatArgumentfloatget float argument

Function Arguments
nametypedescription
argcconst int argc
argv const char** argv
keystr const string keystr

Function Reference List
N/A


Function SHAREDvarsClass::getStringArgument()

Function Summary
namereturn typedescription
getStringArgumentstringget string argument

Function Arguments
nametypedescription
argcconst int argc
argv const char** argv
keystr const string keystr

Function Reference List
N/A


Function SHAREDvarsClass::getCurrentDirectory()

Function Summary
namereturn typedescription
getCurrentDirectorystringget current directory

Function Reference List
N/A


Function SHAREDvarsClass::setCurrentDirectory()

Function Summary
namereturn typedescription
setCurrentDirectoryvoidset current directory

Function Arguments
nametypedescription
folderconst string* folder

Function Reference List
N/A


Function SHAREDvarsClass::createDirectory()

Function Summary
namereturn typedescription
createDirectoryvoidcreate directory

Function Arguments
nametypedescription
folderconst string* folder

Function Reference List
N/A


Function SHAREDvarsClass::directoryExists()

Function Summary
namereturn typedescription
directoryExistsbooldirectory exists

Function Arguments
nametypedescription
folderconst string* folder

Function Reference List
N/A


Function SHAREDvarsClass::checkIfFolderExistsAndIfNotMakeAndSetAsCurrent()

Function Summary
namereturn typedescription
checkIfFolderExistsAndIfNotMakeAndSetAsCurrentboolcheck if folder exists and if not make and set as current

Function Arguments
nametypedescription
folderNameconst string* folder name

Function Reference List


Function SHAREDvarsClass::convertDoubleToString()

Function Summary
namereturn typedescription
convertDoubleToStringstringconvert double to string

Function Arguments
nametypedescription
numberconst double number
format const string format

Function Reference List


Function SHAREDvarsClass::convertIntToString()

Function Summary
namereturn typedescription
convertIntToStringstringconvert int to string

Function Arguments
nametypedescription
numberconst int number

Function Reference List


Function SHAREDvarsClass::convertUnsignedIntToString()

Function Summary
namereturn typedescription
convertUnsignedIntToStringstringconvert unsigned int to string

Function Arguments
nametypedescription
numberconst int number

Function Reference List


Function SHAREDvarsClass::convertLongToString()

Function Summary
namereturn typedescription
convertLongToStringstringconvert long to string

Function Arguments
nametypedescription
numberconst int64_t number

Function Reference List


Function SHAREDvarsClass::convertStringToBool()

Function Summary
namereturn typedescription
convertStringToBoolboolconvert string to bool

Function Arguments
nametypedescription
numberstring number

Function Reference List
N/A


Function SHAREDvarsClass::convertStringToLong()

Function Summary
namereturn typedescription
convertStringToLongint64_tconvert string to long

Function Arguments
nametypedescription
numberconst string number

Function Reference List
N/A


Function SHAREDvarsClass::convertStringToDouble()

Function Summary
namereturn typedescription
convertStringToDoubledoubleconvert string to double

Function Arguments
nametypedescription
numberconst string number

Function Reference List
N/A


Function SHAREDvarsClass::writeStringToFileObject()

Function Summary
namereturn typedescription
writeStringToFileObjectvoidwrite string to file object

Function Arguments
nametypedescription
sstring s
writeFileObject ofstream* write file object

Function Reference List
N/A


Function SHAREDvarsClass::sprintfSafeDouble()

Function Summary
namereturn typedescription
sprintfSafeDoublevoidsprintf safe double

Function Arguments
nametypedescription
stringCharStarchar* string char star
type const char* type
number double number

Function Reference List
N/A


Function SHAREDvarsClass::sprintfSafeInt()

Function Summary
namereturn typedescription
sprintfSafeIntvoidsprintf safe int

Function Arguments
nametypedescription
stringCharStarchar* string char star
type const char* type
number int number

Function Reference List
N/A


Function SHAREDvarsClass::sprintfSafeLong()

Function Summary
namereturn typedescription
sprintfSafeLongvoidsprintf safe long

Function Arguments
nametypedescription
stringCharStarchar* string char star
type const char* type
number int64_t number

Function Reference List
N/A


Function SHAREDvarsClass::printTime()

Function Summary
namereturn typedescription
printTimevoidprint time

Function Arguments
nametypedescription
startStringconst string start string
endString const string end string

Function Reference List
N/A


File ATORpolygonList Documentation

File Name: ATORpolygonList.cpp/.hpp

File Description: ATOR polygon list

File Function List


File Diagram (functions hierarchy)


Class ATORobjectReferenceList

Class Data
nametypedescription
objectNumberint64_tobject number
objectNamestringobject name
numMatchingSnapshotsintnum matching snapshots
nextATORobjectReferenceList*next

Class ATORsnapshotIDreferenceList

Class Data
nametypedescription
referenceIDint64_treference ID
nextATORsnapshotIDreferenceList*next
previousATORsnapshotIDreferenceList*previous

Class ATORfeature

Class Data
nametypedescription
numberOfFeaturePixelsUsedToGenerateFeatureintnumber of feature pixels used to generate feature
xViewportintxViewport
yViewportintyViewport
magnitudedoublemagnitude
pointvecpoint
pointNonWorldCoordvecpoint non world coord
objectNamestringobject name
trainOrTestinttrain or test
viewIndexintview index
zoomIndexintzoom index
polyIndexintpoly index
sideIndexintside index
OTpointIndexintOT point index
minWidthAndHeightOfOrigOTdoublemin width and height of orig OT
pointTransformedvecpoint transformed
matchFoundboolmatch found
dctCoeff[ATOR_IMAGE_COMPARISON_PATTERN_RECOGNITION_FOURIER_TRANSFORM_BINNING_NUM_DCT_COEFFICIENT_BINNING_DIMENSIONS_MAX]schardct coeff [ATOR_IMAGE_COMPARISON_PATTERN_RECOGNITION_FOURIER_TRANSFORM_BINNING_NUM_DCT_COEFFICIENT_BINNING_DIMENSIONS_MAX]
dctCoeffArrayBinneduint64_tdct coeff array binned
avgColcolouravg col
snapshotMapsText[ATOR_IMAGE_COMPARISON_SQL_ADD_ALL_MAPS_TO_DATABASE_MAX_DATA_LENGTH]charsnapshot maps text [ATOR_IMAGE_COMPARISON_SQL_ADD_ALL_MAPS_TO_DATABASE_MAX_DATA_LENGTH]
snapshotMapsTextLengthintsnapshot maps text length
lastFilledFeatureInListboollast filled feature in list
nextATORfeature*next

Class ATORpolygon

Class Data
nametypedescription
point1vecpoint 1
point2vecpoint 2
point3vecpoint 3
nextATORpolygon*next
firstFeatureInNearestFeatureListATORfeature*first feature in nearest feature list
point1Transformedvecpoint 1T ransformed
point2Transformedvecpoint 2T ransformed
point3Transformedvecpoint 3T ransformed

Class ATORfeatureContainer

Class Data
nametypedescription
numVotesintnum votes
errordoubleerror
firstFeatureInFeatureListATORfeature*first feature in feature list
nextATORfeatureContainer*next

Class ATORmeshPoint

Class Data
nametypedescription
pointvecpoint
xIntintxInt
yIntintyInt
colcolourcol
depthdoubledepth
luminositydoubleluminosity
luminosityContrastdoubleluminosity contrast
interpixelMeshPointATORmeshPoint*interpixel mesh point
interpixelMeshPointFilledboolinterpixel mesh point filled
adjacentMeshPoint[9]ATORmeshPoint*adjacent mesh point [9]
adjacentMeshPointFilled[9]booladjacent mesh point filled [9]
meshPointNormalFilledboolmesh point normal filled
meshPointNormals[4]vecmesh point normals [4]
meshPointNormalvecmesh point normal
meshPointNormalContrastdoublemesh point normal contrast
alreadyProcessedintalready processed
hasBeenProcessedInGenerationOfOuterBoundaryboolhas been processed in generation of outer boundary
edgebooledge
zeroCrossingValueXdoublezero crossing value X
zeroCrossingValueYdoublezero crossing value Y
alphadoublealpha
quadraticFitPointvecquadratic fit point
quadraticFitDepthdoublequadratic fit depth
nextATORmeshPoint*next

Class ATORpixelContiguous

Class Data
nametypedescription
pathAlreadyCrawledboolpath already crawled
finalPathAlreadyCrawledboolfinal path already crawled
xIntintxInt
yIntintyInt
pointvecpoint
pointNonWorldCoordvecpoint non world coord
meshPointATORmeshPoint*mesh point
next[9]ATORpixelContiguous*next [9]
previousATORpixelContiguous*previous
readyToDeleteboolready to delete

Function ATORpolygonListClass::findMeshPointIntInMesh()

Function Summary
namereturn typedescription
findMeshPointIntInMeshATORmeshPoint*find mesh point int in mesh

Function Arguments
nametypedescription
firstMeshPointInMeshListATORmeshPoint* first mesh point in mesh list
point const vec* point
hasFoundMeshPoint bool* has found mesh point
meshZoneLimit const int mesh zone limit

Function Reference List


Function ATORpolygonListClass::calculateMeshPointNormal()

Function Summary
namereturn typedescription
calculateMeshPointNormalvoidcalculate mesh point normal

Function Arguments
nametypedescription
meshPointATORmeshPoint* mesh point

Function Reference List


Function ATORpolygonListClass::calculateMeshPointNormalContrast()

Function Summary
namereturn typedescription
calculateMeshPointNormalContrastvoidcalculate mesh point normal contrast

Function Arguments
nametypedescription
meshPointATORmeshPoint* mesh point

Function Reference List


Function ATORpolygonListClass::calculateMeshPointInterpixelNormal()

Function Summary
namereturn typedescription
calculateMeshPointInterpixelNormalvoidcalculate mesh point interpixel normal

Function Arguments
nametypedescription
meshPointATORmeshPoint* mesh point

Function Reference List


Function ATORpolygonListClass::calculateMeshPointInterpixelNormalContrast()

Function Summary
namereturn typedescription
calculateMeshPointInterpixelNormalContrastvoidcalculate mesh point interpixel normal contrast

Function Arguments
nametypedescription
meshPointATORmeshPoint* mesh point

Function Reference List


Function ATORpolygonListClass::calculateMeshPointInterpixelLuminosityContrast()

Function Summary
namereturn typedescription
calculateMeshPointInterpixelLuminosityContrastvoidcalculate mesh point interpixel luminosity contrast

Function Arguments
nametypedescription
meshPointATORmeshPoint* mesh point

Function Reference List


Function ATORpolygonListClass::calculateMeshPointInterpixelDepth()

Function Summary
namereturn typedescription
calculateMeshPointInterpixelDepthvoidcalculate mesh point interpixel depth

Function Arguments
nametypedescription
meshPointATORmeshPoint* mesh point

Function Reference List
N/A


Function ATORpolygonListClass::calculateMeshPointInterpixelDepthWithForegroundDepthCheck()

Function Summary
namereturn typedescription
calculateMeshPointInterpixelDepthWithForegroundDepthCheckvoidcalculate mesh point interpixel depth with foreground depth check

Function Arguments
nametypedescription
meshPointATORmeshPoint* mesh point

Function Reference List
N/A


Function ATORpolygonListClass::calculateMeshPointLuminosityContrast()

Function Summary
namereturn typedescription
calculateMeshPointLuminosityContrastvoidcalculate mesh point luminosity contrast

Function Arguments
nametypedescription
meshPointATORmeshPoint* mesh point

Function Reference List


File SHAREDvector Documentation

File Name: SHAREDvector.cpp/.hpp

File Description: SHARED vector

File Function List


File Diagram (functions hierarchy)


Function SHAREDvectorClass::initialiseVector()

Function Summary
namereturn typedescription
initialiseVectorvoidinitialise vector

Function Arguments
nametypedescription
vectvec* vect

Function Reference List
N/A


Function SHAREDvectorClass::calculateNormalOfTri()

Function Summary
namereturn typedescription
calculateNormalOfTrivoidcalculate normal of tri

Function Arguments
nametypedescription
pt1vec* pt 1
pt2 vec* pt 2
pt3 vec* pt 3
normal vec* normal

Function Reference List


Function SHAREDvectorClass::calculateRotationVectorFromDeformationMatrix()

Function Summary
namereturn typedescription
calculateRotationVectorFromDeformationMatrixvoidcalculate rotation vector from deformation matrix

Function Arguments
nametypedescription
deformationMatrixmat* deformation matrix
rotationVector vec* rotation vector

Function Reference List
N/A


Function SHAREDvectorClass::generateLookAtRotationMatrix()

Function Summary
namereturn typedescription
generateLookAtRotationMatrixvoidgenerate look at rotation matrix

Function Arguments
nametypedescription
atvec* at
eye vec* eye
up vec* up
rotationMatrix mat* rotation matrix

Function Reference List


Function SHAREDvectorClass::transposeMatrix()

Function Summary
namereturn typedescription
transposeMatrixvoidtranspose matrix

Function Arguments
nametypedescription
matxmat* matx

Function Reference List
N/A


Function SHAREDvectorClass::calculateInteriorAngleOfAPolygonVertex()

Function Summary
namereturn typedescription
calculateInteriorAngleOfAPolygonVertexdoublecalculate interior angle of AP olygon vertex

Function Arguments
nametypedescription
pt1Centrevec* pt 1C entre
pt2 vec* pt 2
pt3 vec* pt 3

Function Reference List


Function SHAREDvectorClass::calculateAreaOfTriangle()

Function Summary
namereturn typedescription
calculateAreaOfTriangledoublecalculate area of triangle

Function Arguments
nametypedescription
pt1const vec* pt 1
pt2 const vec* pt 2
pt3 const vec* pt 3

Function Reference List


Function SHAREDvectorClass::calculateDeterminant3By3()

Function Summary
namereturn typedescription
calculateDeterminant3By3doublecalculate determinant 3B y 3

Function Arguments
nametypedescription
matrixconst mat* matrix

Function Reference List
N/A


Function SHAREDvectorClass::absDouble2()

Function Summary
namereturn typedescription
absDouble2doubleabs double 2

Function Arguments
nametypedescription
valconst double val

Function Reference List
N/A


Function SHAREDvectorClass::createRotationMatrix2D()

Function Summary
namereturn typedescription
createRotationMatrix2Dvoidcreate rotation matrix 2D

Function Arguments
nametypedescription
matrixmat* matrix
rotation double rotation

Function Reference List
N/A


Function SHAREDvectorClass::createXAxisShearMatrix2D()

Function Summary
namereturn typedescription
createXAxisShearMatrix2Dvoidcreate XA xis shear matrix 2D

Function Arguments
nametypedescription
matrixmat* matrix
shear double shear

Function Reference List
N/A


Function SHAREDvectorClass::calculateAngleBetweenVectors2D()

Function Summary
namereturn typedescription
calculateAngleBetweenVectors2Ddoublecalculate angle between vectors 2D

Function Arguments
nametypedescription
vect1const vec* vect 1
vect2 const vec* vect 2

Function Reference List


Function SHAREDvectorClass::createScaleMatrix2D()

Function Summary
namereturn typedescription
createScaleMatrix2Dvoidcreate scale matrix 2D

Function Arguments
nametypedescription
matrixmat* matrix
scaleFactor double scale factor

Function Reference List
N/A


Function SHAREDvectorClass::createYAxisScaleMatrix2D()

Function Summary
namereturn typedescription
createYAxisScaleMatrix2Dvoidcreate YA xis scale matrix 2D

Function Arguments
nametypedescription
matrixmat* matrix
scaleFactor double scale factor

Function Reference List
N/A


Function SHAREDvectorClass::calculateMidPointBetweenTwoPoints()

Function Summary
namereturn typedescription
calculateMidPointBetweenTwoPointsvoidcalculate mid point between two points

Function Arguments
nametypedescription
pt1vec* pt 1
pt2 vec* pt 2
midPoint vec* mid point

Function Reference List


Function SHAREDvectorClass::calculateMidDiffBetweenTwoPoints()

Function Summary
namereturn typedescription
calculateMidDiffBetweenTwoPointsvoidcalculate mid diff between two points

Function Arguments
nametypedescription
pt1vec* pt 1
pt2 vec* pt 2
midDiff vec* mid diff

Function Reference List
N/A


Function SHAREDvectorClass::calculateNormal()

Function Summary
namereturn typedescription
calculateNormalvoidcalculate normal

Function Arguments
nametypedescription
pt1vec* pt 1
pt2 vec* pt 2
normal vec* normal

Function Reference List


Function SHAREDvectorClass::subtractVectorsRT()

Function Summary
namereturn typedescription
subtractVectorsRTvoidsubtract vectors RT

Function Arguments
nametypedescription
vect1const vec* vect 1
vect2 const vec* vect 2
vect vec* vect

Function Reference List
N/A


Function SHAREDvectorClass::addVectorsRT()

Function Summary
namereturn typedescription
addVectorsRTvoidadd vectors RT

Function Arguments
nametypedescription
vect1const vec* vect 1
vect2 const vec* vect 2
vect vec* vect

Function Reference List
N/A


Function SHAREDvectorClass::multiplyVectorByScalarRT()

Function Summary
namereturn typedescription
multiplyVectorByScalarRTvoidmultiply vector by scalar RT

Function Arguments
nametypedescription
vect1const vec* vect 1
multiplyer const double multiplyer
vect vec* vect

Function Reference List
N/A


Function SHAREDvectorClass::divideVectorByScalarRT()

Function Summary
namereturn typedescription
divideVectorByScalarRTvoiddivide vector by scalar RT

Function Arguments
nametypedescription
vect1const vec* vect 1
divisor const double divisor
vect vec* vect

Function Reference List
N/A


Function SHAREDvectorClass::copyVectorRT()

Function Summary
namereturn typedescription
copyVectorRTvoidcopy vector RT

Function Arguments
nametypedescription
vecNewvec* vec new
vecToCopy const vec* vec to copy

Function Reference List
N/A


Function SHAREDvectorClass::normaliseVectorRT()

Function Summary
namereturn typedescription
normaliseVectorRTvoidnormalise vector RT

Function Arguments
nametypedescription
vect1vec* vect 1
vect vec* vect

Function Reference List


Function SHAREDvectorClass::normaliseVector()

Function Summary
namereturn typedescription
normaliseVectorvoidnormalise vector

Function Arguments
nametypedescription
vect1vec* vect 1

Function Reference List


Function SHAREDvectorClass::negativeVector()

Function Summary
namereturn typedescription
negativeVectorvoidnegative vector

Function Arguments
nametypedescription
vect1vec* vect 1
vect vec* vect

Function Reference List
N/A


Function SHAREDvectorClass::dotProduct()

Function Summary
namereturn typedescription
dotProductdoubledot product

Function Arguments
nametypedescription
vect1const vec* vect 1
vect2 const vec* vect 2

Function Reference List
N/A


Function SHAREDvectorClass::crossProduct()

Function Summary
namereturn typedescription
crossProductvoidcross product

Function Arguments
nametypedescription
vect1vec* vect 1
vect2 vec* vect 2
vect vec* vect

Function Reference List
N/A


Function SHAREDvectorClass::makeMatrix()

Function Summary
namereturn typedescription
makeMatrixvoidmake matrix

Function Arguments
nametypedescription
vect1vec* vect 1
vect2 vec* vect 2
vect3 vec* vect 3
matx mat* matx

Function Reference List
N/A


Function SHAREDvectorClass::multMatrixByVector()

Function Summary
namereturn typedescription
multMatrixByVectorvoidmult matrix by vector

Function Arguments
nametypedescription
matxmat* matx
vect1 vec* vect 1
vect vec* vect

Function Reference List
N/A


Function SHAREDvectorClass::createVector()

Function Summary
namereturn typedescription
createVectorvoidcreate vector

Function Arguments
nametypedescription
vecvec* vec

Function Reference List
N/A


Function SHAREDvectorClass::createIdentityMatrixRT()

Function Summary
namereturn typedescription
createIdentityMatrixRTvoidcreate identity matrix RT

Function Arguments
nametypedescription
matxmat* matx

Function Reference List
N/A


Function SHAREDvectorClass::findMagnitudeOfVector()

Function Summary
namereturn typedescription
findMagnitudeOfVectordoublefind magnitude of vector

Function Arguments
nametypedescription
vect1const vec* vect 1

Function Reference List
N/A


Function SHAREDvectorClass::compareVectors()

Function Summary
namereturn typedescription
compareVectorsboolcompare vectors

Function Arguments
nametypedescription
vecAconst vec* vec A
vecB const vec* vec B

Function Reference List


Function SHAREDvectorClass::compareVectorsArbitraryError()

Function Summary
namereturn typedescription
compareVectorsArbitraryErrorboolcompare vectors arbitrary error

Function Arguments
nametypedescription
vecAconst vec* vec A
vecB const vec* vec B
error const double error

Function Reference List


Function SHAREDvectorClass::copyVectors()

Function Summary
namereturn typedescription
copyVectorsvoidcopy vectors

Function Arguments
nametypedescription
vecNewvec* vec new
vecToCopy const vec* vec to copy

Function Reference List
N/A


Function SHAREDvectorClass::copyMatricies()

Function Summary
namereturn typedescription
copyMatriciesvoidcopy matricies

Function Arguments
nametypedescription
matNewmat* mat new
matToCopy const mat* mat to copy

Function Reference List


Function SHAREDvectorClass::multiplyVectorByMatrix()

Function Summary
namereturn typedescription
multiplyVectorByMatrixvoidmultiply vector by matrix

Function Arguments
nametypedescription
vecNewvec* vec new
vecToMultiply vec* vec to multiply
matrix mat* matrix

Function Reference List
N/A


Function SHAREDvectorClass::multiplyMatricies()

Function Summary
namereturn typedescription
multiplyMatriciesvoidmultiply matricies

Function Arguments
nametypedescription
matNewmat* mat new
mat1 mat* mat 1
mat2 mat* mat 2

Function Reference List
N/A


Function SHAREDvectorClass::subtractVectors()

Function Summary
namereturn typedescription
subtractVectorsvoidsubtract vectors

Function Arguments
nametypedescription
vecNewvec* vec new
a vec* a
b vec* b

Function Reference List
N/A


Function SHAREDvectorClass::multiplyVectorByScalar()

Function Summary
namereturn typedescription
multiplyVectorByScalarvoidmultiply vector by scalar

Function Arguments
nametypedescription
vecvec* vec
scalar double scalar

Function Reference List
N/A


Function SHAREDvectorClass::calculateTheDistanceBetweenTwoPointsXYOnly()

Function Summary
namereturn typedescription
calculateTheDistanceBetweenTwoPointsXYOnlydoublecalculate the distance between two points XYO nly

Function Arguments
nametypedescription
positionOfUnit1const vec* position of unit 1
positionOfUnit2 const vec* position of unit 2

Function Reference List


Function SHAREDvectorClass::calculateTheDistanceBetweenTwoPoints()

Function Summary
namereturn typedescription
calculateTheDistanceBetweenTwoPointsdoublecalculate the distance between two points

Function Arguments
nametypedescription
positionOfUnit1const vec* position of unit 1
positionOfUnit2 const vec* position of unit 2

Function Reference List


Function SHAREDvectorClass::calculateTheDistanceBetweenTwoPoints()

Function Summary
namereturn typedescription
calculateTheDistanceBetweenTwoPointsdoublecalculate the distance between two points

Function Arguments
nametypedescription
positionXOfUnit1const double position XO f unit 1
positionXOfUnit2 const double position XO f unit 2
positionYOfUnit1 const double position YO f unit 1
positionYOfUnit2 const double position YO f unit 2
positionZOfUnit1 const double position ZO f unit 1
positionZOfUnit2 const double position ZO f unit 2

Function Reference List
N/A


Function SHAREDvectorClass::copyMatrixTwoIntoMatrixOne()

Function Summary
namereturn typedescription
copyMatrixTwoIntoMatrixOnevoidcopy matrix two into matrix one

Function Arguments
nametypedescription
mat1mat* mat 1
mat2 mat* mat 2

Function Reference List
N/A


Function SHAREDvectorClass::find2DintersectionPoint()

Function Summary
namereturn typedescription
find2DintersectionPointvoidfind 2D intersection point

Function Arguments
nametypedescription
axdouble ax
ay double ay
bx double bx
by double by
cx const double cx
cy const double cy
dx const double dx
dy const double dy
intersectionX double* intersection X
intersectionY double* intersection Y
interceptionFound bool* interception found
interceptionPointFound bool* interception point found

Function Reference List


Function SHAREDvectorClass::calcDistanceBetweenTwoPoints2D()

Function Summary
namereturn typedescription
calcDistanceBetweenTwoPoints2Ddoublecalc distance between two points 2D

Function Arguments
nametypedescription
x1const double x1
y1 const double y1
x2 const double x2
y2 const double y2

Function Reference List
N/A


Function SHAREDvectorClass::solve2DlineEquationWithTwoPoints()

Function Summary
namereturn typedescription
solve2DlineEquationWithTwoPointsboolsolve 2D line equation with two points

Function Arguments
nametypedescription
x1double x1
y1 double y1
x2 const double x2
y2 const double y2
m double* m
i double* i

Function Reference List
N/A


Function SHAREDvectorClass::find2DintersectionPointOfTwoLines()

Function Summary
namereturn typedescription
find2DintersectionPointOfTwoLinesboolfind 2D intersection point of two lines

Function Arguments
nametypedescription
m1double m1
i1 double i1
m2 const double m2
i2 const double i2
xIntersection double* xIntersection
yIntersection double* yIntersection

Function Reference List
N/A


Function SHAREDvectorClass::twoPointsAreTheSame2D()

Function Summary
namereturn typedescription
twoPointsAreTheSame2Dbooltwo points are the same 2D

Function Arguments
nametypedescription
x1const double x1
y1 const double y1
x2 const double x2
y2 const double y2

Function Reference List


Function SHAREDvectorClass::determineIfPointLiesOnAKnownLine2D()

Function Summary
namereturn typedescription
determineIfPointLiesOnAKnownLine2Dbooldetermine if point lies on AK nown line 2D

Function Arguments
nametypedescription
m1const double m1
i1 const double i1
x3 const double x3
y3 const double y3

Function Reference List


Function SHAREDvectorClass::compareDoublesRelaxed()

Function Summary
namereturn typedescription
compareDoublesRelaxedboolcompare doubles relaxed

Function Arguments
nametypedescription
aconst double a
b const double b

Function Reference List
N/A


Function SHAREDvectorClass::determineIfPointLiesOnAKnownLine2Drelaxed()

Function Summary
namereturn typedescription
determineIfPointLiesOnAKnownLine2Drelaxedbooldetermine if point lies on AK nown line 2D relaxed

Function Arguments
nametypedescription
m1const double m1
i1 const double i1
x3 const double x3
y3 const double y3

Function Reference List


Function SHAREDvectorClass::twoPointsAreTheSame2Drelaxed()

Function Summary
namereturn typedescription
twoPointsAreTheSame2Drelaxedbooltwo points are the same 2D relaxed

Function Arguments
nametypedescription
x1const double x1
y1 const double y1
x2 const double x2
y2 const double y2

Function Reference List


File ATORmethod3DOD Documentation

File Name: ATORmethod3DOD.cpp/.hpp

File Description: ATOR method 3DOD

File Function List


File Diagram (functions hierarchy)


Function ATORmethod3DODClass::transformObjectData3DOD()

Function Summary
namereturn typedescription
transformObjectData3DODvoidtransform object data 3DOD

Function Arguments
nametypedescription
firstReferenceInInterpolated3DRGBMapLDreference* first reference in interpolated 3DRGBM ap
currentPolygonInList ATORpolygon* current polygon in list
side const int side
first const bool first
firstFeatureInList ATORfeature* first feature in list

Function Reference List


Function ATORmethod3DODClass::calculateEyePositionAndOrientation3DOD()

Function Summary
namereturn typedescription
calculateEyePositionAndOrientation3DODvoidcalculate eye position and orientation 3DOD

Function Arguments
nametypedescription
eyeFacingPolyvec* eye facing poly
viewAtFacingPoly vec* view at facing poly
viewUpFacingPoly vec* view up facing poly
viewPortWidthHeightDepth vec* view port width height depth
pol ATORpolygon* pol
side const int side

Function Reference List


Function ATORmethod3DODClass::create3DmeshUsingPointMap3DOD()

Function Summary
namereturn typedescription
create3DmeshUsingPointMap3DODvoidcreate 3D mesh using point map 3DOD

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
pointMap double* point map
depthMap const double* depth map
rgbMap uchar* rgb map
firstMeshPointInMeshList ATORmeshPoint* first mesh point in mesh list
meshPointArray[] ATORmeshPoint* mesh point array []
useEdgeZeroCrossingMap const bool use edge zero crossing map
contrastValChosen const int contrast val chosen
vi RTviewInfo* vi

Function Reference List


Function ATORmethod3DODClass::createInterpolated3DmeshReferenceListUsingPointMap()

Function Summary
namereturn typedescription
createInterpolated3DmeshReferenceListUsingPointMapvoidcreate interpolated 3D mesh reference list using point map

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
pointMap double* point map
pointMapInterpolated double* point map interpolated
rgbMap uchar* rgb map
firstReferenceInInterpolated3Dmap LDreference* first reference in interpolated 3D map

Function Reference List


Function ATORmethod3DODClass::generateFeatureList3DOD()

Function Summary
namereturn typedescription
generateFeatureList3DODboolgenerate feature list 3DOD

Function Arguments
nametypedescription
viRTviewInfo* vi
depthMap const double* depth map
pointMap double* point map
depthContrastBooleanMap const bool* depth contrast boolean map
luminosityContrastBooleanMap const bool* luminosity contrast boolean map
luminosityContrastMapMinusDepthContrastMap const bool* luminosity contrast map minus depth contrast map
firstFeatureInList ATORfeature* first feature in list
trainOrTest const int train or test

Function Reference List


Function ATORmethod3DODClass::reconcileFeaturesMap()

Function Summary
namereturn typedescription
reconcileFeaturesMapvoidreconcile features map

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
featuresBooleanMap bool* features boolean map

Function Reference List


Function ATORmethod3DODClass::createFeaturesUsingBooleanMapUsingDepthMap()

Function Summary
namereturn typedescription
createFeaturesUsingBooleanMapUsingDepthMapvoidcreate features using boolean map using depth map

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
booleanMap const bool* boolean map
depthMap const double* depth map
featuresUsingContrastMap bool* features using contrast map
featuresUsingContrastMapComplete bool* features using contrast map complete
maxDotProductResultXposArrayComplete[3][3][3] int max dot product result xpos array complete [3][3][3]
maxDotProductResultYposArrayComplete[3][3][3] int max dot product result ypos array complete [3][3][3]
vi RTviewInfo* vi
pointMap const double* point map

Function Reference List


Function ATORmethod3DODClass::generateFeatureListUsingFeatureArraysUsingDepthMap()

Function Summary
namereturn typedescription
generateFeatureListUsingFeatureArraysUsingDepthMapvoidgenerate feature list using feature arrays using depth map

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
depthMap const double* depth map
maxDotProductResultXposArrayComplete[3][3][3] const int max dot product result xpos array complete [3][3][3]
maxDotProductResultYposArrayComplete[3][3][3] const int max dot product result ypos array complete [3][3][3]
firstFeatureInList ATORfeature* first feature in list
vi RTviewInfo* vi

Function Reference List


Function ATORmethod3DODClass::generateFeatureListUsingFeatureArraysUsingPointMap()

Function Summary
namereturn typedescription
generateFeatureListUsingFeatureArraysUsingPointMapvoidgenerate feature list using feature arrays using point map

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
pointMap double* point map
maxDotProductResultXposArrayComplete[3][3][3] const int max dot product result xpos array complete [3][3][3]
maxDotProductResultYposArrayComplete[3][3][3] const int max dot product result ypos array complete [3][3][3]
firstFeatureInList ATORfeature* first feature in list

Function Reference List


File ATORfeatureGeneration Documentation

File Name: ATORfeatureGeneration.cpp/.hpp

File Description: ATOR feature generation

File Function List


File Diagram (functions hierarchy)


Function ATORfeatureGenerationClass::generateFeatureListFromHeitgerFeatureRGBmapWithQuadraticFit()

Function Summary
namereturn typedescription
generateFeatureListFromHeitgerFeatureRGBmapWithQuadraticFitvoidgenerate feature list from heitger feature RGB map with quadratic fit

Function Arguments
nametypedescription
firstFeatureInFeatureListATORfeature* first feature in feature list
featureRgbMap uchar* feature rgb map
imageWidth int image width
imageHeight const int image height
sensitivity const double sensitivity
dimension const int dimension
pointMap double* point map
depthMap const double* depth map
zoom int zoom
vi RTviewInfo* vi
interpixelRGBmapType const bool interpixel RGB map type

Function Reference List


Function ATORfeatureGenerationClass::generateEdgeListFromRGBmapWithQuadraticFit()

Function Summary
namereturn typedescription
generateEdgeListFromRGBmapWithQuadraticFitvoidgenerate edge list from RGB map with quadratic fit

Function Arguments
nametypedescription
rgbMapuchar* rgb map
edgeBoolMap bool* edge bool map
edgeZeroCrossingMap[] ATORQFzeroCrossing* edge zero crossing map []
imageWidth int image width
imageHeight const int image height
sensitivity const double sensitivity
dimension const int dimension
pointMap double* point map
depthMap const double* depth map
zoom int zoom
vi RTviewInfo* vi
interpixelContrastMapType const int interpixel contrast map type

Function Reference List


Function ATORfeatureGenerationClass::generateEdgeListFromContrastMapWithQuadraticFit()

Function Summary
namereturn typedescription
generateEdgeListFromContrastMapWithQuadraticFitvoidgenerate edge list from contrast map with quadratic fit

Function Arguments
nametypedescription
contrastMapconst double* contrast map
edgeBoolMap bool* edge bool map
edgeZeroCrossingMap[] ATORQFzeroCrossing* edge zero crossing map []
imageWidth int image width
imageHeight const int image height
sensitivity const double sensitivity
dimension const int dimension
pointMap double* point map
depthMap const double* depth map
zoom int zoom
vi RTviewInfo* vi
interpixelContrastMapType const int interpixel contrast map type

Function Reference List


Function ATORfeatureGenerationClass::addCentredFeaturesToFeatureListUsingContrastMap()

Function Summary
namereturn typedescription
addCentredFeaturesToFeatureListUsingContrastMapbooladd centred features to feature list using contrast map

Function Arguments
nametypedescription
firstFeatureInFeatureListATORfeature* first feature in feature list
imageWidth int image width
imageHeight int image height
contrastMap[] const double contrast map []
sensitivity const double sensitivity
dimension int dimension
pointMap[] double point map []
depthMap[] double depth map []
zoom int zoom
vi RTviewInfo* vi
useEdgeZeroCrossingMap const bool use edge zero crossing map
interpixelContrastMapType const int interpixel contrast map type

Function Reference List


Function ATORfeatureGenerationClass::defineRegionCheckNextPixelNonRecursive()

Function Summary
namereturn typedescription
defineRegionCheckNextPixelNonRecursivebooldefine region check next pixel non recursive

Function Arguments
nametypedescription
firstInPixelContiguousStackATORpixelContiguous* first in pixel contiguous stack
xInitial int xInitial
yInitial int yInitial
edgeBoolMap[] const bool edge bool map []
edgeZeroCrossingMap[] constEffective ATORQFzeroCrossing* edge zero crossing map []
alreadyProcessed[] int already processed []
imageWidth int image width
imageHeight const int image height
regionSize double* region size
sumX int* sum X
sumY int* sum Y
sumPos vec* sum pos
dimension const int dimension
pointMap[] double point map []
depthMap[] const double depth map []
zoom int zoom
useEdgeZeroCrossingMap const bool use edge zero crossing map
vi RTviewInfo* vi
maxXx int* max xx
maxXy int* max xy
interpixelContrastMapType const int interpixel contrast map type

Function Reference List


Function ATORfeatureGenerationClass::traceEdgeCheckNextPixelNonRecursive()

Function Summary
namereturn typedescription
traceEdgeCheckNextPixelNonRecursivebooltrace edge check next pixel non recursive

Function Arguments
nametypedescription
xInitialOnBoundaryint xInitial on boundary
yInitialOnBoundary int yInitial on boundary
alreadyProcessed[] int already processed []
edgeZeroCrossingMap[] constEffective ATORQFzeroCrossing* edge zero crossing map []
useEdgeZeroCrossingMap const bool use edge zero crossing map
imageWidth int image width
imageHeight const int image height
sumX double* sum X
sumY double* sum Y
sumPos vec* sum pos
numberOfCounts int* number of counts
minRegionCircumferenceForRegion const int min region circumference for region
dimension const int dimension
pointMap[] double point map []
depthMap[] const double depth map []
zoom int zoom
firstInPixelContiguousBoundaryStack ATORpixelContiguous* first in pixel contiguous boundary stack
vi RTviewInfo* vi
interpixelContrastMapType const int interpixel contrast map type

Function Reference List


Function ATORfeatureGenerationClass::getDepthValueWithOrWithoutForegroundCheck()

Function Summary
namereturn typedescription
getDepthValueWithOrWithoutForegroundCheckdoubleget depth value with or without foreground check

Function Arguments
nametypedescription
pointNonWorldCoordxconst double point non world coordx
pointNonWorldCoordy const double point non world coordy
imageWidth const int image width
imageHeight const int image height
kernelWidthForegroundCheck const int kernel width foreground check
kernelHeightForegroundCheck const int kernel height foreground check
depthMap[] const double depth map []
zoom const int zoom

Function Reference List


Function ATORfeatureGenerationClass::addCentredFeaturesToFeatureListUsingMeshList()

Function Summary
namereturn typedescription
addCentredFeaturesToFeatureListUsingMeshListbooladd centred features to feature list using mesh list

Function Arguments
nametypedescription
firstFeatureInFeatureListATORfeature* first feature in feature list
sensitivity const double sensitivity
dimension int dimension
firstMeshPointInMeshList ATORmeshPoint* first mesh point in mesh list
contrastValChosen const int contrast val chosen
useEdgeZeroCrossingMap const bool use edge zero crossing map

Function Reference List


Function ATORfeatureGenerationClass::defineRegionCheckNextPixelUsingMeshPointNonRecursive()

Function Summary
namereturn typedescription
defineRegionCheckNextPixelUsingMeshPointNonRecursivebooldefine region check next pixel using mesh point non recursive

Function Arguments
nametypedescription
firstInPixelContiguousStackATORpixelContiguous* first in pixel contiguous stack
firstMeshPoint ATORmeshPoint* first mesh point
regionSize double* region size
contrastValChosen const int contrast val chosen
sumX int* sum X
sumY int* sum Y
sumPos vec* sum pos
useEdgeZeroCrossingMap const bool use edge zero crossing map
aMeshPointOnTheBoundary ATORmeshPoint* aMesh point on the boundary
sensitivity const double sensitivity

Function Reference List


Function ATORfeatureGenerationClass::traceEdgeCheckNextPixelUsingMeshPointNonRecursive()

Function Summary
namereturn typedescription
traceEdgeCheckNextPixelUsingMeshPointNonRecursivebooltrace edge check next pixel using mesh point non recursive

Function Arguments
nametypedescription
aMeshPointOnTheBoundaryATORmeshPoint* aMesh point on the boundary
sumX double* sum X
sumY double* sum Y
sumPos vec* sum pos
numberOfCounts int* number of counts
minRegionCircumferenceForRegion const int min region circumference for region
firstInPixelContiguousBoundaryStack ATORpixelContiguous* first in pixel contiguous boundary stack
useEdgeZeroCrossingMap const bool use edge zero crossing map

Function Reference List


Function ATORfeatureGenerationClass::traceEdgeAndAddMinimaAndMaximaFeatures()

Function Summary
namereturn typedescription
traceEdgeAndAddMinimaAndMaximaFeaturesATORfeature*trace edge and add minima and maxima features

Function Arguments
nametypedescription
firstNewFeatureInListATORfeature* first new feature in list
centroidX const double centroid X
centroidY const double centroid Y
centroidPos const vec* centroid pos
firstInPixelContiguousBoundaryStack ATORpixelContiguous* first in pixel contiguous boundary stack
dimension const int dimension
zoom int zoom
circumferenceForRegion const int circumference for region

Function Reference List


Function ATORfeatureGenerationClass::generateFeatureListFromHeitgerFeatureRGBMap()

Function Summary
namereturn typedescription
generateFeatureListFromHeitgerFeatureRGBMapvoidgenerate feature list from heitger feature RGBM ap

Function Arguments
nametypedescription
firstFeatureInFeatureListATORfeature* first feature in feature list
featureRgbMap uchar* feature rgb map
imageWidth int image width
imageHeight const int image height
rgbMap const uchar* rgb map
sensitivity const double sensitivity
dimension const int dimension
pointMap double* point map
depthMap const double* depth map
zoom int zoom
vi RTviewInfo* vi

Function Reference List


Function ATORfeatureGenerationClass::generateFeatureListFromRGBMap()

Function Summary
namereturn typedescription
generateFeatureListFromRGBMapvoidgenerate feature list from RGBM ap

Function Arguments
nametypedescription
firstFeatureInFeatureListATORfeature* first feature in feature list
rgbMap uchar* rgb map
imageWidth int image width
imageHeight const int image height
zoom int zoom
trainOrTestString const string train or test string
mapFileName const string map file name
vi const RTviewInfo* vi

Function Reference List


Function ATORfeatureGenerationClass::generateFeatureListFromHeitgerFeatureAsciiMap()

Function Summary
namereturn typedescription
generateFeatureListFromHeitgerFeatureAsciiMapvoidgenerate feature list from heitger feature ascii map

Function Arguments
nametypedescription
firstFeatureInFeatureListATORfeature* first feature in feature list
featureMapFileNameAscii const string feature map file name ascii
zoom int zoom
vi const RTviewInfo* vi

Function Reference List


Function ATORfeatureGenerationClass::deleteContiguousStackAndResetEdgesNonRecursive()

Function Summary
namereturn typedescription
deleteContiguousStackAndResetEdgesNonRecursivevoiddelete contiguous stack and reset edges non recursive

Function Arguments
nametypedescription
firstInPixelContiguousStackATORpixelContiguous* first in pixel contiguous stack
alreadyProcessed[] int already processed []
imageWidth const int image width
imageHeight const int image height

Function Reference List
N/A


Function ATORfeatureGenerationClass::deleteContiguousStackAndResetEdgesNonRecursive()

Function Summary
namereturn typedescription
deleteContiguousStackAndResetEdgesNonRecursivevoiddelete contiguous stack and reset edges non recursive

Function Arguments
nametypedescription
firstInPixelContiguousStackATORpixelContiguous* first in pixel contiguous stack

Function Reference List
N/A


File ATORoperations Documentation

File Name: ATORoperations.cpp/.hpp

File Description: ATOR operations

File Function List


File Diagram (functions hierarchy)


Function ATORoperationsClass::createPointMapFromDepthMap()

Function Summary
namereturn typedescription
createPointMapFromDepthMapvoidcreate point map from depth map

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
depthMap const double* depth map
pointMap double* point map
vi RTviewInfo* vi

Function Reference List


Function ATORoperationsClass::checkFeatureListForCommonFeature()

Function Summary
namereturn typedescription
checkFeatureListForCommonFeatureboolcheck feature list for common feature

Function Arguments
nametypedescription
cornerconst vec* corner
firstFeatureInList const ATORfeature* first feature in list
maxFeatureDistanceError const double max feature distance error
checkAlsoZ const bool check also Z

Function Reference List


Function ATORoperationsClass::generateBooleanMapFromFeatureList()

Function Summary
namereturn typedescription
generateBooleanMapFromFeatureListvoidgenerate boolean map from feature list

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
firstFeatureInList const ATORfeature* first feature in list
featuresMap bool* features map
vi const RTviewInfo* vi
zoom const int zoom

Function Reference List


Function ATORoperationsClass::generatePolygonListUsingFeatureListLocalised()

Function Summary
namereturn typedescription
generatePolygonListUsingFeatureListLocalisedboolgenerate polygon list using feature list localised

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
firstFeatureInList[] const ATORfeature first feature in list []
firstPolygonInList[] ATORpolygon first polygon in list []
numberOfZoomIndicies const int number of zoom indicies
dimension const int dimension

Function Reference List


Function ATORoperationsClass::calculateNumberOfNearestFeatures()

Function Summary
namereturn typedescription
calculateNumberOfNearestFeaturesintcalculate number of nearest features

Function Arguments
nametypedescription
numberOfPolygonsPerFeatureconst int number of polygons per feature
numberOfNearbyFeaturesToTransform const int number of nearby features to transform

Function Reference List


Function ATORoperationsClass::generateNearestFeaturesList()

Function Summary
namereturn typedescription
generateNearestFeaturesListvoidgenerate nearest features list

Function Arguments
nametypedescription
firstFeatureInNearestFeatureListATORfeature* first feature in nearest feature list
numberOfNearestFeatures const int number of nearest features

Function Reference List
N/A


Function ATORoperationsClass::addPolysToListForGivenFeatureAndNearestFeatureList()

Function Summary
namereturn typedescription
addPolysToListForGivenFeatureAndNearestFeatureListATORpolygon*add polys to list for given feature and nearest feature list

Function Arguments
nametypedescription
firstCurrentPolygonInListATORpolygon* first current polygon in list
firstPolygonInList const ATORpolygon* first polygon in list
firstFeatureInNearestFeatureList ATORfeature* first feature in nearest feature list
numberOfPolygonsPerFeature const int number of polygons per feature
dimension const int dimension

Function Reference List


Function ATORoperationsClass::checkFeatureListForCommonFeatureBasic()

Function Summary
namereturn typedescription
checkFeatureListForCommonFeatureBasicboolcheck feature list for common feature basic

Function Arguments
nametypedescription
cornerconst ATORfeature* corner
firstFeatureInList const ATORfeature* first feature in list

Function Reference List


Function ATORoperationsClass::checkPolygonListForCommonPolygon()

Function Summary
namereturn typedescription
checkPolygonListForCommonPolygonboolcheck polygon list for common polygon

Function Arguments
nametypedescription
polygonconst ATORpolygon* polygon
firstPolygonInList const ATORpolygon* first polygon in list

Function Reference List


Function ATORoperationsClass::createInterpolatedPointMap()

Function Summary
namereturn typedescription
createInterpolatedPointMapvoidcreate interpolated point map

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
pointMap double* point map
pointMapInterpolated double* point map interpolated

Function Reference List


Function ATORoperationsClass::storeBackupVertexAbsPositionsForAllReferencesIn2Dlist()

Function Summary
namereturn typedescription
storeBackupVertexAbsPositionsForAllReferencesIn2Dlistvoidstore backup vertex abs positions for all references in 2D list

Function Arguments
nametypedescription
firstReferenceInInterpolated2DrgbMapLDreference* first reference in interpolated 2D rgb map

Function Reference List
N/A


Function ATORoperationsClass::restoreBackupVertexAbsPositionsForAllReferencesIn2Dlist()

Function Summary
namereturn typedescription
restoreBackupVertexAbsPositionsForAllReferencesIn2Dlistvoidrestore backup vertex abs positions for all references in 2D list

Function Arguments
nametypedescription
firstReferenceInInterpolated2DrgbMapLDreference* first reference in interpolated 2D rgb map

Function Reference List
N/A


Function ATORoperationsClass::applyTransformationMatrixToAllReferencesIn2Dlist()

Function Summary
namereturn typedescription
applyTransformationMatrixToAllReferencesIn2Dlistvoidapply transformation matrix to all references in 2D list

Function Arguments
nametypedescription
firstReferenceInInterpolated2DrgbMapLDreference* first reference in interpolated 2D rgb map
transformationMatrix mat* transformation matrix

Function Reference List


Function ATORoperationsClass::applyTranslationToAllReferencesIn2Dlist()

Function Summary
namereturn typedescription
applyTranslationToAllReferencesIn2Dlistvoidapply translation to all references in 2D list

Function Arguments
nametypedescription
firstReferenceInInterpolated2DrgbMapLDreference* first reference in interpolated 2D rgb map
translationVector vec* translation vector

Function Reference List
N/A


File RTppm Documentation

File Name: RTppm.cpp/.hpp

File Description: RT ppm

File Function List


File Diagram (functions hierarchy)


Function RTppmClass::placepointPPM()

Function Summary
namereturn typedescription
placepointPPMvoidplacepoint PPM

Function Arguments
nametypedescription
pmpixmap* pm
x const int x
y const int y
r int r
g int g
b int b

Function Reference List
N/A


Function RTppmClass::newPixmap()

Function Summary
namereturn typedescription
newPixmappixmap*new pixmap

Function Arguments
nametypedescription
wideconst int wide
high const int high

Function Reference List
N/A


Function RTppmClass::loadPPM()

Function Summary
namereturn typedescription
loadPPMpixmap*load PPM

Function Arguments
nametypedescription
fnameconst string fname

Function Reference List


Function RTppmClass::writePPM()

Function Summary
namereturn typedescription
writePPMvoidwrite PPM

Function Arguments
nametypedescription
fnameconst string fname
pm const pixmap* pm

Function Reference List
N/A


Function RTppmClass::freePixmap()

Function Summary
namereturn typedescription
freePixmapvoidfree pixmap

Function Arguments
nametypedescription
pmpixmap* pm

Function Reference List
N/A


File RTscene Documentation

File Name: RTscene.cpp/.hpp

File Description: RT scene

File Function List


File Diagram (functions hierarchy)


Class RTlightingInfo

Class Data
nametypedescription
lsRTlightSourcels
nextLightRTlightingInfo*next light

Function RTsceneClass::rayTraceScene()

Function Summary
namereturn typedescription
rayTraceSceneintray trace scene

Function Arguments
nametypedescription
talFileNameconst string tal file name
imageFileName string image file name
outputImageFiles const int output image files
setRGBAndDepthAndNormalAndPointMaps const int set RGBA nd depth and normal and point maps
rgbMap uchar* rgb map
depthMap double* depth map
normalMap double* normal map
pointMap double* point map

Function Reference List


Function RTsceneClass::rayTraceSceneWithoutParse()

Function Summary
namereturn typedescription
rayTraceSceneWithoutParseintray trace scene without parse

Function Arguments
nametypedescription
viRTviewInfo* vi
si RTsceneInfo* si
li const RTlightingInfo* li
imageFileName string image file name
outputImageFiles const int output image files
setRGBAndDepthAndNormalAndPointMaps const int set RGBA nd depth and normal and point maps
rgbMap uchar* rgb map
depthMap double* depth map
normalMap double* normal map
pointMap double* point map

Function Reference List


Function RTsceneClass::setSceneLightingConditions()

Function Summary
namereturn typedescription
setSceneLightingConditionsvoidset scene lighting conditions

Function Arguments
nametypedescription
lightingAmbientRedNewconst float lighting ambient red new
lightingAmbientGreenNew const float lighting ambient green new
lightingAmbientBlueNew const float lighting ambient blue new
lightingSpecularNew const float lighting specular new
lightingDiffuseNew const float lighting diffuse new

Function Reference List
N/A


Function RTsceneClass::setLightingMode()

Function Summary
namereturn typedescription
setLightingModevoidset lighting mode

Function Arguments
nametypedescription
newLightingModeconst int new lighting mode

Function Reference List
N/A


Function RTsceneClass::parseTalFileInitialiseParser()

Function Summary
namereturn typedescription
parseTalFileInitialiseParservoidparse tal file initialise parser

Function Arguments
nametypedescription
talFileNameconst string tal file name

Function Reference List


Function RTsceneClass::parseTalFileGetViewInfo()

Function Summary
namereturn typedescription
parseTalFileGetViewInfoRTviewInfo*parse tal file get view info

Function Arguments
nametypedescription
viRTviewInfo* vi

Function Reference List


Function RTsceneClass::parseTalFileGetLightInfo()

Function Summary
namereturn typedescription
parseTalFileGetLightInfoRTlightingInfo*parse tal file get light info

Function Arguments
nametypedescription
liRTlightingInfo* li

Function Reference List


Function RTsceneClass::parseTalFileGetSceneInfo()

Function Summary
namereturn typedescription
parseTalFileGetSceneInfoRTsceneInfo*parse tal file get scene info

Function Arguments
nametypedescription
siRTsceneInfo* si

Function Reference List


Function RTsceneClass::createImage()

Function Summary
namereturn typedescription
createImagevoidcreate image

Function Arguments
nametypedescription
setRGBAndDepthAndNormalAndPointMapsconst int set RGBA nd depth and normal and point maps
rgbMap uchar* rgb map
depthMap double* depth map
normalMap double* normal map
pointMap double* point map
vi RTviewInfo* vi
si RTsceneInfo* si
li const RTlightingInfo* li

Function Reference List


Function RTsceneClass::calculateTransparencyColour()

Function Summary
namereturn typedescription
calculateTransparencyColourvoidcalculate transparency colour

Function Arguments
nametypedescription
viconst RTviewInfo* vi
si const RTsceneInfo* si
li const RTlightingInfo* li
rgb colour* rgb

Function Reference List
N/A


Function RTsceneClass::calculateUVNScalars()

Function Summary
namereturn typedescription
calculateUVNScalarsvoidcalculate UVNS calars

Function Arguments
nametypedescription
viconst RTviewInfo* vi
uvn vec* uvn
x const int x
y const int y

Function Reference List
N/A


Function RTsceneClass::calculateAmbientDiffuseSpecular()

Function Summary
namereturn typedescription
calculateAmbientDiffuseSpecularvoidcalculate ambient diffuse specular

Function Arguments
nametypedescription
viRTviewInfo* vi
si const RTsceneInfo* si
li const RTlightingInfo* li
rgb colour* rgb
tAtSurface double* tAt surface
nAtSurface vec* nAt surface
pointAtSurface vec* point at surface

Function Reference List


Function RTsceneClass::calculateBasicColour()

Function Summary
namereturn typedescription
calculateBasicColourvoidcalculate basic colour

Function Arguments
nametypedescription
viconst RTviewInfo* vi
si const RTsceneInfo* si
li const RTlightingInfo* li
rgb colour* rgb
tAtSurface double* tAt surface
nAtSurface vec* nAt surface
pointAtSurface vec* point at surface

Function Reference List


Function RTsceneClass::stripExtension()

Function Summary
namereturn typedescription
stripExtensionboolstrip extension

Function Arguments
nametypedescription
filenameWithExtensionstring filename with extension
filenameWithoutExtension string* filename without extension

Function Reference List
N/A


Function RTsceneClass::addExtension()

Function Summary
namereturn typedescription
addExtensionbooladd extension

Function Arguments
nametypedescription
filenameWithoutExtensionstring filename without extension
extension string extension
filenameWithExtension string* filename with extension

Function Reference List
N/A


Function RTsceneClass::calculatePointMapValue()

Function Summary
namereturn typedescription
calculatePointMapValuevoidcalculate point map value

Function Arguments
nametypedescription
xPosconst double xPos
yPos const double yPos
depthVal double depth val
xyzWorld vec* xyz world
vi RTviewInfo* vi

Function Reference List


File RTraytracer Documentation

File Name: RTraytracer.cpp/.hpp

File Description: RT raytracer

File Function List


File Diagram (functions hierarchy)


Class RTsceneInfo

Class Data
nametypedescription
standardMatrixadvancedMatstandard matrix
reverseMatrixadvancedMatreverse matrix
piRTpieceInfopi
diRTdimensionsInfodi
tOutdoubletOut
nvecn
nextSceneRTsceneInfo*next scene

Function RTraytracerClass::rayTrace()

Function Summary
namereturn typedescription
rayTracevoidray trace

Function Arguments
nametypedescription
viconst RTviewInfo* vi
si RTsceneInfo* si
tildaMat mat* tilda mat
uvn vec* uvn

Function Reference List


Function RTraytracerClass::calculateCylinder()

Function Summary
namereturn typedescription
calculateCylindervoidcalculate cylinder

Function Arguments
nametypedescription
p0vec* p0
p1 vec* p1
tInOut double* tIn out
norm vec* norm
finalReverseMatrix advancedMat* final reverse matrix
relevantFinalReverseMatrix advancedMat* relevant final reverse matrix

Function Reference List


Function RTraytracerClass::calculateCube()

Function Summary
namereturn typedescription
calculateCubevoidcalculate cube

Function Arguments
nametypedescription
p0vec* p0
p1 vec* p1
tInOut double* tIn out
norm vec* norm
finalReverseMatrix advancedMat* final reverse matrix
relevantFinalReverseMatrix advancedMat* relevant final reverse matrix

Function Reference List


Function RTraytracerClass::calculateSphere()

Function Summary
namereturn typedescription
calculateSpherevoidcalculate sphere

Function Arguments
nametypedescription
p0vec* p0
p1 vec* p1
tInOut double* tIn out
norm vec* norm
finalReverseMatrix advancedMat* final reverse matrix
relevantFinalReverseMatrix advancedMat* relevant final reverse matrix

Function Reference List


Function RTraytracerClass::calculatePrimQuad()

Function Summary
namereturn typedescription
calculatePrimQuadvoidcalculate prim quad

Function Arguments
nametypedescription
p0vec* p0
p1 vec* p1
tInOut double* tIn out
pi const RTpieceInfo* pi
norm vec* norm
finalReverseMatrix advancedMat* final reverse matrix
relevantFinalReverseMatrix advancedMat* relevant final reverse matrix

Function Reference List


Function RTraytracerClass::calculatePrimTri()

Function Summary
namereturn typedescription
calculatePrimTrivoidcalculate prim tri

Function Arguments
nametypedescription
p0vec* p0
p1 vec* p1
tInOut double* tIn out
pi const RTpieceInfo* pi
norm vec* norm
finalReverseMatrix advancedMat* final reverse matrix
relevantFinalReverseMatrix advancedMat* relevant final reverse matrix

Function Reference List


Function RTraytracerClass::calculatePrimLine()

Function Summary
namereturn typedescription
calculatePrimLinevoidcalculate prim line

Function Arguments
nametypedescription
p0vec* p0
p1 vec* p1
tInOut double* tIn out
pi const RTpieceInfo* pi
norm const vec* norm
finalReverseMatrix advancedMat* final reverse matrix
relevantFinalReverseMatrix advancedMat* relevant final reverse matrix

Function Reference List


Function RTraytracerClass::drawPoint()

Function Summary
namereturn typedescription
drawPointvoiddraw point

Function Arguments
nametypedescription
siRTsceneInfo* si
reverseMatrix advancedMat* reverse matrix
tInDash double tIn dash
tOutDash double tOut dash
p0Dash vec* p0D ash
p1Dash vec* p1D ash
norm vec* norm

Function Reference List


Function RTraytracerClass::drawPointNoLighting()

Function Summary
namereturn typedescription
drawPointNoLightingvoiddraw point no lighting

Function Arguments
nametypedescription
siRTsceneInfo* si
reverseMatrix const advancedMat* reverse matrix
tIn double tIn
tOut double tOut
p0 const vec* p0
p1 const vec* p1
norm const vec* norm

Function Reference List
N/A


Function RTraytracerClass::calculatePointUsingTInWorld()

Function Summary
namereturn typedescription
calculatePointUsingTInWorldvoidcalculate point using TI n world

Function Arguments
nametypedescription
tInWorlddouble tIn world
p0 vec* p0
p1 vec* p1
vi RTviewInfo* vi
p vec* p
uvn vec* uvn

Function Reference List


File RTparser Documentation

File Name: RTparser.cpp/.hpp

File Description: RT parser

File Function List


File Diagram (functions hierarchy)


Class RTlightSource

Class Data
nametypedescription
typelightTypetype
posvecpos
colcolourcol

Class RTpieceInfo

Class Data
nametypedescription
typepieceTypetype
colcolourcol
posvecpos
xrotdoublexrot
yrotdoubleyrot
zrotdoublezrot
vertex1Positionvecvertex 1P osition
vertex2Positionvecvertex 2P osition
vertex3Positionvecvertex 3P osition
vertex4Positionvecvertex 4P osition

Class RTdimensionsInfo

Class Data
nametypedescription
widthdoublewidth
lengthdoublelength
heightdoubleheight
translucentinttranslucent
transparencyinttransparency
is_invisibleintis _invisible

Class RTdecalInfo

Class Data
nametypedescription
widthdoublewidth
lengthdoublelength
filenamechar*filename
haveTransparentinthave transparent
transparentcolourcolourtransparentcolour

Class RTunknownInfo

Class Data
nametypedescription
commandStringchar*command string
param_countintparam _count
*paramschar**params

Function RTparserClass::initParser()

Function Summary
namereturn typedescription
initParservoidinit parser

Function Arguments
nametypedescription
fFILE* f

Function Reference List
N/A


Function RTparserClass::readViewport()

Function Summary
namereturn typedescription
readViewportintread viewport

Function Reference List
N/A


Function RTparserClass::get_view_info()

Function Summary
namereturn typedescription
get_view_infoRTviewInfo*get _view _info

Function Reference List
N/A


Function RTparserClass::nextLightSource()

Function Summary
namereturn typedescription
nextLightSourceintnext light source

Function Reference List
N/A


Function RTparserClass::get_light_info()

Function Summary
namereturn typedescription
get_light_infoRTlightSource*get _light _info

Function Reference List
N/A


Function RTparserClass::nextSceneCommand()

Function Summary
namereturn typedescription
nextSceneCommandintnext scene command

Function Reference List
N/A


Function RTparserClass::getPieceInfo()

Function Summary
namereturn typedescription
getPieceInfoRTpieceInfo*get piece info

Function Reference List
N/A


Function RTparserClass::getDimensionsInfo()

Function Summary
namereturn typedescription
getDimensionsInfoRTdimensionsInfo*get dimensions info

Function Reference List
N/A


Function RTparserClass::exitParser()

Function Summary
namereturn typedescription
exitParservoidexit parser

Function Reference List
N/A


File RToperations Documentation

File Name: RToperations.cpp/.hpp

File Description: RT operations

File Function List


File Diagram (functions hierarchy)


Function RToperationsClass::makeAdvancedMatrix()

Function Summary
namereturn typedescription
makeAdvancedMatrixvoidmake advanced matrix

Function Arguments
nametypedescription
matxAdvadvancedMat* matx adv
matx mat* matx
type int type

Function Reference List
N/A


Function RToperationsClass::multAdvancedMatrix()

Function Summary
namereturn typedescription
multAdvancedMatrixvoidmult advanced matrix

Function Arguments
nametypedescription
matxAdv1advancedMat* matx adv 1
matxAdv2 advancedMat* matx adv 2
matxAdv advancedMat* matx adv

Function Reference List
N/A


Function RToperationsClass::createIdentityMatrixAdvanced()

Function Summary
namereturn typedescription
createIdentityMatrixAdvancedvoidcreate identity matrix advanced

Function Arguments
nametypedescription
matxadvancedMat* matx

Function Reference List
N/A


Function RToperationsClass::createInverseTranslationMatrix()

Function Summary
namereturn typedescription
createInverseTranslationMatrixvoidcreate inverse translation matrix

Function Arguments
nametypedescription
xposdouble xpos
ypos double ypos
zpos double zpos
matx advancedMat* matx

Function Reference List


Function RToperationsClass::createTranslationMatrix()

Function Summary
namereturn typedescription
createTranslationMatrixvoidcreate translation matrix

Function Arguments
nametypedescription
xposdouble xpos
ypos double ypos
zpos double zpos
matx advancedMat* matx

Function Reference List


Function RToperationsClass::createScaleMatrix()

Function Summary
namereturn typedescription
createScaleMatrixvoidcreate scale matrix

Function Arguments
nametypedescription
widthdouble width
length double length
height double height
matx advancedMat* matx

Function Reference List


Function RToperationsClass::createInverseScaleMatrix()

Function Summary
namereturn typedescription
createInverseScaleMatrixvoidcreate inverse scale matrix

Function Arguments
nametypedescription
widthconst double width
length const double length
height const double height
matx advancedMat* matx

Function Reference List


Function RToperationsClass::createRotationxMatrix()

Function Summary
namereturn typedescription
createRotationxMatrixvoidcreate rotationx matrix

Function Arguments
nametypedescription
rotationdouble rotation
matx advancedMat* matx

Function Reference List


Function RToperationsClass::createInverseRotationxMatrix()

Function Summary
namereturn typedescription
createInverseRotationxMatrixvoidcreate inverse rotationx matrix

Function Arguments
nametypedescription
rotationdouble rotation
matx advancedMat* matx

Function Reference List


Function RToperationsClass::createRotationyMatrix()

Function Summary
namereturn typedescription
createRotationyMatrixvoidcreate rotationy matrix

Function Arguments
nametypedescription
rotationdouble rotation
matx advancedMat* matx

Function Reference List


Function RToperationsClass::createInverseRotationyMatrix()

Function Summary
namereturn typedescription
createInverseRotationyMatrixvoidcreate inverse rotationy matrix

Function Arguments
nametypedescription
rotationdouble rotation
matx advancedMat* matx

Function Reference List


Function RToperationsClass::createRotationzMatrix()

Function Summary
namereturn typedescription
createRotationzMatrixvoidcreate rotationz matrix

Function Arguments
nametypedescription
rotationdouble rotation
matx advancedMat* matx

Function Reference List


Function RToperationsClass::createInverseRotationzMatrix()

Function Summary
namereturn typedescription
createInverseRotationzMatrixvoidcreate inverse rotationz matrix

Function Arguments
nametypedescription
rotationdouble rotation
matx advancedMat* matx

Function Reference List


Function RToperationsClass::invertAdvancedMatrix()

Function Summary
namereturn typedescription
invertAdvancedMatrixvoidinvert advanced matrix

Function Arguments
nametypedescription
matxadvancedMat* matx

Function Reference List


Function RToperationsClass::transposeAdvancedMatrix()

Function Summary
namereturn typedescription
transposeAdvancedMatrixvoidtranspose advanced matrix

Function Arguments
nametypedescription
matxadvancedMat* matx

Function Reference List
N/A


Function RToperationsClass::multAdvancedMatrixByVector()

Function Summary
namereturn typedescription
multAdvancedMatrixByVectorvoidmult advanced matrix by vector

Function Arguments
nametypedescription
vecAdv1advancedVec* vec adv 1
matxAdv1 advancedMat* matx adv 1
vecAdv advancedVec* vec adv

Function Reference List
N/A


Function RToperationsClass::toRadians()

Function Summary
namereturn typedescription
toRadiansdoubleto radians

Function Arguments
nametypedescription
degreesconst double degrees

Function Reference List
N/A


Function RToperationsClass::toAdvancedVector()

Function Summary
namereturn typedescription
toAdvancedVectorvoidto advanced vector

Function Arguments
nametypedescription
vecvec* vec
type int type
vecAdv advancedVec* vec adv

Function Reference List
N/A


Function RToperationsClass::fromAdvancedVector()

Function Summary
namereturn typedescription
fromAdvancedVectorvoidfrom advanced vector

Function Arguments
nametypedescription
vecAdvadvancedVec* vec adv
vec vec* vec

Function Reference List
N/A


Function RToperationsClass::createAdvancedVector()

Function Summary
namereturn typedescription
createAdvancedVectorvoidcreate advanced vector

Function Arguments
nametypedescription
vecadvancedVec* vec

Function Reference List
N/A


Function RToperationsClass::findSmallestValue()

Function Summary
namereturn typedescription
findSmallestValuedoublefind smallest value

Function Arguments
nametypedescription
val1const double val 1
val2 const double val 2
val3 double val 3

Function Reference List
N/A


Function RToperationsClass::findGreatestValue()

Function Summary
namereturn typedescription
findGreatestValuedoublefind greatest value

Function Arguments
nametypedescription
val1const double val 1
val2 const double val 2
val3 double val 3

Function Reference List
N/A


Function RToperationsClass::findIntersectLineWithTri()

Function Summary
namereturn typedescription
findIntersectLineWithTriintfind intersect line with tri

Function Arguments
nametypedescription
pt1const vec* pt 1
pt2 const vec* pt 2
pt3 const vec* pt 3
linept1 vec* linept 1
linept2 vec* linept 2
pt_int vec* pt _int
norm vec* norm
t double* t

Function Reference List


Function RToperationsClass::checkSameClockDir()

Function Summary
namereturn typedescription
checkSameClockDirintcheck same clock dir

Function Arguments
nametypedescription
pt1const vec* pt 1
pt2 const vec* pt 2
pt3 const vec* pt 3
norm const vec* norm

Function Reference List
N/A


Function RToperationsClass::findIntersectLineWithLine()

Function Summary
namereturn typedescription
findIntersectLineWithLineintfind intersect line with line

Function Arguments
nametypedescription
linept1const vec* linept 1
linept2 const vec* linept 2
povpt1 vec* povpt 1
povpt2 vec* povpt 2
pt_int vec* pt _int
norm const vec* norm
t double* t

Function Reference List


Function RToperationsClass::findIntersectLineWithLine2D()

Function Summary
namereturn typedescription
findIntersectLineWithLine2Dboolfind intersect line with line 2D

Function Arguments
nametypedescription
povpt1const vec* povpt 1
povpt2 const vec* povpt 2
linept1 const vec* linept 1
linept2 const vec* linept 2
pt_int vec* pt _int

Function Reference List


Function RToperationsClass::findIntersectLineWithQuad()

Function Summary
namereturn typedescription
findIntersectLineWithQuadintfind intersect line with quad

Function Arguments
nametypedescription
pt1const vec* pt 1
pt2 const vec* pt 2
pt3 const vec* pt 3
pt4 const vec* pt 4
linept1 vec* linept 1
linept2 vec* linept 2
pt_int vec* pt _int
norm vec* norm
t double* t

Function Reference List


Function RToperationsClass::findPositionOfSmallestValueWhichHits()

Function Summary
namereturn typedescription
findPositionOfSmallestValueWhichHitsintfind position of smallest value which hits

Function Arguments
nametypedescription
arrayconst double* array
hitsArray const int* hits array
size const int size

Function Reference List
N/A


Function RToperationsClass::findPositionOfGreatestValueWhichHits()

Function Summary
namereturn typedescription
findPositionOfGreatestValueWhichHitsintfind position of greatest value which hits

Function Arguments
nametypedescription
arrayconst double* array
hitsArray const int* hits array
size const int size

Function Reference List
N/A


File RTpixelMaps Documentation

File Name: RTpixelMaps.cpp/.hpp

File Description: RT pixel maps

File Function List


File Diagram (functions hierarchy)


Function RTpixelMapsClass::setBooleanMapValue()

Function Summary
namereturn typedescription
setBooleanMapValuevoidset boolean map value

Function Arguments
nametypedescription
xconst int x
y const int y
imageWidth const int image width
booleanVal bool boolean val
booleanMap bool* boolean map

Function Reference List
N/A


Function RTpixelMapsClass::getBooleanMapValue()

Function Summary
namereturn typedescription
getBooleanMapValueboolget boolean map value

Function Arguments
nametypedescription
xconst int x
y const int y
imageWidth const int image width
booleanMap const bool* boolean map

Function Reference List
N/A


Function RTpixelMapsClass::getRGBMapValue()

Function Summary
namereturn typedescription
getRGBMapValueucharget RGBM ap value

Function Arguments
nametypedescription
xconst int x
y const int y
imageWidth const int image width
rgb const int rgb
rgbMap const uchar* rgb map

Function Reference List
N/A


Function RTpixelMapsClass::getRGBMapValues()

Function Summary
namereturn typedescription
getRGBMapValuesvoidget RGBM ap values

Function Arguments
nametypedescription
xint x
y int y
imageWidth int image width
rgbMap uchar* rgb map
col colour* col

Function Reference List
N/A


Function RTpixelMapsClass::setRGBMapValues()

Function Summary
namereturn typedescription
setRGBMapValuesvoidset RGBM ap values

Function Arguments
nametypedescription
xconst int x
y const int y
imageWidth const int image width
col colour* col
rgbMap uchar* rgb map

Function Reference List
N/A


Function RTpixelMapsClass::setRGBMapValue()

Function Summary
namereturn typedescription
setRGBMapValuevoidset RGBM ap value

Function Arguments
nametypedescription
xconst int x
y const int y
imageWidth const int image width
rgb const int rgb
rgbMap uchar* rgb map
rgbVal int rgb val

Function Reference List
N/A


Function RTpixelMapsClass::setNormalMapValue()

Function Summary
namereturn typedescription
setNormalMapValuevoidset normal map value

Function Arguments
nametypedescription
xconst int x
y const int y
imageWidth const int image width
normalVal vec* normal val
normalMap double* normal map

Function Reference List


Function RTpixelMapsClass::getNormalMapValue()

Function Summary
namereturn typedescription
getNormalMapValuevoidget normal map value

Function Arguments
nametypedescription
xint x
y int y
imageWidth int image width
normalMap double* normal map
normalVal vec* normal val

Function Reference List


Function RTpixelMapsClass::setPointMapValue()

Function Summary
namereturn typedescription
setPointMapValuevoidset point map value

Function Arguments
nametypedescription
xconst int x
y const int y
imageWidth const int image width
pointVal vec* point val
pointMap double* point map

Function Reference List


Function RTpixelMapsClass::getPointMapValue()

Function Summary
namereturn typedescription
getPointMapValuevoidget point map value

Function Arguments
nametypedescription
xint x
y int y
imageWidth int image width
pointMap double* point map
pointVal vec* point val

Function Reference List


Function RTpixelMapsClass::setVectorMapValue()

Function Summary
namereturn typedescription
setVectorMapValuevoidset vector map value

Function Arguments
nametypedescription
xconst int x
y const int y
imageWidth const int image width
vectorVal vec* vector val
vectorMap double* vector map

Function Reference List
N/A


Function RTpixelMapsClass::getVectorMapValue()

Function Summary
namereturn typedescription
getVectorMapValuevoidget vector map value

Function Arguments
nametypedescription
xint x
y int y
imageWidth int image width
vectorMap double* vector map
vectorVal vec* vector val

Function Reference List
N/A


Function RTpixelMapsClass::setLumOrContrastOrDepthMapValue()

Function Summary
namereturn typedescription
setLumOrContrastOrDepthMapValuevoidset lum or contrast or depth map value

Function Arguments
nametypedescription
xconst int x
y const int y
imageWidth const int image width
contrastVal double contrast val
contrastMap double* contrast map

Function Reference List
N/A


Function RTpixelMapsClass::getLumOrContrastOrDepthMapValue()

Function Summary
namereturn typedescription
getLumOrContrastOrDepthMapValuedoubleget lum or contrast or depth map value

Function Arguments
nametypedescription
xconst int x
y const int y
imageWidth const int image width
contrastMap const double* contrast map

Function Reference List
N/A


Function RTpixelMapsClass::generatePixmapFromRGBmap()

Function Summary
namereturn typedescription
generatePixmapFromRGBmapvoidgenerate pixmap from RGB map

Function Arguments
nametypedescription
imageFileNameconst string image file name
imageWidth int image width
imageHeight const int image height
rgbMap uchar* rgb map

Function Reference List


Function RTpixelMapsClass::generatePixmapFromLuminosityContrastMap()

Function Summary
namereturn typedescription
generatePixmapFromLuminosityContrastMapvoidgenerate pixmap from luminosity contrast map

Function Arguments
nametypedescription
imageFileNameconst string image file name
imageWidth const int image width
imageHeight const int image height
contrastMap const double* contrast map

Function Reference List


Function RTpixelMapsClass::generatePixmapFromDepthMapOrDepthContrastMap()

Function Summary
namereturn typedescription
generatePixmapFromDepthMapOrDepthContrastMapvoidgenerate pixmap from depth map or depth contrast map

Function Arguments
nametypedescription
imageFileNameconst string image file name
imageWidth const int image width
imageHeight const int image height
depthMap const double* depth map

Function Reference List


Function RTpixelMapsClass::generatePixmapFromDepthMapOrDepthContrastMapAdvanced()

Function Summary
namereturn typedescription
generatePixmapFromDepthMapOrDepthContrastMapAdvancedvoidgenerate pixmap from depth map or depth contrast map advanced

Function Arguments
nametypedescription
imageFileNameconst string image file name
imageWidth const int image width
imageHeight const int image height
depthMap const double* depth map
noHitDepth const double no hit depth
estimateMaxDepth const double estimate max depth

Function Reference List


Function RTpixelMapsClass::generateRGBMapFromDepthMapOrDepthContrastMap()

Function Summary
namereturn typedescription
generateRGBMapFromDepthMapOrDepthContrastMapvoidgenerate RGBM ap from depth map or depth contrast map

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

Function Reference List


Function RTpixelMapsClass::generateRGBMapFromDepthMapOrDepthContrastMapAdvanced()

Function Summary
namereturn typedescription
generateRGBMapFromDepthMapOrDepthContrastMapAdvancedvoidgenerate RGBM ap from depth map or depth contrast map advanced

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
depthMap const double* depth map
rgbMap uchar* rgb map
noHitDepth const double no hit depth
estimateMaxDepth const double estimate max depth

Function Reference List


Function RTpixelMapsClass::generatePixmapFromNormalMap()

Function Summary
namereturn typedescription
generatePixmapFromNormalMapvoidgenerate pixmap from normal map

Function Arguments
nametypedescription
imageFileNameconst string image file name
imageWidth int image width
imageHeight const int image height
normalMap double* normal map

Function Reference List


Function RTpixelMapsClass::generatePixmapFromLuminosityMap()

Function Summary
namereturn typedescription
generatePixmapFromLuminosityMapvoidgenerate pixmap from luminosity map

Function Arguments
nametypedescription
imageFileNameconst string image file name
imageWidth const int image width
imageHeight const int image height
luminosityMap const double* luminosity map

Function Reference List


Function RTpixelMapsClass::generatePixmapFromBooleanMap()

Function Summary
namereturn typedescription
generatePixmapFromBooleanMapvoidgenerate pixmap from boolean map

Function Arguments
nametypedescription
imageFileNameconst string image file name
imageWidth const int image width
imageHeight const int image height
booleanMap const bool* boolean map

Function Reference List


Function RTpixelMapsClass::generatePixmapFromDepthMap24Bit()

Function Summary
namereturn typedescription
generatePixmapFromDepthMap24Bitvoidgenerate pixmap from depth map 24B it

Function Arguments
nametypedescription
imageFileNameconst string image file name
imageWidth const int image width
imageHeight const int image height
depthMap const double* depth map
depthScale const double depth scale
depthOffset const double depth offset

Function Reference List


Function RTpixelMapsClass::calculate24BitDepthPixmapPixelFromDepth()

Function Summary
namereturn typedescription
calculate24BitDepthPixmapPixelFromDepthvoidcalculate 24B it depth pixmap pixel from depth

Function Arguments
nametypedescription
depthconst double depth
depthScale const double depth scale
depthOffset const double depth offset
depthMap24BitPixelValue colour* depth map 24B it pixel value

Function Reference List
N/A


Function RTpixelMapsClass::writeImage()

Function Summary
namereturn typedescription
writeImagevoidwrite image

Function Arguments
nametypedescription
imageFileNameconst string image file name
pm pixmap* pm

Function Reference List


Function RTpixelMapsClass::readImage()

Function Summary
namereturn typedescription
readImagevoidread image

Function Arguments
nametypedescription
imageFileNameconst string image file name
rgbMap uchar* rgb map

Function Reference List


Function RTpixelMapsClass::createRGBMapFromPixmapImage()

Function Summary
namereturn typedescription
createRGBMapFromPixmapImagevoidcreate RGBM ap from pixmap image

Function Arguments
nametypedescription
objectImagepixmap* object image
rgbMap uchar* rgb map

Function Reference List


Function RTpixelMapsClass::calculateColourFromPixmapPixel()

Function Summary
namereturn typedescription
calculateColourFromPixmapPixelvoidcalculate colour from pixmap pixel

Function Arguments
nametypedescription
pmpixmap* pm
pixelPositionInPixmap int pixel position in pixmap
col colour* col

Function Reference List
N/A


Function RTpixelMapsClass::createDepthMapFromDepth24BitPixmapImage()

Function Summary
namereturn typedescription
createDepthMapFromDepth24BitPixmapImagevoidcreate depth map from depth 24B it pixmap image

Function Arguments
nametypedescription
depth24BitPixMappixmap* depth 24B it pix map
depthMap double* depth map
depthScale const double depth scale
depthOffset const double depth offset

Function Reference List


Function RTpixelMapsClass::calculateDepthFrom24BitDepthValue()

Function Summary
namereturn typedescription
calculateDepthFrom24BitDepthValuedoublecalculate depth from 24B it depth value

Function Arguments
nametypedescription
depthMap24BitPixelValueconst colour* depth map 24B it pixel value
depthScale const double depth scale
depthOffset const double depth offset

Function Reference List
N/A


Function RTpixelMapsClass::createLuminosityMapFromRGBMap()

Function Summary
namereturn typedescription
createLuminosityMapFromRGBMapvoidcreate luminosity map from RGBM ap

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

Function Reference List


Function RTpixelMapsClass::calculateLuminosityLevelFromRGBMap()

Function Summary
namereturn typedescription
calculateLuminosityLevelFromRGBMapdoublecalculate luminosity level from RGBM ap

Function Arguments
nametypedescription
xint x
y int y
imageWidth int image width
rgbMap uchar* rgb map

Function Reference List


Function RTpixelMapsClass::calculateLuminosityLevelFromRGBVal()

Function Summary
namereturn typedescription
calculateLuminosityLevelFromRGBValdoublecalculate luminosity level from RGBV al

Function Arguments
nametypedescription
rgbValconst colour* rgb val

Function Reference List
N/A


Function RTpixelMapsClass::createContrastMapFromMap()

Function Summary
namereturn typedescription
createContrastMapFromMapvoidcreate contrast map from map

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
luminosityMap const double* luminosity map
contrastMap double* contrast map

Function Reference List


Function RTpixelMapsClass::calculateContrastLevelWithinKernel()

Function Summary
namereturn typedescription
calculateContrastLevelWithinKerneldoublecalculate contrast level within kernel

Function Arguments
nametypedescription
pixelXconst int pixel X
pixelY const int pixel Y
luminosityMap const double* luminosity map
kernelWidth const int kernel width
kernelHeight const int kernel height
imageWidth const int image width
imageHeight const int image height

Function Reference List


Function RTpixelMapsClass::createLuminosityContrastBooleanMap()

Function Summary
namereturn typedescription
createLuminosityContrastBooleanMapvoidcreate luminosity contrast boolean map

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
luminosityContrastMap const double* luminosity contrast map
luminosityContrastBooleanMap bool* luminosity contrast boolean map

Function Reference List


Function RTpixelMapsClass::createLuminosityBooleanMap()

Function Summary
namereturn typedescription
createLuminosityBooleanMapvoidcreate luminosity boolean map

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
luminosityMap const double* luminosity map
luminosityBooleanMap bool* luminosity boolean map

Function Reference List


Function RTpixelMapsClass::fillInRTRulesExternVariables()

Function Summary
namereturn typedescription
fillInRTRulesExternVariablesvoidfill in RTR ules extern variables

Function Reference List
N/A


File ATORpixelMaps Documentation

File Name: ATORpixelMaps.cpp/.hpp

File Description: ATOR pixel maps

File Function List


File Diagram (functions hierarchy)


Function ATORpixelMapsClass::createPointNormalMapFromPointMap()

Function Summary
namereturn typedescription
createPointNormalMapFromPointMapvoidcreate point normal map from point map

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
pointMap double* point map
pointNormalMap double* point normal map

Function Reference List


Function ATORpixelMapsClass::calculateMeshPointNormalsUsingPointMap()

Function Summary
namereturn typedescription
calculateMeshPointNormalsUsingPointMapvoidcalculate mesh point normals using point map

Function Arguments
nametypedescription
xint x
y int y
kernelWidth const int kernel width
kernelHeight const int kernel height
imageWidth int image width
imageHeight const int image height
pointMap double* point map
meshPointNormal vec* mesh point normal
meshPointNormals[] vec mesh point normals []

Function Reference List


Function ATORpixelMapsClass::createPointNormalContrastMapFromPointNormalMap()

Function Summary
namereturn typedescription
createPointNormalContrastMapFromPointNormalMapvoidcreate point normal contrast map from point normal map

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
pointNormalMap double* point normal map
pointNormalContrastMap double* point normal contrast map

Function Reference List


Function ATORpixelMapsClass::calculatePointNormalContrastLevelWithinKernel()

Function Summary
namereturn typedescription
calculatePointNormalContrastLevelWithinKerneldoublecalculate point normal contrast level within kernel

Function Arguments
nametypedescription
pixelXint pixel X
pixelY int pixel Y
pointNormalMap double* point normal map
kernelWidth const int kernel width
kernelHeight const int kernel height
imageWidth int image width
imageHeight const int image height

Function Reference List


Function ATORpixelMapsClass::setXYvectorMapValue()

Function Summary
namereturn typedescription
setXYvectorMapValuevoidset XY vector map value

Function Arguments
nametypedescription
xconst int x
y const int y
imageWidth const int image width
XYvectorVal vec* XY vector val
XYvectorMap double* XY vector map

Function Reference List
N/A


Function ATORpixelMapsClass::getXYvectorMapValue()

Function Summary
namereturn typedescription
getXYvectorMapValuevoidget XY vector map value

Function Arguments
nametypedescription
xint x
y int y
imageWidth int image width
XYvectorMap double* XY vector map
XYvectorVal vec* XY vector val

Function Reference List
N/A


Function ATORpixelMapsClass::createDepthContrastBooleanMap()

Function Summary
namereturn typedescription
createDepthContrastBooleanMapvoidcreate depth contrast boolean map

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
depthContrastMap const double* depth contrast map
depthContrastBooleanMap bool* depth contrast boolean map

Function Reference List


Function ATORpixelMapsClass::generatePixmapFromDepthGradientMap()

Function Summary
namereturn typedescription
generatePixmapFromDepthGradientMapvoidgenerate pixmap from depth gradient map

Function Arguments
nametypedescription
imageFileNameconst string image file name
imageWidth int image width
imageHeight const int image height
depthGradientMap double* depth gradient map

Function Reference List


Function ATORpixelMapsClass::generateRGBmapFromDepthGradientMap()

Function Summary
namereturn typedescription
generateRGBmapFromDepthGradientMapvoidgenerate RGB map from depth gradient map

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
depthGradientMap double* depth gradient map
rgbMap uchar* rgb map

Function Reference List


Function ATORpixelMapsClass::generatePixmapFromDepthGradientContrastMap()

Function Summary
namereturn typedescription
generatePixmapFromDepthGradientContrastMapvoidgenerate pixmap from depth gradient contrast map

Function Arguments
nametypedescription
imageFileNameconst string image file name
imageWidth const int image width
imageHeight const int image height
depthGradientContrastMap const double* depth gradient contrast map

Function Reference List


Function ATORpixelMapsClass::createDepthGradientContrastBooleanMap()

Function Summary
namereturn typedescription
createDepthGradientContrastBooleanMapvoidcreate depth gradient contrast boolean map

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
depthGradientContrastMap const double* depth gradient contrast map
depthGradientContrastBooleanMap bool* depth gradient contrast boolean map

Function Reference List


Function ATORpixelMapsClass::generatePixmapFromPointNormalContrastMap()

Function Summary
namereturn typedescription
generatePixmapFromPointNormalContrastMapvoidgenerate pixmap from point normal contrast map

Function Arguments
nametypedescription
imageFileNameconst string image file name
imageWidth const int image width
imageHeight const int image height
pointNormalContrastMap const double* point normal contrast map

Function Reference List


Function ATORpixelMapsClass::generateRGBmapFromPointNormalContrastMap()

Function Summary
namereturn typedescription
generateRGBmapFromPointNormalContrastMapvoidgenerate RGB map from point normal contrast map

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
pointNormalContrastMap const double* point normal contrast map
rgbMap uchar* rgb map

Function Reference List


Function ATORpixelMapsClass::createPointNormalContrastBooleanMap()

Function Summary
namereturn typedescription
createPointNormalContrastBooleanMapvoidcreate point normal contrast boolean map

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
pointNormalContrastMap const double* point normal contrast map
pointNormalContrastBooleanMap bool* point normal contrast boolean map

Function Reference List


Function ATORpixelMapsClass::calculateForegroundMinimumDepthWithinKernel()

Function Summary
namereturn typedescription
calculateForegroundMinimumDepthWithinKerneldoublecalculate foreground minimum depth within kernel

Function Arguments
nametypedescription
pixelXconst int pixel X
pixelY const int pixel Y
imageWidth const int image width
imageHeight const int image height
kernelWidth const int kernel width
kernelHeight const int kernel height
depthMap const double* depth map
nearbyPointOfMinimumDepth vec* nearby point of minimum depth
zoom const int zoom

Function Reference List


Function ATORpixelMapsClass::createDepthGradientMapFromDepthMap()

Function Summary
namereturn typedescription
createDepthGradientMapFromDepthMapvoidcreate depth gradient map from depth map

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
depthMap const double* depth map
depthGradientMap double* depth gradient map

Function Reference List


Function ATORpixelMapsClass::calculateDepthGradientValueWithinKernel()

Function Summary
namereturn typedescription
calculateDepthGradientValueWithinKerneldoublecalculate depth gradient value within kernel

Function Arguments
nametypedescription
pixelXconst int pixel X
pixelY const int pixel Y
depthMap const double* depth map
kernelWidth const int kernel width
kernelHeight const int kernel height
imageWidth const int image width
imageHeight const int image height
depthGradientVal vec* depth gradient val

Function Reference List


Function ATORpixelMapsClass::createDepthGradientContrastMapFromDepthGradientMap()

Function Summary
namereturn typedescription
createDepthGradientContrastMapFromDepthGradientMapvoidcreate depth gradient contrast map from depth gradient map

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
depthGradientMap double* depth gradient map
depthGradientContrastMap double* depth gradient contrast map

Function Reference List


Function ATORpixelMapsClass::createDepthGradientContrastMapFromMap()

Function Summary
namereturn typedescription
createDepthGradientContrastMapFromMapvoidcreate depth gradient contrast map from map

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
depthGradientMap double* depth gradient map
depthGradientContrastMap double* depth gradient contrast map

Function Reference List


Function ATORpixelMapsClass::calculateDepthGradientContrastValueWithinKernel()

Function Summary
namereturn typedescription
calculateDepthGradientContrastValueWithinKerneldoublecalculate depth gradient contrast value within kernel

Function Arguments
nametypedescription
pixelXint pixel X
pixelY int pixel Y
depthGradientMap double* depth gradient map
kernelWidth const int kernel width
kernelHeight const int kernel height
imageWidth int image width
imageHeight const int image height

Function Reference List


Function ATORpixelMapsClass::subtractBooleanMaps()

Function Summary
namereturn typedescription
subtractBooleanMapsvoidsubtract boolean maps

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
booleanMap1 const bool* boolean map 1
booleanMap2 const bool* boolean map 2
booleanMap1MinusBooleanMap2 bool* boolean map 1M inus boolean map 2

Function Reference List


Function ATORpixelMapsClass::addBooleanMaps()

Function Summary
namereturn typedescription
addBooleanMapsvoidadd boolean maps

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
booleanMap1 const bool* boolean map 1
booleanMap2 const bool* boolean map 2
booleanMap1PlusBooleanMap2 bool* boolean map 1P lus boolean map 2

Function Reference List


Function ATORpixelMapsClass::cropRGBmap()

Function Summary
namereturn typedescription
cropRGBmapvoidcrop RGB map

Function Arguments
nametypedescription
originalImageWidthint original image width
originalImageHeight const int original image height
cropXPos const int crop XP os
cropYPos const int crop YP os
croppedWidth const int cropped width
croppedHeight const int cropped height
rgbMapUncropped uchar* rgb map uncropped
rgbMap uchar* rgb map

Function Reference List


Function ATORpixelMapsClass::cropDepthMap()

Function Summary
namereturn typedescription
cropDepthMapvoidcrop depth map

Function Arguments
nametypedescription
originalImageWidthconst int original image width
originalImageHeight const int original image height
cropXPos const int crop XP os
cropYPos const int crop YP os
croppedWidth const int cropped width
croppedHeight const int cropped height
depthMapUncropped const double* depth map uncropped
depthMap double* depth map

Function Reference List


Function ATORpixelMapsClass::resampleRGBmap()

Function Summary
namereturn typedescription
resampleRGBmapvoidresample RGB map

Function Arguments
nametypedescription
rgbMapuchar* rgb map
imageWidth const int image width
imageHeight const int image height
resampledRGBmapAtDesiredZoomChar uchar* resampled RGB map at desired zoom char
zoom const int zoom
ignoreBackgroundComparisonMethod const int ignore background comparison method

Function Reference List
N/A


Function ATORpixelMapsClass::resampleLumOrContrastOrDepthMap()

Function Summary
namereturn typedescription
resampleLumOrContrastOrDepthMapvoidresample lum or contrast or depth map

Function Arguments
nametypedescription
lumOrContrastOrDepthMapdouble* lum or contrast or depth map
imageWidth const int image width
imageHeight const int image height
resampledLumOrContrastOrDepthMapAtDesiredZoomChar double* resampled lum or contrast or depth map at desired zoom char
zoom const int zoom
offMapValue const double off map value

Function Reference List


Function ATORpixelMapsClass::createArbitraryContrastBooleanMap()

Function Summary
namereturn typedescription
createArbitraryContrastBooleanMapvoidcreate arbitrary contrast boolean map

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
contrastMap const double* contrast map
contrastBooleanMap bool* contrast boolean map
sensitivity const double sensitivity

Function Reference List


File ATORquadraticFit Documentation

File Name: ATORquadraticFit.cpp/.hpp

File Description: ATOR quadratic fit

File Function List


File Diagram (functions hierarchy)


Class ATORQFzeroCrossing

Class Data
nametypedescription
xintx
yinty
zeroCrossingValueXfloatzero crossing value X
zeroCrossingValueYfloatzero crossing value Y
alphafloatalpha
betafloatbeta
coefficient[NUMBER_OF_COEFFICIENTS]floatcoefficient [NUMBER_OF_COEFFICIENTS]
nextATORQFzeroCrossing*next
dzAlphafloatdz alpha
dzBetafloatdz beta
dzTwoAlphafloatdz two alpha
dzTwoBetafloatdz two beta
confidencefloatconfidence
depthdoubledepth
nearbyHitValueXintnearby hit value X
nearbyHitValueYintnearby hit value Y
pointvecpoint

Function ATORquadraticFitClass::calculateAreaOfOneSideOfEdgeInPixel()

Function Summary
namereturn typedescription
calculateAreaOfOneSideOfEdgeInPixeldoublecalculate area of one side of edge in pixel

Function Arguments
nametypedescription
xDevPointOnSideconst int xDev point on side
yDevPointOnSide const int yDev point on side
zeroCrossingValueX const double zero crossing value X
zeroCrossingValueY const double zero crossing value Y
alpha const double alpha

Function Reference List


Function ATORquadraticFitClass::generateZeroCrossingList()

Function Summary
namereturn typedescription
generateZeroCrossingListvoidgenerate zero crossing list

Function Arguments
nametypedescription
luminosityContrastMapconst double* luminosity contrast map
imageWidth const int image width
imageHeight const int image height
firstZeroCrossingInList ATORQFzeroCrossing* first zero crossing in list
edgeDetect const bool edge detect
sensitivity const double sensitivity
dimension const int dimension
pointMap const double* point map
depthMap const double* depth map
zoom const int zoom
interpixelMapType const int interpixel map type

Function Reference List


Function ATORquadraticFitClass::edgiseData()

Function Summary
namereturn typedescription
edgiseDatavoidedgise data

Function Arguments
nametypedescription
edgeDetectconst bool edge detect
createEnhancedImageDisplayingQuadraticFitInfo const bool create enhanced image displaying quadratic fit info
currentZeroCrossingInList ATORQFzeroCrossing* current zero crossing in list
imageWidth const int image width
imageHeight const int image height
luminosityContrastMap[] const double luminosity contrast map []
sensitivity const double sensitivity
dimension const int dimension
pointMap const double* point map
depthMap const double* depth map
zoom const int zoom
interpixelMapType const int interpixel map type

Function Reference List


Function ATORquadraticFitClass::calculateZeroCrossingAndOrientation()

Function Summary
namereturn typedescription
calculateZeroCrossingAndOrientationboolcalculate zero crossing and orientation

Function Arguments
nametypedescription
xint x
y int y
coefficient[] float coefficient []
edgeDetect const bool edge detect
createEnhancedImageDisplayingQuadraticFitInfo const bool create enhanced image displaying quadratic fit info
currentZeroCrossingInList ATORQFzeroCrossing* current zero crossing in list

Function Reference List


Function ATORquadraticFitClass::calculateQuadraticFitCoefficients()

Function Summary
namereturn typedescription
calculateQuadraticFitCoefficientsvoidcalculate quadratic fit coefficients

Function Arguments
nametypedescription
xconst int x
y const int y
coefficient[] float coefficient []
luminosityContrastMap[] const double luminosity contrast map []

Function Reference List


Function ATORquadraticFitClass::calculateQuadraticFitCoefficients3x3()

Function Summary
namereturn typedescription
calculateQuadraticFitCoefficients3x3voidcalculate quadratic fit coefficients 3x 3

Function Arguments
nametypedescription
xconst int x
y const int y
coefficient[] float coefficient []
luminosityContrastMap[] const double luminosity contrast map []

Function Reference List


Function ATORquadraticFitClass::calculateQuadraticFitCoefficients5x5()

Function Summary
namereturn typedescription
calculateQuadraticFitCoefficients5x5voidcalculate quadratic fit coefficients 5x 5

Function Arguments
nametypedescription
xconst int x
y const int y
coefficient[] float coefficient []
luminosityContrastMap[] const double luminosity contrast map []

Function Reference List


Function ATORquadraticFitClass::checkForTotalPositiveCurvature()

Function Summary
namereturn typedescription
checkForTotalPositiveCurvatureboolcheck for total positive curvature

Function Arguments
nametypedescription
a3const float a3
a4 const float a4

Function Reference List
N/A


Function ATORquadraticFitClass::checkTotalNegativeCurvatureAbovePointThreshold()

Function Summary
namereturn typedescription
checkTotalNegativeCurvatureAbovePointThresholdboolcheck total negative curvature above point threshold

Function Arguments
nametypedescription
a3const float a3
a4 const float a4

Function Reference List
N/A


Function ATORquadraticFitClass::checkEdgeZeroCrossingObjectPassesThreshold()

Function Summary
namereturn typedescription
checkEdgeZeroCrossingObjectPassesThresholdboolcheck edge zero crossing object passes threshold

Function Arguments
nametypedescription
zcATORQFzeroCrossing* zc

Function Reference List


Function ATORquadraticFitClass::checkEdgeZeroCrossingObjectContrastGradients()

Function Summary
namereturn typedescription
checkEdgeZeroCrossingObjectContrastGradientsboolcheck edge zero crossing object contrast gradients

Function Arguments
nametypedescription
zcATORQFzeroCrossing* zc

Function Reference List


Function ATORquadraticFitClass::checkPointZeroCrossingObjectPassesThreshold()

Function Summary
namereturn typedescription
checkPointZeroCrossingObjectPassesThresholdboolcheck point zero crossing object passes threshold

Function Arguments
nametypedescription
zcconst ATORQFzeroCrossing* zc

Function Reference List


Function ATORquadraticFitClass::getSmallestEigenValue()

Function Summary
namereturn typedescription
getSmallestEigenValuefloatget smallest eigen value

Function Arguments
nametypedescription
eigenValue[]const float eigen value []

Function Reference List


Function ATORquadraticFitClass::calculateEdgeZeroCrossing()

Function Summary
namereturn typedescription
calculateEdgeZeroCrossingvoidcalculate edge zero crossing

Function Arguments
nametypedescription
coefficient[]const float coefficient []
beta const float beta
zc[] float zc []

Function Reference List
N/A


Function ATORquadraticFitClass::calculatePointZeroCrossing()

Function Summary
namereturn typedescription
calculatePointZeroCrossingvoidcalculate point zero crossing

Function Arguments
nametypedescription
coefficient[]const float coefficient []
zc[] float zc []

Function Reference List
N/A


Function ATORquadraticFitClass::calculateEigenVector()

Function Summary
namereturn typedescription
calculateEigenVectorvoidcalculate eigen vector

Function Arguments
nametypedescription
coefficient[]const float coefficient []
ev const float ev
eigenVector[] float eigen vector []

Function Reference List
N/A


Function ATORquadraticFitClass::calculateEigenValues()

Function Summary
namereturn typedescription
calculateEigenValuesvoidcalculate eigen values

Function Arguments
nametypedescription
coefficient[]const float coefficient []
ev[] float ev []

Function Reference List
N/A


Function ATORquadraticFitClass::getPixelFloat()

Function Summary
namereturn typedescription
getPixelFloatfloatget pixel float

Function Arguments
nametypedescription
xconst int x
y const int y
luminosityContrastMap[] const double luminosity contrast map []

Function Reference List
N/A


File ATORimagecomparison Documentation

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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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


File LDopengl Documentation

File Name: LDopengl.cpp/.hpp

File Description: LD opengl

File Function List


File Diagram (functions hierarchy)


Function LDopenglClass::initiateOpenGL()

Function Summary
namereturn typedescription
initiateOpenGLboolinitiate open GL

Function Arguments
nametypedescription
widthconst int width
height const int height
windowPositionX const int window position X
windowPositionY const int window position Y
confidentialWarnings const bool confidential warnings

Function Reference List
N/A


Function LDopenglClass::exitOpenGL()

Function Summary
namereturn typedescription
exitOpenGLboolexit open GL

Function Reference List
N/A


Function LDopenglClass::setViewPort2Dortho()

Function Summary
namereturn typedescription
setViewPort2Dorthovoidset view port 2D ortho

Function Arguments
nametypedescription
leftconst double left
right const double right
bottom const double bottom
top const double top

Function Reference List
N/A


Function LDopenglClass::setViewPort3D()

Function Summary
namereturn typedescription
setViewPort3Dvoidset view port 3D

Function Arguments
nametypedescription
eyeFacingPolyconst vec* eye facing poly
viewAtFacingPoly const vec* view at facing poly
viewUpFacingPoly const vec* view up facing poly
viewPortWidthHeightDepth const vec* view port width height depth

Function Reference List
N/A


Function LDopenglClass::setViewPort3Dortho()

Function Summary
namereturn typedescription
setViewPort3Dorthovoidset view port 3D ortho

Function Arguments
nametypedescription
leftconst double left
right const double right
bottom const double bottom
top const double top
back const double back
forward const double forward

Function Reference List
N/A


Function LDopenglClass::drawPrimitivesReferenceListToOpenGLandCreateRGBmap()

Function Summary
namereturn typedescription
drawPrimitivesReferenceListToOpenGLandCreateRGBmapvoiddraw primitives reference list to open GL and create RGB map

Function Arguments
nametypedescription
firstReferenceInPrimitivesReferenceListconst LDreference* first reference in primitives reference list
width int width
height const int height
rgbMap uchar* rgb map
dimension const int dimension
usePredefinedODmatrixOperations const bool use predefined OD matrix operations

Function Reference List


Function LDopenglClass::drawPrimitivesReferenceListToOpenGL()

Function Summary
namereturn typedescription
drawPrimitivesReferenceListToOpenGLvoiddraw primitives reference list to open GL

Function Arguments
nametypedescription
firstReferenceInPrimitivesReferenceListconst LDreference* first reference in primitives reference list
dimension const int dimension
usePredefinedODmatrixOperations const bool use predefined OD matrix operations

Function Reference List
N/A


Function LDopenglClass::writeScreenToRGBMap()

Function Summary
namereturn typedescription
writeScreenToRGBMapvoidwrite screen to RGBM ap

Function Arguments
nametypedescription
widthint width
height const int height
rgbMap uchar* rgb map

Function Reference List
N/A


Function LDopenglClass::writeScreenToDepthMap()

Function Summary
namereturn typedescription
writeScreenToDepthMapvoidwrite screen to depth map

Function Arguments
nametypedescription
widthint width
height const int height
depthMap double* depth map

Function Reference List
N/A


Function LDopenglClass::updateScreen()

Function Summary
namereturn typedescription
updateScreenvoidupdate screen

Function Reference List
N/A


File ATORmethod2DOD Documentation

File Name: ATORmethod2DOD.cpp/.hpp

File Description: ATOR method 2DOD

File Function List


File Diagram (functions hierarchy)


Function ATORmethod2DODClass::createInterpolated2DmeshReferenceListUsingRGBmap2DOD()

Function Summary
namereturn typedescription
createInterpolated2DmeshReferenceListUsingRGBmap2DODvoidcreate interpolated 2D mesh reference list using RGB map 2DOD

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
rgbMap uchar* rgb map
firstReferenceInInterpolatedMap LDreference* first reference in interpolated map

Function Reference List


Function ATORmethod2DODClass::create2DmeshUsingRGBmap2DOD()

Function Summary
namereturn typedescription
create2DmeshUsingRGBmap2DODvoidcreate 2D mesh using RGB map 2DOD

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
imageXOffset double image XO ffset
imageYOffset double image YO ffset
rgbMap uchar* rgb map
firstMeshPointInMeshList ATORmeshPoint* first mesh point in mesh list
meshPointArray[] ATORmeshPoint* mesh point array []
useEdgeZeroCrossingMap const bool use edge zero crossing map

Function Reference List


Function ATORmethod2DODClass::transformObjectData2DOD()

Function Summary
namereturn typedescription
transformObjectData2DODvoidtransform object data 2DOD

Function Arguments
nametypedescription
firstReferenceInInterpolated2DrgbMapLDreference* first reference in interpolated 2D rgb map
currentPolygonInList ATORpolygon* current polygon in list
side const int side
first const bool first
firstFeatureInList ATORfeature* first feature in list

Function Reference List


Function ATORmethod2DODClass::calculateXYorientationOfSide()

Function Summary
namereturn typedescription
calculateXYorientationOfSidedoublecalculate XY orientation of side

Function Arguments
nametypedescription
currentPolygonInListconst ATORpolygon* current polygon in list
side const int side

Function Reference List


Function ATORmethod2DODClass::calculateXYlengthOfSide()

Function Summary
namereturn typedescription
calculateXYlengthOfSidedoublecalculate XY length of side

Function Arguments
nametypedescription
currentPolygonInListconst ATORpolygon* current polygon in list
side const int side

Function Reference List


Function ATORmethod2DODClass::calculatePerpendicularDistanceBetweenThirdApexOfObjectTriangleAndSide()

Function Summary
namereturn typedescription
calculatePerpendicularDistanceBetweenThirdApexOfObjectTriangleAndSidedoublecalculate perpendicular distance between third apex of object triangle and side

Function Arguments
nametypedescription
transformedObjectTriangleconst ATORpolygon* transformed object triangle
side const int side

Function Reference List
N/A


Function ATORmethod2DODClass::calculateXaxisDistanceBetweenThirdApexOfObjectTriangleAndSideLeftApex()

Function Summary
namereturn typedescription
calculateXaxisDistanceBetweenThirdApexOfObjectTriangleAndSideLeftApexdoublecalculate xaxis distance between third apex of object triangle and side left apex

Function Arguments
nametypedescription
transformedObjectTriangleconst ATORpolygon* transformed object triangle
side const int side

Function Reference List
N/A


Function ATORmethod2DODClass::disableReferencesThatAreNotContainedInTheObjectTriangle2DOD()

Function Summary
namereturn typedescription
disableReferencesThatAreNotContainedInTheObjectTriangle2DODvoiddisable references that are not contained in the object triangle 2DOD

Function Arguments
nametypedescription
firstReferenceInInterpolated2DrgbMapLDreference* first reference in interpolated 2D rgb map
currentPolygonInList const ATORpolygon* current polygon in list

Function Reference List


Function ATORmethod2DODClass::disableReferencesThatAreNotContainedInTheObjectSquare2DODadvanced()

Function Summary
namereturn typedescription
disableReferencesThatAreNotContainedInTheObjectSquare2DODadvancedvoiddisable references that are not contained in the object square 2DOD advanced

Function Arguments
nametypedescription
firstReferenceInInterpolated2DrgbMapLDreference* first reference in interpolated 2D rgb map
currentPolygonInList const ATORpolygon* current polygon in list
padBoundary const bool pad boundary
side const int side
shearFactor const double shear factor

Function Reference List


File LDparser Documentation

File Name: LDparser.cpp/.hpp

File Description: LD parser

File Function List


File Diagram (functions hierarchy)


Function LDparserClass::parseFile()

Function Summary
namereturn typedescription
parseFileboolparse file

Function Arguments
nametypedescription
parseFileNamestring parse file name
initialReference LDreference* initial reference
parentReference LDreference* parent reference
recurseIntoPartsDir const bool recurse into parts dir

Function Reference List


Function LDparserClass::calcModXPosBasedUponRotate()

Function Summary
namereturn typedescription
calcModXPosBasedUponRotatedoublecalc mod XP os based upon rotate

Function Arguments
nametypedescription
childRelativePositionconst vec* child relative position
parentReferenceDeformationMatrix const mat* parent reference deformation matrix

Function Reference List
N/A


Function LDparserClass::calcModYPosBasedUponRotate()

Function Summary
namereturn typedescription
calcModYPosBasedUponRotatedoublecalc mod YP os based upon rotate

Function Arguments
nametypedescription
childRelativePositionconst vec* child relative position
parentReferenceDeformationMatrix const mat* parent reference deformation matrix

Function Reference List
N/A


Function LDparserClass::calcModZPosBasedUponRotate()

Function Summary
namereturn typedescription
calcModZPosBasedUponRotatedoublecalc mod ZP os based upon rotate

Function Arguments
nametypedescription
childRelativePositionconst vec* child relative position
parentReferenceDeformationMatrix const mat* parent reference deformation matrix

Function Reference List
N/A


Function LDparserClass::removeWhiteSpaceFromString()

Function Summary
namereturn typedescription
removeWhiteSpaceFromStringstringremove white space from string

Function Arguments
nametypedescription
sconst string s

Function Reference List
N/A


File LDreferenceManipulation Documentation

File Name: LDreferenceManipulation.cpp/.hpp

File Description: LD reference manipulation

File Function List


File Diagram (functions hierarchy)


Function LDreferenceManipulationClass::copyReferences()

Function Summary
namereturn typedescription
copyReferencesvoidcopy references

Function Arguments
nametypedescription
referenceNewLDreference* reference new
referenceToCopy LDreference* reference to copy
type const int type

Function Reference List


Function LDreferenceManipulationClass::convertPositionCoordinatesToString()

Function Summary
namereturn typedescription
convertPositionCoordinatesToStringstringconvert position coordinates to string

Function Arguments
nametypedescription
spriteSceneCoordsconst vec* sprite scene coords

Function Reference List


Function LDreferenceManipulationClass::convertPositionCoordinatesToStringWithCommaDelimiterPreceeding()

Function Summary
namereturn typedescription
convertPositionCoordinatesToStringWithCommaDelimiterPreceedingstringconvert position coordinates to string with comma delimiter preceeding

Function Arguments
nametypedescription
spriteSceneCoordsconst vec* sprite scene coords

Function Reference List


Function LDreferenceManipulationClass::addReferenceToFileObject()

Function Summary
namereturn typedescription
addReferenceToFileObjectbooladd reference to file object

Function Arguments
nametypedescription
writeFileObjectofstream* write file object
currentReference LDreference* current reference

Function Reference List


Function LDreferenceManipulationClass::convertRotationMatrixToString()

Function Summary
namereturn typedescription
convertRotationMatrixToStringstringconvert rotation matrix to string

Function Arguments
nametypedescription
rotationMatrixconst mat* rotation matrix

Function Reference List


Function LDreferenceManipulationClass::write2DreferenceListCollapsedTo1DtoFile()

Function Summary
namereturn typedescription
write2DreferenceListCollapsedTo1DtoFileboolwrite 2D reference list collapsed to 1D to file

Function Arguments
nametypedescription
fileNameconst string file name
firstReference LDreference* first reference

Function Reference List


Function LDreferenceManipulationClass::write2DreferencesLayerToFileObject()

Function Summary
namereturn typedescription
write2DreferencesLayerToFileObjectboolwrite 2D references layer to file object

Function Arguments
nametypedescription
writeFileObjectofstream* write file object
firstReferenceInLayer LDreference* first reference in layer

Function Reference List


File RTreferenceManipulation Documentation

File Name: RTreferenceManipulation.cpp/.hpp

File Description: RT reference manipulation

File Function List


File Diagram (functions hierarchy)


Function RTreferenceManipulationClass::write2DReferenceListCollapsedTo1DToFileRayTraceFormat()

Function Summary
namereturn typedescription
write2DReferenceListCollapsedTo1DToFileRayTraceFormatboolwrite 2DR eference list collapsed to 1DT o file ray trace format

Function Arguments
nametypedescription
fileNamestring file name
firstReference LDreference* first reference
useCustomViewInfo const bool use custom view info
vi const RTviewInfo* vi
useCustomLightSource const bool use custom light source
lightSourcePosition const vec* light source position
lightSourceColour const string light source colour

Function Reference List


Function RTreferenceManipulationClass::writeRayTraceFormatHeaderInfo()

Function Summary
namereturn typedescription
writeRayTraceFormatHeaderInfoboolwrite ray trace format header info

Function Arguments
nametypedescription
writeFileObjectofstream* write file object
useCustomViewInfo const bool use custom view info
vi const RTviewInfo* vi
useCustomLightSource const bool use custom light source
lightSourcePosition const vec* light source position
lightSourceColour const string light source colour

Function Reference List


Function RTreferenceManipulationClass::write2DReferencesLayerToFileObjectRayTraceFormat()

Function Summary
namereturn typedescription
write2DReferencesLayerToFileObjectRayTraceFormatboolwrite 2DR eferences layer to file object ray trace format

Function Arguments
nametypedescription
writeFileObjectofstream* write file object
firstReferenceInLayer LDreference* first reference in layer

Function Reference List


Function RTreferenceManipulationClass::addReferenceToFileObjectRayTraceFormat()

Function Summary
namereturn typedescription
addReferenceToFileObjectRayTraceFormatbooladd reference to file object ray trace format

Function Arguments
nametypedescription
writeFileObjectofstream* write file object
currentReference LDreference* current reference

Function Reference List


File ATORcomparison Documentation

File Name: ATORcomparison.cpp/.hpp

File Description: ATOR comparison

File Function List


File Diagram (functions hierarchy)


Function ATORcomparisonClass::fillDCTcoeffSelectionArrays()

Function Summary
namereturn typedescription
fillDCTcoeffSelectionArraysvoidfill DCT coeff selection arrays

Function Reference List
N/A


Function ATORcomparisonClass::compareNormalisedSnapshots()

Function Summary
namereturn typedescription
compareNormalisedSnapshotsdoublecompare normalised snapshots

Function Arguments
nametypedescription
numberOfTestPolys[]const int number of test polys []
numberOfTestViewIndicies const int number of test view indicies
imageWidthFacingPoly int image width facing poly
imageHeightFacingPoly int image height facing poly
testObjectNameArray[] const string test object name array []
numberOfTestObjects const int number of test objects
dimension const int dimension
numberOfTestZoomIndicies const int number of test zoom indicies
trainOrTest const int train or test
testViewNumber const int test view number

Function Reference List


Function ATORcomparisonClass::convertNormalisedHueDeviationMapTo3x8bitMap()

Function Summary
namereturn typedescription
convertNormalisedHueDeviationMapTo3x8bitMapvoidconvert normalised hue deviation map to 3x 8bit map

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
rgbDevIEnormalisedHueContrastMapSmallFacingPoly double* rgb dev IE normalised hue contrast map small facing poly
rgbDev8BitSmallMapFacingPoly uchar* rgb dev 8B it small map facing poly

Function Reference List


Function ATORcomparisonClass::cullAndBinNormalisedHueContrast()

Function Summary
namereturn typedescription
cullAndBinNormalisedHueContrastvoidcull and bin normalised hue contrast

Function Arguments
nametypedescription
normalisedHueContrastvec* normalised hue contrast
culledNormalisedHueContrast colour* culled normalised hue contrast

Function Reference List
N/A


Function ATORcomparisonClass::convertDCTcoeffIndividualArraysToConcatonatedSignedDCTcoeffArray()

Function Summary
namereturn typedescription
convertDCTcoeffIndividualArraysToConcatonatedSignedDCTcoeffArrayvoidconvert DCT coeff individual arrays to concatonated signed DCT coeff array

Function Arguments
nametypedescription
dctCoeffArrayY[]schar dct coeff array Y[]
dctCoeffArrayYcr[] schar dct coeff array ycr []
dctCoeffArrayYcb[] schar dct coeff array ycb []
concatonatedSignedDctCoeffArray[] schar concatonated signed dct coeff array []

Function Reference List
N/A


Function ATORcomparisonClass::convertImageFileType()

Function Summary
namereturn typedescription
convertImageFileTypevoidconvert image file type

Function Arguments
nametypedescription
imageBaseFileNameconst string* image base file name
imageBaseFileNameConverted const string* image base file name converted
imageExtension const string image extension
imageExtensionConverted const string image extension converted

Function Reference List
N/A


Function ATORcomparisonClass::createGeoTableHTMLfromFeatureList()

Function Summary
namereturn typedescription
createGeoTableHTMLfromFeatureListvoidcreate geo table HTML from feature list

Function Arguments
nametypedescription
firstFeatureInNearestFeatureListconst ATORfeature* first feature in nearest feature list
applyBinning const bool apply binning
geoTableHTMLoutputString string* geo table HTML output string

Function Reference List


Function ATORcomparisonClass::readDCTcoeffIndividualArraysAndConvertToConcatonatedSignedDCTcoeffArray()

Function Summary
namereturn typedescription
readDCTcoeffIndividualArraysAndConvertToConcatonatedSignedDCTcoeffArrayvoidread DCT coeff individual arrays and convert to concatonated signed DCT coeff array

Function Arguments
nametypedescription
rgbMapSmallFacingPolyFileNamePPMconst string* rgb map small facing poly file name PPM
rgbMapSmallFacingPolyFileNameJPEG const string* rgb map small facing poly file name JPEG
concatonatedSignedDctCoeffArrayRequirement schar* concatonated signed dct coeff array requirement
printOutput const bool print output

Function Reference List


File ATORdatabaseSQL Documentation

File Name: ATORdatabaseSQL.cpp/.hpp

File Description: ATOR database SQL

File Function List


File Diagram (functions hierarchy)


Function ATORdatabaseSQLClass::createFeatureContainerListUsingSQLDatabaseDecisionTreeTableQuery()

Function Summary
namereturn typedescription
createFeatureContainerListUsingSQLDatabaseDecisionTreeTableQueryvoidcreate feature container list using SQLD atabase decision tree table query

Function Arguments
nametypedescription
firstFeatureContainerInTestFeatureMatchingTrainBinATORfeatureContainer* first feature container in test feature matching train bin
ignoreOTfeatures const bool ignore OT features
decisionTreeBinText const char* decision tree bin text
decisionTreeBinTextLength const int decision tree bin text length
trainOrTest const int train or test

Function Reference List


Function ATORdatabaseSQLClass::createSnapshotIDreferenceListUsingSQLdatabaseDecisionTreeTableQuery()

Function Summary
namereturn typedescription
createSnapshotIDreferenceListUsingSQLdatabaseDecisionTreeTableQueryvoidcreate snapshot ID reference list using SQL database decision tree table query

Function Arguments
nametypedescription
firstReferenceInSnapshotIDreferenceListATORsnapshotIDreferenceList* first reference in snapshot ID reference list
sqlDatabaseDecisionTreeTableName const string sql database decision tree table name
decisionTreeBinText const char* decision tree bin text
decisionTreeBinTextLength const int decision tree bin text length
trainOrTest const int train or test

Function Reference List


Function ATORdatabaseSQLClass::insertSnapshotIDreferenceIntoSQLdatabaseDecisionTree()

Function Summary
namereturn typedescription
insertSnapshotIDreferenceIntoSQLdatabaseDecisionTreevoidinsert snapshot ID reference into SQL database decision tree

Function Arguments
nametypedescription
sqlDatabaseDecisionTreeTableNameconst string sql database decision tree table name
decisionTreeBinText const char* decision tree bin text
decisionTreeBinTextLength const int decision tree bin text length
snapshotReferenceID const int64_t snapshot reference ID
databaseTableSize int64_t* database table size

Function Reference List


Function ATORdatabaseSQLClass::insertAllSnapshotIDreferencesIntoSQLdatabaseDecisionTreeStart()

Function Summary
namereturn typedescription
insertAllSnapshotIDreferencesIntoSQLdatabaseDecisionTreeStartvoidinsert all snapshot ID references into SQL database decision tree start

Function Arguments
nametypedescription
sqlDatabaseDecisionTreeTableNameconst string sql database decision tree table name
decisionTreeMultipleRowInsertQueryTextCharStar char* decision tree multiple row insert query text char star
decisionTreeSQLmultipleRowInsertQueryLength int64_t* decision tree SQL multiple row insert query length

Function Reference List
N/A


Function ATORdatabaseSQLClass::insertSnapshotIDreferenceIntoSQLdatabaseDecisionTreeIteration()

Function Summary
namereturn typedescription
insertSnapshotIDreferenceIntoSQLdatabaseDecisionTreeIterationvoidinsert snapshot ID reference into SQL database decision tree iteration

Function Arguments
nametypedescription
decisionTreeBinTextconst char* decision tree bin text
decisionTreeBinTextLength const int decision tree bin text length
snapshotReferenceID const int64_t snapshot reference ID
databaseTableSize int64_t* database table size
decisionTreeMultipleRowInsertQueryTextCharStar char* decision tree multiple row insert query text char star
decisionTreeSQLmultipleRowInsertQueryLength int64_t* decision tree SQL multiple row insert query length

Function Reference List


Function ATORdatabaseSQLClass::insertAllSnapshotIDreferencesIntoSQLdatabaseDecisionTreeEnd()

Function Summary
namereturn typedescription
insertAllSnapshotIDreferencesIntoSQLdatabaseDecisionTreeEndvoidinsert all snapshot ID references into SQL database decision tree end

Function Arguments
nametypedescription
decisionTreeMultipleRowInsertQueryTextCharStarchar* decision tree multiple row insert query text char star
decisionTreeSQLmultipleRowInsertQueryLength int64_t* decision tree SQL multiple row insert query length

Function Reference List


Function ATORdatabaseSQLClass::convertSnapshotMapsToStringForSQLdatabaseEntry()

Function Summary
namereturn typedescription
convertSnapshotMapsToStringForSQLdatabaseEntryvoidconvert snapshot maps to string for SQL database entry

Function Arguments
nametypedescription
imageWidthFacingPolyint image width facing poly
imageHeightFacingPoly const int image height facing poly
rgbMapFacingPoly uchar* rgb map facing poly
rgbDevIEnormalisedHueContrastMapFacingPoly double* rgb dev IE normalised hue contrast map facing poly
depthMapFacingPoly const double* depth map facing poly
smallImageWidth int small image width
smallImageHeight const int small image height
rgbMapSmallFacingPoly uchar* rgb map small facing poly
rgbDevIEnormalisedHueContrastMapSmallFacingPoly const double* rgb dev IE normalised hue contrast map small facing poly
depthMapSmallFacingPoly double* depth map small facing poly
dimension const int dimension
snapshotMapsText char* snapshot maps text
depthScale const double depth scale
compareRgbDevMapsNotRgbMaps const bool compare rgb dev maps not rgb maps
stringSize int* string size

Function Reference List


Function ATORdatabaseSQLClass::convertSQLdatabaseStringToSnapshotMaps()

Function Summary
namereturn typedescription
convertSQLdatabaseStringToSnapshotMapsvoidconvert SQL database string to snapshot maps

Function Arguments
nametypedescription
imageWidthFacingPolyconst int image width facing poly
imageHeightFacingPoly const int image height facing poly
rgbMapFacingPoly uchar* rgb map facing poly
rgbDevIEnormalisedHueContrastMapFacingPoly double* rgb dev IE normalised hue contrast map facing poly
depthMapFacingPoly double* depth map facing poly
smallImageWidth const int small image width
smallImageHeight const int small image height
rgbMapSmallFacingPoly uchar* rgb map small facing poly
rgbDevIEnormalisedHueContrastMapSmallFacingPoly double* rgb dev IE normalised hue contrast map small facing poly
depthMapSmallFacingPoly double* depth map small facing poly
dimension const int dimension
snapshotMapsText const char* snapshot maps text
depthScale const double depth scale
compareRgbDevMapsNotRgbMaps const bool compare rgb dev maps not rgb maps

Function Reference List


Function ATORdatabaseSQLClass::createFeaturesListUsingDatabaseQueryGeoXYbinRequirement()

Function Summary
namereturn typedescription
createFeaturesListUsingDatabaseQueryGeoXYbinRequirementvoidcreate features list using database query geo XY bin requirement

Function Arguments
nametypedescription
firstFeatureContainerInListATORfeatureContainer* first feature container in list
createFeatureObjects const bool create feature objects
appendToList const bool append to list
ignoreOTfeatures const bool ignore OT features
pBinxyValueRequirement const int64_t pBinxy value requirement
pBinxRequirement[] const int pBinx requirement []
pBinyRequirement[] const int pBiny requirement []
normalisedAverageHueDeviationRequirement const colour* normalised average hue deviation requirement
concatonatedSignedDctCoeffArrayRequirement[] const schar concatonated signed dct coeff array requirement []
rgb8bitSmallMapForInstantDBqueryAccessRequirement uchar* rgb 8bit small map for instant DB query access requirement
smallImageWidth int small image width
smallImageHeight const int small image height
trainTableName const string train table name
trainOrTest const int train or test

Function Reference List


Function ATORdatabaseSQLClass::insertTransformedFeatureListIntoDatabase()

Function Summary
namereturn typedescription
insertTransformedFeatureListIntoDatabasevoidinsert transformed feature list into database

Function Arguments
nametypedescription
firstFeatureInListATORfeature* first feature in list
objectName const string object name
viewIndex const int view index
zoomIndex const int zoom index
polyIndex const int poly index
sideIndex const int side index
trainOrTest const int train or test
ignoreOTfeatures const bool ignore OT features
rgb8bitSmallMapForInstantDBqueryAccess uchar* rgb 8bit small map for instant DB query access
smallImageWidth int small image width
smallImageHeight const int small image height
addPermutationsOfTrainFeaturesForGeoBinning const bool add permutations of train features for geo binning
maxNumFeaturePermutations const int max num feature permutations
tableName const string table name
databaseTableSize int64_t* database table size

Function Reference List


Function ATORdatabaseSQLClass::addSQLRowDataToFeatureList()

Function Summary
namereturn typedescription
addSQLRowDataToFeatureListvoidadd SQLR ow data to feature list

Function Arguments
nametypedescription
rowconst MYSQL_ROW row
firstFeatureInList ATORfeature* first feature in list
createFeatureObjects const bool create feature objects
ignoreOTfeatures const bool ignore OT features
numFeatures const int num features

Function Reference List
N/A


Function ATORdatabaseSQLClass::createSQLSelectRowCommand()

Function Summary
namereturn typedescription
createSQLSelectRowCommandstringcreate SQLS elect row command

Function Arguments
nametypedescription
numFeaturesconst int num features

Function Reference List


Function ATORdatabaseSQLClass::createFeatureListUsingDatabaseQuery()

Function Summary
namereturn typedescription
createFeatureListUsingDatabaseQueryvoidcreate feature list using database query

Function Arguments
nametypedescription
firstFeatureInListATORfeature* first feature in list
createFeatureObjects const bool create feature objects
appendToList const bool append to list
ignoreOTfeatures const bool ignore OT features
sqlDatabaseTestTableName const string sql database test table name
testID const int64_t test ID
testObjectName const string test object name
testViewIndex const int test view index
testZoomIndex const int test zoom index
testPolyIndex const int test poly index
testSideIndex const int test side index
useTestID const bool use test ID

Function Reference List


Function ATORdatabaseSQLClass::powLong()

Function Summary
namereturn typedescription
powLongint64_tpow long

Function Arguments
nametypedescription
valconst int64_t val
degree const int degree

Function Reference List
N/A


Function ATORdatabaseSQLClass::convertDCTcoeffConcatonatedArrayToBinnedAllDCTcoeff64bitValue()

Function Summary
namereturn typedescription
convertDCTcoeffConcatonatedArrayToBinnedAllDCTcoeff64bitValueuint64_tconvert DCT coeff concatonated array to binned all DCT coeff 64 bit value

Function Arguments
nametypedescription
concatonatedSignedDctCoeffArray[]const schar concatonated signed dct coeff array []

Function Reference List


Function ATORdatabaseSQLClass::calculateGeoxyBinMultiDimensional()

Function Summary
namereturn typedescription
calculateGeoxyBinMultiDimensionalint64_tcalculate geoxy bin multi dimensional

Function Arguments
nametypedescription
geoxBin[]const int geox bin []
geoyBin[] const int geoy bin []

Function Reference List
N/A


Function ATORdatabaseSQLClass::convertConcatonatedSignedDctCoeffArrayAndGeoToLinearCombination()

Function Summary
namereturn typedescription
convertConcatonatedSignedDctCoeffArrayAndGeoToLinearCombinationvoidconvert concatonated signed dct coeff array and geo to linear combination

Function Arguments
nametypedescription
concatonatedSignedDctCoeffArray[]const schar concatonated signed dct coeff array []
geoxBin[] const int geox bin []
geoyBin[] const int geoy bin []
linearCombination uint64_t* linear combination

Function Reference List


Function ATORdatabaseSQLClass::determineGeoBinX()

Function Summary
namereturn typedescription
determineGeoBinXintdetermine geo bin X

Function Arguments
nametypedescription
featurePointTransformedXposconst double feature point transformed xpos

Function Reference List
N/A


Function ATORdatabaseSQLClass::determineGeoBinY()

Function Summary
namereturn typedescription
determineGeoBinYintdetermine geo bin Y

Function Arguments
nametypedescription
featurePointTransformedYposconst double feature point transformed ypos

Function Reference List
N/A


Function ATORdatabaseSQLClass::determineGeoBinDoubleX()

Function Summary
namereturn typedescription
determineGeoBinDoubleXdoubledetermine geo bin double X

Function Arguments
nametypedescription
featurePointTransformedXposconst double feature point transformed xpos

Function Reference List
N/A


Function ATORdatabaseSQLClass::determineGeoBinDoubleY()

Function Summary
namereturn typedescription
determineGeoBinDoubleYdoubledetermine geo bin double Y

Function Arguments
nametypedescription
featurePointTransformedYposconst double feature point transformed ypos

Function Reference List
N/A


Function ATORdatabaseSQLClass::determineDCTBinUnsigned()

Function Summary
namereturn typedescription
determineDCTBinUnsigneduint32_tdetermine DCTB in unsigned

Function Arguments
nametypedescription
arrayValueSignedint array value signed
arrayValueUnsignedDouble double* array value unsigned double

Function Reference List


Function ATORdatabaseSQLClass::determineDCTBinUnsignedDouble()

Function Summary
namereturn typedescription
determineDCTBinUnsignedDoubledoubledetermine DCTB in unsigned double

Function Arguments
nametypedescription
arrayValueSignedconst int array value signed

Function Reference List
N/A


File LDmysql Documentation

File Name: LDmysql.cpp/.hpp

File Description: LD mysql

File Function List


File Diagram (functions hierarchy)


Function LDmysqlClass::initiateMySQLserverConnection()

Function Summary
namereturn typedescription
initiateMySQLserverConnectionboolinitiate my SQL server connection

Function Arguments
nametypedescription
mysqlServerIpAddressAndPortconst char* mysql server ip address and port
username const char* username
password const char* password
databaseName const char* database name

Function Reference List
N/A


Function LDmysqlClass::performSQLinsertQuery()

Function Summary
namereturn typedescription
performSQLinsertQueryboolperform SQL insert query

Function Arguments
nametypedescription
sqlCommandconst char* sql command

Function Reference List
N/A


Function LDmysqlClass::performSQLrealInsertQuery()

Function Summary
namereturn typedescription
performSQLrealInsertQueryboolperform SQL real insert query

Function Arguments
nametypedescription
sqlCommandconst char* sql command
stringLength const uint64_t string length

Function Reference List
N/A


Function LDmysqlClass::performSQLgetNumRowsQuery()

Function Summary
namereturn typedescription
performSQLgetNumRowsQueryint64_tperform SQL get num rows query

Function Arguments
nametypedescription
tableNameconst string table name

Function Reference List
N/A


Function LDmysqlClass::performSQLdeleteAllRowsQuery()

Function Summary
namereturn typedescription
performSQLdeleteAllRowsQueryvoidperform SQL delete all rows query

Function Arguments
nametypedescription
tableNameconst string table name

Function Reference List
N/A


Function LDmysqlClass::endMySQLserverConnection()

Function Summary
namereturn typedescription
endMySQLserverConnectionvoidend my SQL server connection

Function Reference List
N/A


File ATORdatabaseDecisionTree Documentation

File Name: ATORdatabaseDecisionTree.cpp/.hpp

File Description: ATOR database decision tree

File Function List


File Diagram (functions hierarchy)


Function ATORdatabaseDecisionTreeClass::addSnapshotIDreferenceToImageComparisonDecisionTreeWithGeoAvgHueDevAndDCTcombinations()

Function Summary
namereturn typedescription
addSnapshotIDreferenceToImageComparisonDecisionTreeWithGeoAvgHueDevAndDCTcombinationsvoidadd snapshot ID reference to image comparison decision tree with geo avg hue dev and DCT combinations

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
rgbMapSmall uchar* rgb map small
firstFeatureInList ATORfeature* first feature in list
snapshotReferenceID const int64_t snapshot reference ID
ignoreOTfeatures const bool ignore OT features

Function Reference List


Function ATORdatabaseDecisionTreeClass::addSnapshotIDReferenceToList()

Function Summary
namereturn typedescription
addSnapshotIDReferenceToListvoidadd snapshot IDR eference to list

Function Arguments
nametypedescription
parseFileNameconst string* parse file name
snapshotID const int64_t snapshot ID

Function Reference List


Function ATORdatabaseDecisionTreeClass::getSnapshotIDreferenceToImageComparisonDecisionTreeWithGeoAvgHueDevAndDCTcheck()

Function Summary
namereturn typedescription
getSnapshotIDreferenceToImageComparisonDecisionTreeWithGeoAvgHueDevAndDCTcheckvoidget snapshot ID reference to image comparison decision tree with geo avg hue dev and DCT check

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
rgbMapSmall uchar* rgb map small
pBinxyValueRequirement const int64_t pBinxy value requirement
pBinxRequirement[] const int pBinx requirement []
pBinyRequirement[] const int pBiny requirement []
normalisedAverageHueDeviationRequirement const colour* normalised average hue deviation requirement
concatonatedSignedDctCoeffArrayRequirement[] const schar concatonated signed dct coeff array requirement []
firstReferenceInSnapshotIDreferenceList ATORsnapshotIDreferenceList* first reference in snapshot ID reference list
trainOrTest const int train or test
DTbin string* DT bin

Function Reference List


Function ATORdatabaseDecisionTreeClass::addSnapshotIDreferenceToImageComparisonDecisionTreeLoopDCT()

Function Summary
namereturn typedescription
addSnapshotIDreferenceToImageComparisonDecisionTreeLoopDCTvoidadd snapshot ID reference to image comparison decision tree loop DCT

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
rgbMapSmall uchar* rgb map small
firstFeatureInList ATORfeature* first feature in list
snapshotReferenceID const int64_t snapshot reference ID
ignoreOTfeatures const bool ignore OT features
currentDirectoryCharStar char* current directory char star
currentDirectoryLength int* current directory length
initialDirectory const string* initial directory
decisionTreeMultipleRowInsertQueryTextCharStar char* decision tree multiple row insert query text char star
decisionTreeSQLmultipleRowInsertQueryLength int64_t* decision tree SQL multiple row insert query length

Function Reference List


Function ATORdatabaseDecisionTreeClass::addSnapshotIDreferenceToImageComparisonDecisionTreeLoopSmallHueDevMap()

Function Summary
namereturn typedescription
addSnapshotIDreferenceToImageComparisonDecisionTreeLoopSmallHueDevMapvoidadd snapshot ID reference to image comparison decision tree loop small hue dev map

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
rgbMapSmall uchar* rgb map small
firstFeatureInList const ATORfeature* first feature in list
snapshotReferenceID const int64_t snapshot reference ID
ignoreOTfeatures const bool ignore OT features
currentDirectoryCharStar char* current directory char star
currentDirectoryLength int* current directory length
initialDirectory const string* initial directory
decisionTreeMultipleRowInsertQueryTextCharStar char* decision tree multiple row insert query text char star
decisionTreeSQLmultipleRowInsertQueryLength int64_t* decision tree SQL multiple row insert query length

Function Reference List


Function ATORdatabaseDecisionTreeClass::addSnapshotIDreferenceToImageComparisonDecisionTreeLoopGeo()

Function Summary
namereturn typedescription
addSnapshotIDreferenceToImageComparisonDecisionTreeLoopGeovoidadd snapshot ID reference to image comparison decision tree loop geo

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
rgbMapSmall const uchar* rgb map small
firstFeatureInList const ATORfeature* first feature in list
snapshotReferenceID const int64_t snapshot reference ID
ignoreOTfeatures const bool ignore OT features
currentDirectoryCharStar char* current directory char star
currentDirectoryLength int* current directory length
initialDirectory const string* initial directory
decisionTreeMultipleRowInsertQueryTextCharStar char* decision tree multiple row insert query text char star
decisionTreeSQLmultipleRowInsertQueryLength int64_t* decision tree SQL multiple row insert query length

Function Reference List


Function ATORdatabaseDecisionTreeClass::addSnapshotIDreferenceToImageComparisonDecisionTreeLoopAvgHueDev()

Function Summary
namereturn typedescription
addSnapshotIDreferenceToImageComparisonDecisionTreeLoopAvgHueDevvoidadd snapshot ID reference to image comparison decision tree loop avg hue dev

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
rgbMapSmall const uchar* rgb map small
firstFeatureInList const ATORfeature* first feature in list
snapshotReferenceID const int64_t snapshot reference ID
ignoreOTfeatures const bool ignore OT features
currentDirectoryCharStar char* current directory char star
currentDirectoryLength int* current directory length
initialDirectory string* initial directory
decisionTreeMultipleRowInsertQueryTextCharStar char* decision tree multiple row insert query text char star
decisionTreeSQLmultipleRowInsertQueryLength int64_t* decision tree SQL multiple row insert query length

Function Reference List


Function ATORdatabaseDecisionTreeClass::addSnapshotIDreferenceToImageComparisonDecisionTreeLoopFinal()

Function Summary
namereturn typedescription
addSnapshotIDreferenceToImageComparisonDecisionTreeLoopFinalvoidadd snapshot ID reference to image comparison decision tree loop final

Function Arguments
nametypedescription
imageWidthconst int image width
imageHeight const int image height
rgbMapSmall const uchar* rgb map small
firstFeatureInList const ATORfeature* first feature in list
snapshotReferenceID const int64_t snapshot reference ID
ignoreOTfeatures const bool ignore OT features
currentDirectoryCharStar const char* current directory char star
currentDirectoryLength const int* current directory length
initialDirectory string* initial directory
decisionTreeMultipleRowInsertQueryTextCharStar char* decision tree multiple row insert query text char star
decisionTreeSQLmultipleRowInsertQueryLength int64_t* decision tree SQL multiple row insert query length

Function Reference List


Function ATORdatabaseDecisionTreeClass::createFeatureContainerListUsingUsingGetSnapshotIDreferenceToImageComparisonDecisionTreeWithGeoAvgHueDevAndDCTcheck()

Function Summary
namereturn typedescription
createFeatureContainerListUsingUsingGetSnapshotIDreferenceToImageComparisonDecisionTreeWithGeoAvgHueDevAndDCTcheckvoidcreate feature container list using using get snapshot ID reference to image comparison decision tree with geo avg hue dev and DCT check

Function Arguments
nametypedescription
firstFeatureContainerInTestFeatureMatchingTrainBinATORfeatureContainer* first feature container in test feature matching train bin
ignoreOTfeatures const bool ignore OT features
imageWidth int image width
imageHeight const int image height
rgbMapSmall uchar* rgb map small
pBinxyValueRequirement const int64_t pBinxy value requirement
pBinxRequirement[] const int pBinx requirement []
pBinyRequirement[] const int pBiny requirement []
normalisedAverageHueDeviationRequirement const colour* normalised average hue deviation requirement
concatonatedSignedDctCoeffArrayRequirement[] const schar concatonated signed dct coeff array requirement []
trainOrTest const int train or test

Function Reference List


Function ATORdatabaseDecisionTreeClass::createSnapshotIDreferenceImageComparisonDecisionTreeString()

Function Summary
namereturn typedescription
createSnapshotIDreferenceImageComparisonDecisionTreeStringvoidcreate snapshot ID reference image comparison decision tree string

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
rgbMapSmall uchar* rgb map small
pBinxyValueRequirement const int64_t pBinxy value requirement
pBinxRequirement[] const int pBinx requirement []
pBinyRequirement[] const int pBiny requirement []
normalisedAverageHueDeviationRequirement const colour* normalised average hue deviation requirement
concatonatedSignedDctCoeffArrayRequirement[] const schar concatonated signed dct coeff array requirement []
currentDirectoryCharStar char* current directory char star
currentDirectoryLength int* current directory length
currentDirectory string* current directory

Function Reference List


Function ATORdatabaseDecisionTreeClass::getSnapshotIDreferencesInImageComparisonDecisionTree()

Function Summary
namereturn typedescription
getSnapshotIDreferencesInImageComparisonDecisionTreevoidget snapshot ID references in image comparison decision tree

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
rgbMapSmall uchar* rgb map small
firstReferenceInSnapshotIDreferenceList ATORsnapshotIDreferenceList* first reference in snapshot ID reference list
currentDirectory string* current directory

Function Reference List


Function ATORdatabaseDecisionTreeClass::parseSnapshotIDreferenceList()

Function Summary
namereturn typedescription
parseSnapshotIDreferenceListvoidparse snapshot ID reference list

Function Arguments
nametypedescription
parseFileNameconst string* parse file name
firstReferenceInSnapshotIDreferenceList ATORsnapshotIDreferenceList* first reference in snapshot ID reference list

Function Reference List


Function ATORdatabaseDecisionTreeClass::createOrParseSnapshotIDreferenceImageComparisonDecisionTree()

Function Summary
namereturn typedescription
createOrParseSnapshotIDreferenceImageComparisonDecisionTreevoidcreate or parse snapshot ID reference image comparison decision tree

Function Arguments
nametypedescription
imageWidthint image width
imageHeight const int image height
rgbMapSmall uchar* rgb map small
createOrParse const bool create or parse
currentDirectory string* current directory
currentDirectoryCharStar char* current directory char star
currDirIndex int* curr dir index

Function Reference List


Function ATORdatabaseDecisionTreeClass::createAndOrParseIntoDirectory()

Function Summary
namereturn typedescription
createAndOrParseIntoDirectoryvoidcreate and or parse into directory

Function Arguments
nametypedescription
folderNameFullPathstring* folder name full path
folderName string* folder name
create const bool create
relativeOrAbsolute const bool relative or absolute

Function Reference List


File ATORdatabaseFileIO Documentation

File Name: ATORdatabaseFileIO.cpp/.hpp

File Description: ATOR database file IO

File Function List


File Diagram (functions hierarchy)


Function ATORdatabaseFileIOClass::initialiseDatabase()

Function Summary
namereturn typedescription
initialiseDatabasevoidinitialise database

Function Arguments
nametypedescription
newDatabaseFolderNameconst string new database folder name

Function Reference List
N/A


Function ATORdatabaseFileIOClass::DBsetCurrentDirectory()

Function Summary
namereturn typedescription
DBsetCurrentDirectoryboolDB set current directory

Function Arguments
nametypedescription
folderNamestring* folder name

Function Reference List


Function ATORdatabaseFileIOClass::DBgenerateServerDatabaseName()

Function Summary
namereturn typedescription
DBgenerateServerDatabaseNamestringDB generate server database name

Function Arguments
nametypedescription
objectNameconst string* object name
trainOrTest const bool train or test

Function Reference List
N/A


Function ATORdatabaseFileIOClass::DBgenerateFolderName()

Function Summary
namereturn typedescription
DBgenerateFolderNamestringDB generate folder name

Function Arguments
nametypedescription
objectNamestring* object name
trainOrTest const bool train or test

Function Reference List


Function ATORdatabaseFileIOClass::compareFeaturesListForMatch()

Function Summary
namereturn typedescription
compareFeaturesListForMatchboolcompare features list for match

Function Arguments
nametypedescription
testFirstFeatureInNearestFeatureListATORfeature* test first feature in nearest feature list
trainFirstFeatureInNearestFeatureList ATORfeature* train first feature in nearest feature list
dimension const int dimension
exactMatchFound bool* exact match found

Function Reference List


Function ATORdatabaseFileIOClass::createTransformedFeaturesFile()

Function Summary
namereturn typedescription
createTransformedFeaturesFilevoidcreate transformed features file

Function Arguments
nametypedescription
firstFeatureInListconst ATORfeature* first feature in list
fileName const string file name
objectName const string object name
viewIndex const int view index
zoomIndex const int zoom index
polyIndex const int poly index
sideIndex const int side index
trainOrTest const int train or test

Function Reference List


Function ATORdatabaseFileIOClass::createFeaturesListUsingFeaturesFile()

Function Summary
namereturn typedescription
createFeaturesListUsingFeaturesFilevoidcreate features list using features file

Function Arguments
nametypedescription
fileNameconst string file name
firstFeatureInList ATORfeature* first feature in list
createFeatureObjects const bool create feature objects
appendToList const bool append to list
ignoreOTfeatures const bool ignore OT features

Function Reference List


File LDjpeg Documentation

File Name: LDjpeg.cpp/.hpp

File Description: LD jpeg

File Function List


File Diagram (functions hierarchy)


Function LDjpegClass::setPointerToDCTtableHTMLoutputString()

Function Summary
namereturn typedescription
setPointerToDCTtableHTMLoutputStringvoidset pointer to DCT table HTML output string

Function Arguments
nametypedescription
pointerstring* pointer

Function Reference List
N/A


Function LDjpegClass::readVerySmallHighlyCompressedJPEGfileAndStoreDCTcoefficients()

Function Summary
namereturn typedescription
readVerySmallHighlyCompressedJPEGfileAndStoreDCTcoefficientsintread very small highly compressed JPEG file and store DCT coefficients

Function Arguments
nametypedescription
filenameconst string filename
dctCoeffArrayY[] schar dct coeff array Y[]
dctCoeffArrayYcr[] schar dct coeff array ycr []
dctCoeffArrayYcb[] schar dct coeff array ycb []
dctCoeffArrayHeight const int dct coeff array height
dctCoeffArrayWidth const int dct coeff array width
printOutput const bool print output

Function Reference List


File XMLrulesClass Documentation

File Name: XMLrulesClass.cpp/.hpp

File Description: XML rules class

File Function List


File Diagram (functions hierarchy)


Class XMLrulesClass

Class Data
nametypedescription
namestringname
stringValuestringstring value
fractionalValuedoublefractional value
attribute4intattribute 4
attribute5intattribute 5
attribute6intattribute 6
attribute7intattribute 7
attribute8intattribute 8
nextXMLrulesClass*next

Function XMLrulesClassClass::parseATORrulesXMLfile()

Function Summary
namereturn typedescription
parseATORrulesXMLfileboolparse ATOR rules XML file

Function Reference List


Function XMLrulesClassClass::parseATORrulesTag()

Function Summary
namereturn typedescription
parseATORrulesTagboolparse ATOR rules tag

Function Arguments
nametypedescription
currentTagXMLparserTag* current tag

Function Reference List


Function XMLrulesClassClass::addRulesClassObjectsBasedOnSectionTag()

Function Summary
namereturn typedescription
addRulesClassObjectsBasedOnSectionTagbooladd rules class objects based on section tag

Function Arguments
nametypedescription
currentTagXMLparserTag* current tag
sectionTagName const string section tag name
firstReferenceToObjectClass XMLrulesClass* first reference to object class
tagName const string tag name
numberOfAttributes const int number of attributes
attributeName1 const string attribute name 1
attributeName2 const string attribute name 2
attributeName3 const string attribute name 3
attributeName4 const string attribute name 4
attributeName5 const string attribute name 5
attributeName6 const string attribute name 6
attributeName7 const string attribute name 7
attributeName8 const string attribute name 8

Function Reference List


Function XMLrulesClassClass::addRulesClassObjectBasedOnTag()

Function Summary
namereturn typedescription
addRulesClassObjectBasedOnTagbooladd rules class object based on tag

Function Arguments
nametypedescription
currentTagXMLparserTag* current tag
currentReferenceToObjectClass XMLrulesClass* current reference to object class
tagName const string tag name
numberOfAttributes const int number of attributes
attributeName1 const string attribute name 1
attributeName2 const string attribute name 2
attributeName3 const string attribute name 3
attributeName4 const string attribute name 4
attributeName5 const string attribute name 5
attributeName6 const string attribute name 6
attributeName7 const string attribute name 7
attributeName8 const string attribute name 8

Function Reference List


File XMLparserClass Documentation

File Name: XMLparserClass.cpp/.hpp

File Description: XML parser class

File Function List


File Diagram (functions hierarchy)


Class XMLparserAttribute

Class Data
nametypedescription
namestringname
valuestringvalue
charCountintchar count
lineCountintline count
nextAttributeXMLparserAttribute*next attribute

Class XMLparserTag

Class Data
nametypedescription
namestringname
valuestringvalue
nextTagXMLparserTag*next tag
firstLowerLevelTagXMLparserTag*first lower level tag
charCountintchar count
lineCountintline count
firstAttributeXMLparserAttribute*first attribute
currentAttributeXMLparserAttribute*current attribute

Function XMLparserClassClass::parseTagDownALevel()

Function Summary
namereturn typedescription
parseTagDownALevelXMLparserTag*parse tag down AL evel

Function Arguments
nametypedescription
currentTagXMLparserTag* current tag
sectionTagName const string section tag name
result bool* result

Function Reference List
N/A


Function XMLparserClassClass::readXMLfile()

Function Summary
namereturn typedescription
readXMLfileboolread XML file

Function Arguments
nametypedescription
xmlFileNameconst string xml file name
firstTagInXMLfile XMLparserTag* first tag in XML file

Function Reference List


Function XMLparserClassClass::parseTagOpen()

Function Summary
namereturn typedescription
parseTagOpenboolparse tag open

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag* current tag
parentTagName const string parent tag name
isSubTag const bool is sub tag
treeLayer int tree layer

Function Reference List


Function XMLparserClassClass::parseTagName()

Function Summary
namereturn typedescription
parseTagNameboolparse tag name

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag* current tag
parentTagName const string parent tag name
isSubTag const bool is sub tag
treeLayer int tree layer

Function Reference List


Function XMLparserClassClass::parseTagAttributeName()

Function Summary
namereturn typedescription
parseTagAttributeNameboolparse tag attribute name

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag* current tag
parentTagName const string parent tag name
isSubTag const bool is sub tag
treeLayer int tree layer

Function Reference List


Function XMLparserClassClass::parseTagAttributeValue()

Function Summary
namereturn typedescription
parseTagAttributeValueboolparse tag attribute value

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag* current tag
parentTagName const string parent tag name
isSubTag const bool is sub tag
treeLayer const int tree layer

Function Reference List


Function XMLparserClassClass::parseTagValueAssumingExistenceOfSubtagsAndClose()

Function Summary
namereturn typedescription
parseTagValueAssumingExistenceOfSubtagsAndCloseboolparse tag value assuming existence of subtags and close

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag* current tag
treeLayer int tree layer

Function Reference List


Function XMLparserClassClass::parseTagComment()

Function Summary
namereturn typedescription
parseTagCommentboolparse tag comment

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
type const char type

Function Reference List


Function XMLparserClassClass::processTagClose()

Function Summary
namereturn typedescription
processTagCloseboolprocess tag close

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag** current tag
parentTagName const string parent tag name
isSubTag const bool is sub tag
treeLayer int tree layer
endTagFound const bool end tag found
parsingAttributeName const bool parsing attribute name
tagName const string tag name

Function Reference List


Function XMLparserClassClass::createNewTag()

Function Summary
namereturn typedescription
createNewTagXMLparserTag*create new tag

Function Arguments
nametypedescription
currentTagXMLparserTag* current tag

Function Reference List
N/A


Function XMLparserClassClass::isBlankChar()

Function Summary
namereturn typedescription
isBlankCharboolis blank char

Function Arguments
nametypedescription
parseFileObjectconst ifstream* parse file object
c const char c

Function Reference List
N/A


Function XMLparserClassClass::isBlankCharTabOrNewLine()

Function Summary
namereturn typedescription
isBlankCharTabOrNewLineboolis blank char tab or new line

Function Arguments
nametypedescription
parseFileObjectconst ifstream* parse file object
c const char c

Function Reference List
N/A


Function XMLparserClassClass::throwGenericXMLParseError()

Function Summary
namereturn typedescription
throwGenericXMLParseErrorvoidthrow generic XMLP arse error

Function Reference List
N/A


File ATORrules Documentation

File Name: ATORrules.cpp/.hpp

File Description: ATOR rules

File Function List


File Diagram (functions hierarchy)


Function ATORrulesClass::fillInATORrulesExternVariables()

Function Summary
namereturn typedescription
fillInATORrulesExternVariablesvoidfill in ATOR rules extern variables

Function Reference List