Walabot API
All you need to know to create a Walabot Application
|
Go to the source code of this file.
Classes | |
struct | vcomplex_struct |
Phasor is a complex number which includes the data on the amplitude and the phase of the reflected signal. More... | |
struct | AntennaPair_struct |
Antenna pair for Walabot_GetAntennaPairs() More... | |
struct | ImagingTarget_struct |
< Imaging Tagret parameters More... | |
struct | SensorTarget_struct |
< Sensor Tagret parameters More... | |
Macros | |
#define | WALABOT_API extern "C" __declspec(dllimport) |
#define | PARAM_DIELECTRIC_CONSTANT ((char*)"DielectricConstant") |
#define | PARAM_CONFIDENCE_FACTOR ((char*)"ConfidenceFactor") |
Typedefs | |
typedef enum WALABOT_RESULT_ENUM | WALABOT_RESULT |
typedef struct vcomplex_struct | vcomplex |
Phasor is a complex number which includes the data on the amplitude and the phase of the reflected signal. More... | |
typedef struct AntennaPair_struct | AntennaPair |
Antenna pair for Walabot_GetAntennaPairs() More... | |
typedef struct ImagingTarget_struct | ImagingTarget |
< Imaging Tagret parameters More... | |
typedef struct SensorTarget_struct | SensorTarget |
< Sensor Tagret parameters More... | |
Functions | |
int | Walabot_GetExtendedError () |
Obtains more error information for Vayyar support. More... | |
const char * | Walabot_GetErrorString () |
Obtains the detailed string of the last error. More... | |
WALABOT_RESULT | Walabot_SetSettingsFolder (char *folder) |
Obtains Sets location of Walabot internal database, if moved from default. More... | |
WALABOT_RESULT | Walabot_GetInstrumentsList (int bufMaxSize, char *outputBuffer) |
This function is reserved for future use Obtains a list of connected Walabots. More... | |
WALABOT_RESULT | Walabot_Connect (char *uid) |
This function is reserved for future use Establishes communication with a specified Walabot device. More... | |
WALABOT_RESULT | Walabot_ConnectAny () |
Establishes communication with Walabot. More... | |
WALABOT_RESULT | Walabot_Disconnect () |
Stops communication with Walabot. More... | |
WALABOT_RESULT | Walabot_Start () |
Starts Walabot in preparation for scanning. More... | |
WALABOT_RESULT | Walabot_Stop () |
Stops Walabot when finished scanning. More... | |
WALABOT_RESULT | Walabot_Trigger () |
Initiates a scan and records signals. More... | |
WALABOT_RESULT | Walabot_GetAntennaPairs (AntennaPair **antennaPairs, int *numPairs) |
Obtains a list of Walabot antenna pairs. More... | |
WALABOT_RESULT | Walabot_GetSignal (int txAntenna, int rxAntenna, double **signal, double **timeAxis, int *numSamples) |
Obtains raw image data from specified antennas. More... | |
WALABOT_RESULT | Walabot_SetProfile (APP_PROFILE profile) |
Sets scan profile. More... | |
WALABOT_RESULT | Walabot_GetStatus (APP_STATUS *status, double *param) |
Obtains Walabot status. More... | |
WALABOT_RESULT | Walabot_StartCalibration () |
Initiates calibration. More... | |
WALABOT_RESULT | Walabot_CancelCalibration () |
Stops calibration. More... | |
WALABOT_RESULT | Walabot_SetThreshold (double value) |
Changes the sensitivity threshold. More... | |
WALABOT_RESULT | Walabot_GetThreshold (double *threshold) |
Obtains the current sensitivity threshold. More... | |
WALABOT_RESULT | Walabot_SetArenaX (double min, double max, double res) |
Sets X-axis range and resolution of arena. More... | |
WALABOT_RESULT | Walabot_SetArenaY (double min, double max, double res) |
Sets Y-axis range and resolution of arena. More... | |
WALABOT_RESULT | Walabot_SetArenaZ (double start, double end, double res) |
Sets Z-axis range and resolution of arena. More... | |
WALABOT_RESULT | Walabot_SetArenaR (double start, double end, double res) |
Sets radial (r) range and resolution of arena. More... | |
WALABOT_RESULT | Walabot_SetArenaTheta (double min, double max, double res) |
Sets polar (Θ) range and resolution of arena. More... | |
WALABOT_RESULT | Walabot_SetArenaPhi (double min, double max, double res) |
Sets azimuth (Φ) range and resolution of arena. More... | |
WALABOT_RESULT | Walabot_GetArenaX (double *min, double *max, double *res) |
Obtains current X-axis range and resolution of arena. More... | |
WALABOT_RESULT | Walabot_GetArenaZ (double *start, double *end, double *res) |
Obtains current Z-axis range and resolution of arena. More... | |
WALABOT_RESULT | Walabot_GetArenaY (double *min, double *max, double *res) |
Obtains current Y-axis range and resolution of arena. More... | |
WALABOT_RESULT | Walabot_GetArenaR (double *start, double *end, double *res) |
Obtains radial (r) range and resolution of arena. More... | |
WALABOT_RESULT | Walabot_GetArenaTheta (double *min, double *max, double *res) |
Obtains polar (Θ) range and resolution of arena. More... | |
WALABOT_RESULT | Walabot_GetArenaPhi (double *min, double *max, double *res) |
Obtains azimuth (Φ) range and resolution of arena. More... | |
WALABOT_RESULT | Walabot_GetRawImageSlice (int **rasterImage, int *sizeX, int *sizeY, double *sliceDepth, double *power) |
Provides bidimensional (2-D) image data of the 3D image projected to a plane. More... | |
WALABOT_RESULT | Walabot_GetRawImage (int **rasterImage, int *sizeX, int *sizeY, int *sizeZ, double *power) |
Provides tridimensional (3-D) image data. More... | |
WALABOT_RESULT | Walabot_GetImageEnergy (double *energy) |
Provides the sum of all the raw image’s pixels’ signal power. More... | |
WALABOT_RESULT | Walabot_GetImagingTargets (ImagingTarget **targets, int *numTargets) |
Provides a list of and the number of identified targets. More... | |
WALABOT_RESULT | Walabot_GetSensorTargets (SensorTarget **targets, int *numTargets) |
Provides a list of and the number of identified targets. More... | |
WALABOT_RESULT | Walabot_SetDynamicImageFilter (FILTER_TYPE type) |
Dynamic-imaging filter removes static signals, leaving only changing signals. More... | |
WALABOT_RESULT | Walabot_GetDynamicImageFilter (FILTER_TYPE *type) |
Obtains current Walabot Dynamic-imaging filter setting. More... | |
WALABOT_RESULT | Walabot_GetVersion (char **version) |
Obtains current Walabot version. More... | |
WALABOT_RESULT | Walabot_SetAdvancedParameter (char *paramName, double value) |
Set advanced Walabot parameter. More... | |
WALABOT_RESULT | Walabot_GetAdvancedParameter (char *paramName, double *value) |
Obtains current Walabot advnaced parameter value. More... | |
WALABOT_RESULT | Walabot_GetAntennaLocation (int antennaNum, double &X, double &Y, double &Z) |
#define PARAM_CONFIDENCE_FACTOR ((char*)"ConfidenceFactor") |
Walabot internal pipe sensor detection percentage. Read only parameter.
Definition at line 1291 of file WalabotAPI.h.
#define PARAM_DIELECTRIC_CONSTANT ((char*)"DielectricConstant") |
The linear permittivity of a homogeneous material is usually given relative to that of free space,
as a relative permittivity εr. Valid values {1-30}
Definition at line 1285 of file WalabotAPI.h.
#define WALABOT_API extern "C" __declspec(dllimport) |
Definition at line 742 of file WalabotAPI.h.
typedef struct AntennaPair_struct AntennaPair |
Antenna pair for Walabot_GetAntennaPairs()
typedef struct ImagingTarget_struct ImagingTarget |
< Imaging Tagret parameters
typedef struct SensorTarget_struct SensorTarget |
< Sensor Tagret parameters
typedef struct vcomplex_struct vcomplex |
Phasor is a complex number which includes the data on the amplitude and the phase of the reflected signal.
typedef enum WALABOT_RESULT_ENUM WALABOT_RESULT |
enum APP_PROFILE |
< Scan profile for Walabot_SetProfile(); see Imaging Features
Definition at line 690 of file WalabotAPI.h.
enum APP_STATUS |
< Walabot status returned by Walabot_GetStatus()
Enumerator | |
---|---|
STATUS_DISCONNECTED |
No communication with Walabot. |
STATUS_CONNECTED |
Communication established with Walabot, but no Profile set. |
STATUS_IDLE |
Profile set, but not currently scanning or calibrating. |
STATUS_SCANNING |
Prepared for scanning by Walabot_Start, and not currently calibrating. |
STATUS_CALIBRATING |
Now calibrating; in this case Walabot_GetStatus() also provides percentage completed. |
Definition at line 699 of file WalabotAPI.h.
enum FILTER_TYPE |
< Dynamic-imaging filter algorithm for Walabot_SetDynamicImageFilter()
Definition at line 714 of file WalabotAPI.h.
enum TARGET_TYPE |
Enumerator | |
---|---|
TARGET_TYPE_UNKNOWN | |
TARGET_TYPE_PIPE |
Definition at line 708 of file WalabotAPI.h.
enum WALABOT_RESULT_ENUM |
Enumerator | |
---|---|
WALABOT_SUCCESS |
Operation successful. |
WALABOT_ERR_INVALID_PORT_DEFINITION |
Invalid antenna number. |
WALABOT_ERR_TOO_MANY_SAMPLES |
General Walabot error. |
WALABOT_ERR_RECORDING_THREAD_ALREADY_RUNNING |
Application already running. |
WALABOT_ERR_RECORDING_WITHOUT_APPLY_SETTINGS |
Walabot_Start() was not called. |
WALABOT_ERR_READ_WITHOUT_APPLY_SETTINGS |
Walabot_Start() was not called. |
WALABOT_ERR_INVALID_PAGE_INDEX |
General Walabot error. |
WALABOT_ERR_INVALID_TXRX_PAIR |
{Tx,Rx} Antenna pair error |
WALABOT_ERR_AMBIGUOUS_TXRX_PAIR |
The requested tx-rx pair is ambiguous (recorded in more than one port group) |
WALABOT_ERR_PORTGROUP_INDEX_OUT_OF_BOUNDS |
General Walabot error. |
WALABOT_ERR_RX_PORT_OUT_OF_BOUNDS |
Rx antenna invalid. |
WALABOT_ERR_NO_DATA |
No data returned for specified request. |
WALABOT_ERR_USB_READ_FAILURE |
Walabot device disconnected. |
WALABOT_PARAMETER_NOT_FOUND |
Invalid input parameter. |
WALABOT_OUT_OF_RANGE |
A provided parameter value was out of its allowed range. |
WALABOT_READONLY_PARAMETER |
General Walabot error. |
WALABOT_ERR_ARENA_SIZE_TOO_BIG |
Error in arena resize parameters. |
WALABOT_DD_ERR_USB_DEVICE_WENT_DOWN |
Walabot device USB error. |
WALABOT_ERR_INVALID_PARAMETER |
A provided parameter value was out of its allowed range. |
WALABOT_INSTRUMENT_NOT_FOUND |
The SDK is unable to communicate with the instrument. |
WALABOT_BUFFER_TOO_SMALL |
Provided buffer is too small. |
WALABOT_INVALID_ARRAY_SIZE |
Provided buffer is too small. |
WALABOT_INVALID_PROFILE |
Invalid Profile type. |
WALABOT_ERR_NO_IMAGE |
No image has been recored by the Walabot. |
WALABOT_ERR_GENERAL |
General Walabot error. |
WALABOT_ERR_PROTOCOL |
Internal Error. |
WALABOT_ERR_DEVICE_STORAGE |
Unable to write to device storge. |
WALABOT_ERR_DB |
Unable to access Database. |
WALABOT_ERR_USB |
USB. |
WALABOT_ERR_SEQ | |
WALABOT_ERR_SCHEDULER |
Data recording fetch. |
WALABOT_ERR_HW_PLAN |
Error in recoding schema. |
WALABOT_ERR_MULTI_CHIP |
Error in multi Walabot configuration setup. |
WALABOT_ERR_REC_PLAN |
Error in recoding schema. |
WALABOT_ERR_NULL_OBJECT |
Non initlizated object. |
WALABOT_ERR_IN_COMPILER |
Error during building recording profile schema. |
WALABOT_ERR_IN_INITIALIZATION |
Error during initilization process. |
WALABOT_ERR_SETTING_FOLDER |
Didn't find setting folder. Use Walabot_SetSettingsFolder(...) to fix it. |
WALABOT_ERR_LOG |
Error during internal logging. |
WALABOT_GENERAL_ERROR |
A general error occurred. Inspect the error logs for more information. |
Definition at line 630 of file WalabotAPI.h.
WALABOT_RESULT Walabot_CancelCalibration | ( | ) |
WALABOT_RESULT Walabot_Connect | ( | char * | uid | ) |
This function is reserved for future use
Establishes communication with a specified Walabot device.
Connection is required before Walabot_Start().
If only a single Walabot device is present, it is simpler to use Walabot_ConnectAny().
[in] | uid | Walabot device ID obtained from Walabot_GetInstrumentsList() |
WALABOT_RESULT Walabot_ConnectAny | ( | ) |
Establishes communication with Walabot.
Connection is required before Walabot_Start().
If multiple Walabots are present, a single available Walabot is selected; to specify one, use Walabot_Connect().
WALABOT_RESULT Walabot_Disconnect | ( | ) |
WALABOT_RESULT Walabot_GetAdvancedParameter | ( | char * | paramName, |
double * | value | ||
) |
Obtains current Walabot advnaced parameter value.
Function returns Walabot advance parameter.
[in] | paramName | advance parameter name, can be one of the following: PARAM_CONFIDENCE_FACTOR , PARAM_DIELECTRIC_CONSTANT |
[out] | value | paramName current value |
WALABOT_RESULT Walabot_GetAntennaLocation | ( | int | antennaNum, |
double & | X, | ||
double & | Y, | ||
double & | Z | ||
) |
WALABOT_RESULT Walabot_GetAntennaPairs | ( | AntennaPair ** | antennaPairs, |
int * | numPairs | ||
) |
Obtains a list of Walabot antenna pairs.
For use before Walabot_GetSignal(). To identify the antennas on your Walabot device, see the specifications for your model.
[out] | antennaPairs | List of antenna pairs |
[out] | numPairs | The number of antenna pairs in the list |
WALABOT_RESULT Walabot_GetArenaPhi | ( | double * | min, |
double * | max, | ||
double * | res | ||
) |
Obtains azimuth (Φ) range and resolution of arena.
Can be changed with Walabot_SetArenaPhi().
For coordinate directions, see Coordinate Systems.
Spherical (r-Θ-Φ) coordinates are relevant only to get image data from a triggered scan that used one of the Sensor profiles. Otherwise the Walabot_SetArena functions for cartesian (X-Y-Z) coordinates apply.
[in] | min | Beginning of azimuth angular range (degrees) |
[in] | max | End of azimuth angular range (degrees) |
[in] | res | Angle between pixels across polar angle (degrees) |
WALABOT_RESULT Walabot_GetArenaR | ( | double * | start, |
double * | end, | ||
double * | res | ||
) |
Obtains radial (r) range and resolution of arena.
Can be changed with Walabot_SetArenaR().
For coordinate directions, see Coordinate Systems.
Spherical (r-Θ-Φ) coordinates are relevant only to get image data from a triggered scan that used one of the Sensor profiles. Otherwise the Walabot_SetArena functions for cartesian (X-Y-Z) coordinates apply.
[out] | start | Beginning of radial distance range (cm) |
[out] | end | End of radial distance range (cm) |
[out] | res | Image resolution along radius (cm) |
WALABOT_RESULT Walabot_GetArenaTheta | ( | double * | min, |
double * | max, | ||
double * | res | ||
) |
Obtains polar (Θ) range and resolution of arena.
Can be changed with Walabot_SetArenaTheta().
For coordinate directions, see Coordinate Systems.
Spherical (r-Θ-Φ) coordinates are relevant only to get image data from a triggered scan that used one of the Sensor profiles. Otherwise the Walabot_SetArena functions for cartesian (X-Y-Z) coordinates apply.
[in] | min | Beginning of polar angular range (degrees) |
[in] | max | End of polar angular range (degrees) |
[in] | res | Angle between pixels across polar angle (degrees) |
WALABOT_RESULT Walabot_GetArenaX | ( | double * | min, |
double * | max, | ||
double * | res | ||
) |
Obtains current X-axis range and resolution of arena.
Can be changed with Walabot_SetArenaX().
For coordinate directions, see Coordinate Systems.
Cartesian (X-Y-Z) coordinates are relevant only to get image data from a triggered scan that used the short-range profile. Otherwise the Walabot_SetArena functions for spherical (r-Θ-Φ) coordinates apply.
[out] | min | Beginning of range on axis (cm) |
[out] | max | End of range on axis (cm) |
[out] | res | Distance between pixels along axis (cm) |
WALABOT_RESULT Walabot_GetArenaY | ( | double * | min, |
double * | max, | ||
double * | res | ||
) |
Obtains current Y-axis range and resolution of arena.
Can be changed with Walabot_SetArenaY().
For coordinate directions, see Coordinate Systems.
Cartesian (X-Y-Z) coordinates are relevant only to get image data from a triggered scan that used the short-range profile. Otherwise the Walabot_SetArena functions for spherical (r-Θ-Φ) coordinates apply.
[out] | min | Beginning of range on axis (cm) |
[out] | max | End of range on axis (cm) |
[out] | res | Distance between pixels along axis (cm) |
WALABOT_RESULT Walabot_GetArenaZ | ( | double * | start, |
double * | end, | ||
double * | res | ||
) |
Obtains current Z-axis range and resolution of arena.
Can be changed with Walabot_SetArenaZ().
For coordinate directions, see Coordinate Systems.
Cartesian (X-Y-Z) coordinates are relevant only to get image data from a triggered scan that used the short-range profile. Otherwise the Walabot_SetArena functions for spherical (r-Θ-Φ) coordinates apply.
[out] | start | Beginning of range on axis (cm) |
[out] | end | End of range on axis (cm) |
[out] | res | Distance between pixels along axis (cm) |
WALABOT_RESULT Walabot_GetDynamicImageFilter | ( | FILTER_TYPE * | type | ) |
Obtains current Walabot Dynamic-imaging filter setting.
Can be called at any time, default value is FILTER_TYPE_NONE
[out] | type | Dynamic-imaging filter current setting. |
const char* Walabot_GetErrorString | ( | ) |
Obtains the detailed string of the last error.
int Walabot_GetExtendedError | ( | ) |
Obtains more error information for Vayyar support.
WALABOT_RESULT Walabot_GetImageEnergy | ( | double * | energy | ) |
Provides the sum of all the raw image’s pixels’ signal power.
Requires previous Walabot_Trigger(); provides data based on last completed triggered image.
Provided image data is dependent on current configured arena.
[out] | energy | Number representing the sum of all the raw image’s pixels’ signal power |
WALABOT_RESULT Walabot_GetImagingTargets | ( | ImagingTarget ** | targets, |
int * | numTargets | ||
) |
Provides a list of and the number of identified targets.
Available only if the short-range scan profile was used.
Requires previous Walabot_Trigger(); provides data based on last completed triggered image.
Provided image data is dependent on current configured arena and on current configuration from Walabot_SetDynamicImageFilter() and Walabot_SetThreshold(). Note: In the current API version, provides only the single target with the strongest signal, in format appropriate for pipe
[out] | targets | List of identified targets (in current API version, a single target) |
[out] | numTargets | Number of identified targets (in current API version, 1) |
WALABOT_RESULT Walabot_GetInstrumentsList | ( | int | bufMaxSize, |
char * | outputBuffer | ||
) |
This function is reserved for future use
Obtains a list of connected Walabots.
For use before Walabot_Connect(); a Walabot ID obtained here is used to identify the device to connect to.
Input details of a memory buffer (size and location) to which Walabot will copy the list of connected Walabot IDs.
[in] | bufMaxSize | Available size of the provided memory buffer |
[in] | outputBuffer | Location of the provided memory buffer |
WALABOT_RESULT Walabot_GetRawImage | ( | int ** | rasterImage, |
int * | sizeX, | ||
int * | sizeY, | ||
int * | sizeZ, | ||
double * | power | ||
) |
Provides tridimensional (3-D) image data.
Image data is a 3-dimensional matrix in which each element represents the reflected power at (x,y,z) spatial location corresponding to this element indexing in the matrix.
The coordinates are according to the profile used. For sensor profile, the coordinates are Theta-Phi-R (polar coordinates) ,
while for short-range sensor, the coordinates are to X-Y-Z plane (carthesian coordinates). The matrix is transferred using a vector which is the concatenated matrix rows.
Meaning; assuming 3D matrix with indexes i, j & k. the vector is represented as followed:
Each index represent the location alone it's axis according to the arena defined.
For Carthesian coordinates Arena ( see Walabot_SetArenaX(), Walabot_SetArenaY(), Walabot_SetArenaZ()).
E.g.:
For Polar coordinates Arena ( see Walabot_SetArenaR(), Walabot_SetArenaTheta(), Walabot_SetArenaPhi()).
E.g.:
Requires previous Walabot_Trigger(); provides data based on last completed triggered image.
Output is details of array variable populated by provided image data.
Provided image data is dependent on current configured arena and on current configuration from Walabot_SetDynamicImageFilter() and Walabot_SetThreshold().
[out] | rasterImage | Name of array variable populated by output image data |
[out] | sizeX | Dimension of array variable populated by output image data |
[out] | sizeY | Dimension of array variable populated by output image data |
[out] | sizeZ | Dimension of array variable populated by output image data |
[out] | power | Peak measured power in arena (value of strongest pixel) |
WALABOT_RESULT Walabot_GetRawImageSlice | ( | int ** | rasterImage, |
int * | sizeX, | ||
int * | sizeY, | ||
double * | sliceDepth, | ||
double * | power | ||
) |
Provides bidimensional (2-D) image data of the 3D image projected to a plane.
Image data is a 2-dimensional projection matrix of the 3D Raw image which can be obtained using Walabot_GetRawImage function.
In this 2D matrix element represents the reflection strength at spatial location corresponding to this element indexing in the matrix.
The projection is done according to the profile used. For sensor profile, the projection is to Phi-R (polar coordinates) plane,
while for short-range sensor, the projection is to X-Y plane (carthesian coordinates). One can always use the original 3D raw data to create other planes of interests.
The value of the element indicated the reflected power measured in its location.
The matrix is transferred using a vector which is the concatenated matrix rows. meaning; assuming 2D matrix with indexes i, j.
The vector is represented as followed:
Each index represent the location alone it's axis according to the arena defined. E.g.:
For Carthesian coordinates Arena ( see Walabot_SetArenaX(), Walabot_SetArenaY()).
E.g.:
For Polar coordinates Arena ( see Walabot_SetArenaR(), Walabot_SetArenaPhi()).
E.g.:
Requires previous Walabot_Trigger(); provides data based on last completed triggered image.
Output is details of array variable populated by provided image data.
Provided image data is dependent on current configured arena and on current configuration from Walabot_SetDynamicImageFilter() and Walabot_SetThreshold().
[out] | rasterImage | Name of array variable populated by output image data |
[out] | sizeX | Dimension of array variable populated by output image data |
[out] | sizeY | Dimension of array variable populated by output image data |
[out] | sliceDepth | third dimension coordinate of maximum target power |
[out] | power | Peak measured power in arena (value of strongest pixel) |
WALABOT_RESULT Walabot_GetSensorTargets | ( | SensorTarget ** | targets, |
int * | numTargets | ||
) |
Provides a list of and the number of identified targets.
Available only if one of the Sensor scan profiles was used.
Requires previous Walabot_Trigger(); provides data based on last completed triggered image.
Provided image data is dependent on current configured arena and on current configuration from Walabot_SetDynamicImageFilter() and Walabot_SetThreshold().
[out] | targets | List of identified targets |
[out] | numTargets | Number of identified targets |
WALABOT_RESULT Walabot_GetSignal | ( | int | txAntenna, |
int | rxAntenna, | ||
double ** | signal, | ||
double ** | timeAxis, | ||
int * | numSamples | ||
) |
Obtains raw image data from specified antennas.
[in] | txAntenna | Transmitting antenna ID as obtained from Walabot_GetAntennaPairs() |
[in] | rxAntenna | Receiving antenna ID as obtained from Walabot_GetAntennaPairs() |
[out] | signal | List of amplitude values representing received signal amplitude in time domain |
[out] | timeAxis | time axis ticks values |
[out] | numSamples | Number of sample in the list |
WALABOT_RESULT Walabot_GetStatus | ( | APP_STATUS * | status, |
double * | param | ||
) |
Obtains Walabot status.
For an explanation of possible statuses, see APP_STATUS.
[out] | status | Walabot's status |
[out] | param | Percentage of calibration completed, if status is STATUS_CALIBRATING |
WALABOT_RESULT Walabot_GetThreshold | ( | double * | threshold | ) |
Obtains the current sensitivity threshold.
To set the threshold, use Walabot_SetThreshold().
[out] | threshold | The current threshold value |
WALABOT_RESULT Walabot_GetVersion | ( | char ** | version | ) |
Obtains current Walabot version.
Function returns Walabot version. The version is build from according to
the following parameters:
1) HW version - Walabot device revision.
2) SW version - Walabot SW revision.
3) Regulation information (where applicable).
The user needs to pass pointer to array, and function returns
a pointer to string (array of char) with the version.
The function can be called only after connecting to the device.
[out] | version | pointer to array of char with the version |
WALABOT_RESULT Walabot_SetAdvancedParameter | ( | char * | paramName, |
double | value | ||
) |
Set advanced Walabot parameter.
[in] | paramName | type Filter algorithm to use PARAM_DIELECTRIC_CONSTANT |
[in] | value | advance parameter set value |
WALABOT_RESULT Walabot_SetArenaPhi | ( | double | min, |
double | max, | ||
double | res | ||
) |
Sets azimuth (Φ) range and resolution of arena.
For coordinate directions, see Coordinate Systems.
To check the current value, use Walabot_GetArenaPhi().
Spherical (r-Θ-Φ) coordinates should be used only to get image data from a triggered scan that used one of the Sensor profiles. Otherwise use the Walabot_SetArena functions for cartesian (X-Y-Z) coordinates.
[in] | min | Beginning of azimuth angular range (degrees) |
[in] | max | End of azimuth angular range (degrees) |
[in] | res | Angle between pixels across polar angle (degrees) |
WALABOT_RESULT Walabot_SetArenaR | ( | double | start, |
double | end, | ||
double | res | ||
) |
Sets radial (r) range and resolution of arena.
For coordinate directions, see Coordinate Systems.
To check the current value, use Walabot_GetArenaR().
Spherical (r-Θ-Φ) coordinates should be used only to get image data from a triggered scan that used one of the Sensor profiles. Otherwise use the Walabot_SetArena functions for cartesian (X-Y-Z) coordinates.
[in] | start | Beginning of radial distance range (cm) |
[in] | end | End of radial distance range (cm) |
[in] | res | Distance between pixels along radius (cm) |
WALABOT_RESULT Walabot_SetArenaTheta | ( | double | min, |
double | max, | ||
double | res | ||
) |
Sets polar (Θ) range and resolution of arena.
For coordinate directions, see Coordinate Systems.
To check the current value, use Walabot_GetArenaTheta().
Spherical (r-Θ-Φ) coordinates should be used only to get image data from a triggered scan that used one of the Sensor profiles. Otherwise use the Walabot_SetArena functions for cartesian (X-Y-Z) coordinates.
[in] | min | start Beginning of polar angular range (degrees) |
[in] | max | end End of polar angular range (degrees) |
[in] | res | Angle between pixels across polar angle (degrees) |
WALABOT_RESULT Walabot_SetArenaX | ( | double | min, |
double | max, | ||
double | res | ||
) |
Sets X-axis range and resolution of arena.
For coordinate directions, see Coordinate Systems.
To check the current value, use Walabot_GetArenaX().
Note: Cartesian (X-Y-Z) coordinates should be used only to get image data from a triggered scan that used the short-range profile. Otherwise use the Walabot_SetArena functions for spherical (r-Θ-Φ) coordinates.
[in] | min | Beginning of range on axis (cm) |
[in] | max | End of range on axis (cm) |
[in] | res | Distance between pixels along axis (cm) |
WALABOT_RESULT Walabot_SetArenaY | ( | double | min, |
double | max, | ||
double | res | ||
) |
Sets Y-axis range and resolution of arena.
For coordinate directions, see Coordinate Systems.
To check the current value, use Walabot_GetArenaY().
Note: Cartesian (X-Y-Z) coordinates should be used only to get image data from a triggered scan that used the short-range profile. Otherwise use the Walabot_SetArena functions for spherical (r-Θ-Φ) coordinates.
[in] | min | Beginning of range on axis (cm) |
[in] | max | End of range on axis (cm) |
[in] | res | Distance between pixels along axis (cm) |
WALABOT_RESULT Walabot_SetArenaZ | ( | double | start, |
double | end, | ||
double | res | ||
) |
Sets Z-axis range and resolution of arena.
For coordinate directions, see Coordinate Systems.
To check the current value, use Walabot_GetArenaZ().
Note: Cartesian (X-Y-Z) coordinates should be used only to get image data from a triggered scan that used the short-range profile. Otherwise use the Walabot_SetArena functions for spherical (r-Θ-Φ) coordinates.
[in] | start | Beginning of range on axis (cm) |
[in] | end | End of range on axis (cm) |
[in] | res | Distance between pixels along axis (cm) |
WALABOT_RESULT Walabot_SetDynamicImageFilter | ( | FILTER_TYPE | type | ) |
Dynamic-imaging filter removes static signals, leaving only changing signals.
Specify filter algorithm to use. Filters are explained in Imaging Features.
Filter is not applied to Walabot_GetImageEnergy().
To check the current value, use Walabot_GetDynamicImageFilter().
[in] | type | Filter algorithm to use |
WALABOT_RESULT Walabot_SetProfile | ( | APP_PROFILE | profile | ) |
Sets scan profile.
For an explanation of available profiles, see Imaging Features.
[in] | profile | The scan profile to use |
WALABOT_RESULT Walabot_SetSettingsFolder | ( | char * | folder | ) |
Obtains Sets location of Walabot internal database, if moved from default.
[in] | folder | Database location |
WALABOT_RESULT Walabot_SetThreshold | ( | double | value | ) |
Changes the sensitivity threshold.
For raw images (3-D and Slice), Walabot removes very weak signals, below this threshold. If the threshold is not set, a default value is used.
To check the current value, use Walabot_GetThreshold().
[in] | value | The threshold to set |
WALABOT_RESULT Walabot_Start | ( | ) |
Starts Walabot in preparation for scanning.
Requires previous Connect (Walabot_ConnectAny() or Walabot_Connect() ) and Walabot_SetProfile().
Required before Walabot_Trigger() and GET actions.
WALABOT_RESULT Walabot_StartCalibration | ( | ) |
Initiates calibration.
Ignores or reduces the signals of fixed reflectors such as walls according to environment.
Must be performed initially (to avoid delays – preferably before Walabot_Start()), upon any profile change, and is recommended upon possible changes to environment.
Calibration is done via recording and processing. So after calling StartCalibration, a continues trigger & GetImage/GetTargets function calls is required. To check on calibration progress, use Walabot_GetStatus().
WALABOT_RESULT Walabot_Stop | ( | ) |
Stops Walabot when finished scanning.
WALABOT_RESULT Walabot_Trigger | ( | ) |
Initiates a scan and records signals.
Initiates a scan according to profile and records signals to be available for processing and retrieval.
Should be performed before every GET action.