unitTestSupport

unitTestSupport.EigenVector3d2list(eig)

convert Eigen vector3d to list

unitTestSupport.EigenVector3d2np(eig)

convert Eigen vector3d to numpy

unitTestSupport.addTimeColumn(time, data)

Add a time column to the data set

unitTestSupport.checkMethodKeyword(karglist, kwargs)

loop through list of method keyword arguments and make sure that an approved keyword is used.

unitTestSupport.columnToRowList(set)

Loop through a column list and return a row list

unitTestSupport.compareArray(trueStates, dataStates, accuracy, msg, testFailCount, testMessages)

Compare two arrays size and values and check absolute accuracy

unitTestSupport.compareArrayND(trueStates, dataStates, accuracy, msg, size, testFailCount, testMessages)

Compare two arrays of size N for size and values and check absolute accuracy

unitTestSupport.compareArrayRelative(trueStates, dataStates, accuracy, msg, testFailCount, testMessages)

Checks whether the relative distance between elements of a pullMessageLogData-derived array and a truth array is below a provided accuracy, and return an error if not.

Parameters:

• trueStates – iterable of size (m,n);

• dataStates – iterable of size (m,n)

• accuracy – Relative accuracy boundary

• msg

• testFailCount

• testMessages

unitTestSupport.compareDoubleArray(trueStates, dataStates, accuracy, msg, testFailCount, testMessages)

Compare two arrays of doubles for size and values and check absolute accuracy

unitTestSupport.compareDoubleArrayRelative(trueStates, dataStates, accuracy, msg, testFailCount, testMessages)

Compare two arrays of doubles for size and values and check relative accuracy

unitTestSupport.compareList(trueStates, dataStates, accuracy, msg, testFailCount, testMessages)

Compare two row lists of values and check relative accuracy

unitTestSupport.compareListRelative(trueStates, dataStates, accuracy, msg, testFailCount, testMessages)

Compare two row lists of values and check relative accuracy

unitTestSupport.compareVector(trueStates, dataStates, accuracy, msg, testFailCount, testMessages, ExpectedResult=1)

Compare two vector size and values and check absolute accuracy

unitTestSupport.decimalYearToDateTime(start)

convert a decimal Year format to a regular dataTime object

unitTestSupport.flattenList(matrix)

returns a flattened list :param matrix: list of list

Returns: flattened list

unitTestSupport.foundNAN(array)

check if an array contains NAN values

unitTestSupport.getLineColor(idx, maxNum)

pick a nicer color pattern to plot 3 vector components

unitTestSupport.isArrayEqual(result, truth, dim, accuracy)

function to check if an array of values is the same as the truth values

unitTestSupport.isArrayEqualRelative(result, truth, dim, accuracy)

Compare relative accuracy of two arrays

unitTestSupport.isArrayZero(result, dim, accuracy)

function to check if an array of values are zero

unitTestSupport.isDoubleEqual(result, truth, accuracy)

function to check if a double equals a truth value

unitTestSupport.isDoubleEqualRelative(result, truth, accuracy)

function to check if a double equals a truth value with relative tolerance

unitTestSupport.isVectorEqual(result, truth, accuracy)

function to check if a 3D vector is the same as the truth values

unitTestSupport.np2EigenMatrix3d(mat)

convert 3D numpy matrix to Eigen matrix

unitTestSupport.np2EigenVectorXd(vec)

Convert numpy to Eigen vector

unitTestSupport.npList2EigenXdVector(list)

Conver a list of arrays to a list of eigen values

unitTestSupport.pullVectorSetFromData(inpMat)

extract the vector data set from a data matrix where the 1st column is the time information

unitTestSupport.removeTimeFromData(dataList)

pull out the time column out of a 4xN data list

unitTestSupport.samplingTime(simTime, baseTimeStep, numDataPoints)

Given a simulation duration, this routine returns a sampling time that yields the closest integer match to a desired number of sampling points

Parameters:

• simTime – [ns] total simulation duration

• baseTimeStep – [ns] baseline sampling period

• numDataPoints – nominal desired number of data points over the simulation duration

unitTestSupport.saveFigurePDF(figureName, plt, path)

Save a Figure as a PDF

unitTestSupport.saveScenarioFigure(figureName, plt, path, extension='.svg')

save a python scenario result into the documentation image folder

unitTestSupport.timeStringToGregorianUTCMsg(DateSpice, **kwargs)

convert a general time/date string to a gregoarian UTC msg object

unitTestSupport.writeFigureLaTeX(figureName, caption, plt, format, path)

Save a figure and associated TeX code snippet

unitTestSupport.writeTableLaTeX(tableName, tableHeaders, caption, array, path)

Take a list and return equivalent LaTeX table code

unitTestSupport.writeTeXSnippet(snippetName, texSnippet, path)

Write a LaTeX snippet to a file