# Reference Guide

The VEEOS library consists of importable objects and functions that can be utilized in your VEE programs. The functions are organized into various libraries that are automatically imported. The objects are accessed via the VEEOS menu picks. This guide provides details of the various functions and objects.

- Libraries
- Functions
- Standalone Functions (no matching object)
- Standalone Objects (no matching function)
- VEEOS Error Codes

### Libraries

The end user will not generally interact with these directly.

- bootstrapLib - does the work needed to load and enable veeos
- codeLib - Programming aids
- dataLib - Create, modify, translate, analyze and otherwise manipulate data.
- eeLib - Functions related to Electrical Engineering.
- mathLib - General mathematics functions
- netLib - Functions that use the internet.
- scriptLib - Enables support of scripting languages
- sigLib - Signal processing components
- sysLib - Functions related to the operating system and the general computer environment.
- veeosLib - Functions that didn't fit elsewhere or that help manage the library.

### Functions

These standard functions correspond directly to a single object so that the identical functionality can be used in expressions or as objects.

NOTE that the actual function name adds a prefix ("o_") to the object names. For example the polarResample object has underlying function o_polarResample()

- addField - Adds to an existing record a field with specified name and value.
- arrayConcat - joins together arrays
- arrayRev - reverses the order of any 1D array
- baseNtoDec - Base conversion from any base to decimal.
- brb - Intentionally create a crash dialog (BRB)
- buildField - Creates a field with specified name and value.
- checkStatus - Queries the script server to determine if it is running and ready for use.
- colMax - Array statistics - determines the Maximum value of each column in an array
- colMean - Array statistics - determines the Mean value of each column in an array
- colMedian - Array statistics - determines the Median value of each column in an array
- colMin - Array statistics - determines the Minimum value of each column in an array
- colMode - Array statistics - determines the Mode of each column in an array
- colRMS - Array statistics - determines the RMS value of each column in an array
- colSDev - Array statistics - determines the Standard Deviation of each column in an array
- colVari - Array statistics - determines the Variance of each column in an array
- currentHumidity - returns the current humidity for a given city
- currentTemp - returns the current temperature for a given city
- dcBlock - - removes the DC component of a signal
- decayFilter - Implements a filter whose response is based on a given decay rate.
- decToBaseN - Base conversion from decimal to any base.
- dif - calculates difference between successive data points
- disconnectServer - Closes the socket connection to the script server. The server remains running.
- downloadLatestLibrary - Downloads the latest version the VEEOS library.
- dtmfPulse - Creates a DTMF pulse consisting of two frequencies that identify the given character.
- dtmfReceiver - Converts a DTMF pulse or (pulse train) into the corresponding character(s)
- dtmfSigGen - Generates a pulse train that represents the DTMF signal corresponding to a given set of characters
- dutyCycle - Determines the duty cycle of an arbitrary signal
- envelope - Constructs an envelope for arbitrary signals.
- enumToList - Converts an enum into a text array.
- eval - Evaluates the given function at the given argument.
- executeScript - Instructs the server to run the previously specified script.
- fallTime - Determines the fall time of an arbitrary signal
- findFile - Determines the location(s) of a file within a given directory tree.
- frequency - Determines the dominant frequency of an arbitrary signal.
- fromClipboard - Reads text from the system clipboard.
- funcFilter - Implements an analog filter with transfer response specified by an arbitrary function.
- funcGen - A general purpose function generator.
- getResult - Queries the server for the requested output data from the last script execution.
- help - brings up a local copy of the online help in a popup window
- hexToInt - Interprets input as hex value and outputs it as an integer
- hilbert - Computes the Hilbert transform of the input waveform.
- ifThenEval - Defines a function of multiple domains - is also a general Case statement.
- importCLib - Imports a Compiled Library
- importULib - Imports a User Library
- isElement - determines if a given element exists within a set
- isPrime - Determines if a number is prime.
- listToEnum - Converts a text array into an enum.
- longLat - returns the longitude and latitude for a given city
- period - Determines the period of an arbitrary signal.
- PI - Evaluates the product of a series.
- polarFit - Determines the unique circle defined by given three points.
- polarRegress - Determines the circle that best fits a set of points.
- polarResample - Resamples polar data to ensure full 0-360 coverage.
- polyFilter - Implements an analog filter with transfer response specified by numerator and denominator polynomials.
- popupNotice - Creates a pop-up message on the user's screen
- ppCap - Calculates Parallel Plate Capacitance
- printText - Prints text to a specified printer
- psftp - Automates an SFTP session.
- riseTime - Determines the rise time of an arbitrary signal
- randomInt - Returns a random integer from specified range.
- randomReorder - scrambles the order of a string or array.
- rootFilter - Implements an analog filter with transfer response specified by poles and zeroes.
- runInShell - runs specified command in a cmd shell.
- screenShot - Takes snapshot of screen
- scriptConfig - Assists the user in controlling various settings related to scripting.
- scriptInit - Readies scripting by setting up the needed environment and starting the script server as needed.
- scriptPro - Provides a simple wrapper for executing arbitrary scripts
- sendData - Uploads the specified data to the script server.
- sendScript - Uploads the specified script to the script server.
- setAND - returns the set of elements that are in both of two sets
- setComplement - Returns the set of elements that are in one set but not in the other.
- setOR - returns the set of elements that are in either of two sets
- setShutdownTimeout - Sets the idle timeout after which the script server shuts down.
- setXOR - returns the set of elements that are in either but not both of two sets
- setVar - Sets (or creates) a variable with given name and value
- SIGMA - Evaluates the sum of a series.
- slewFilter - implements an analog filter whose response is based on a given slew rate.
- startServer - Starts the script server, enabling scripting to proceed.
- stopServer - Shuts down the script server.
- strReplace - Replaces occurrences of a target string within the input string.
- time - Converts timestamp to time of the day.
- timeStretch - Stretches a series of data points by replicating them.
- timeZone - Determines the current timezone of the user's computer.
- toClipboard - Writes text to the system clipboard.
- toCoord - Creates Coordinates from input data.
- toEngr - Formats a number in standard engineering format.
- toggleRadix - Switches decimal radix between point and comma
- toInt16 - Interprets input as hex value and outputs it as a 16-bit signed integer
- toInt32 - Interprets input as hex value and outputs it as a 32-bit signed integer
- toUInt8- Interprets input as hex value and outputs it as an 8-bit unsigned integer
- toBinStrN - Formats a number as a binary string of arbitrary length.
- unique - returns unique subset
- unixNow - Determines the current timestamp as understood by the unix world.
- unzip - Uses standard ZIP to unpack zip bundles.
- utcNow - Determines the current timestamp referenced to UTC time rather than local time.
- uudecode - Unpacks a coded ASCII file into the original format of the enclosed file.
- uuencode - Unpacks a coded ASCII file into the original format of the enclosed file.
- viewPicture - Displays chosen picture in a photo viewer.
- wait - Pauses execution for specified time in seconds
- week - Converts timestamp to week of the year.
- wget - Downloads a file from the web.
- which - Determines the location of an executable in the system path
- whois - Determines the registration information for a given domain.
- winVersion - Find the version of Windows which is currently running.
- yDay - Converts timestamp to day of the year.
- yWeek - Converts timestamp to week of the year.
- ywToDate - Converts year and week to timestamps at start and end of the week.
- zeroCrossings - Determines the points at which a function crosses the X axis: the zero crossings.
- zip - Uses standard ZIP to bundle whatever source files are specified.

### Standalone Objects

These objects (or groups of objects) have no single underlying matching function.

- analogAmp - configurable analog amplifier
- analogFilter - configurable analog classical filter
- bitStream - display optimized to show bit pattern of digital stream
- downConvert - mixer-based down-conversion object
- forEach - Program construct for looping through a set of values.
- negBridge - negative polarity full-wave bridge rectifer
- negRectifier - negative polarity half-wave rectifer
- numberStream - display optimized to show streaming analog data
- posBridge - negative polarity half-wave rectifer
- posRectifier - negative polarity full-wave bridge rectifer
- referenceGuide - local viewable copy of the Reference Guide
- script - Provides a simple wrapper for executing arbitrary scripts
- toBinStr8 - Formats a number as a binary string of length 8.
- toBinStr16 - Formats a number as a binary string of length 16.
- toBinStr32 - Formats a number as a binary string of length 32.
- toBinStr64 - Formats a number as a binary string of length 64.
- upConvert - mixer-based up-conversion object
- veeosInit - Initializes the loading of veeos

### Standalone Functions

These functions have no single overlying matching object but may of course still be used as desired.
NOTE that the actual function name adds a prefix ("o_") to the names shown. For example the polarResample object has underlying function o_polarResample()

- startFreq - Extracts the beginning frequency of a spectrum.
- stopFreq - Extracts the end frequency from a spectrum.
- timeSpan - Extracts the time span from a waveform.
- aAmp - generic analog amplifer
- aFilter - generic classical analog filter
- aMixer - generic analog mixer
- aRectifier - generic analog rectifier
- arrayData - Extracts the array of values from a waveform or spectrum.
- butterPoly - generates Butterworth polynomials
- chebyPoly - generates Chebychev polynomials
- comma2point - Replaces commas with points.
- dimSizes - Returns the size(s) of the dimensions for an array.
- dtmfCode - Generates the DTMF frequency pair that defines the given input character.
- dtmfDecode - Converts a pair of DTMF frequencies into the corresponding character
- dtmfRcvPulse - Converts a DTMF signal pulse into the corresponding character
- numDims - Returns the dimensionality of a value.
- point2comma - Replaces points with commas.
- raiseError - raises an error message that halts program execution.
- specArray - Extracts the array of values from a spectrum.
- startFreq - Extracts the beginning frequency of a spectrum.
- stopFreq - Extracts the end frequency from a spectrum.
- timeSpan - Extracts the time span from a waveform.
- waveArray - Extracts the array of values from a waveform.
- Xcoord - Returns the X value of a coordinate
- Ycoord - Returns the Y value of a coordinate
- Zcoord - Returns the Z value of a coordinate

© 2015-2021. All Rights Reserved. Stan Bischof (stan@worldbadminton.com). Last updated 09 August 2021 18:33.