WalabotAPI.h

Go to the documentation of this file.

#pragma once

/******************************************************************************
* CONFIDENTIAL AND PROPRIETARY DATA                                           *
*===================================                                          *
*                                                                             *
* Copyright 2015 Vayyar Imaging Ltd. All rights reserved.                     *
*                                                                             *
* This document is the property of Vayyar and all  materials  and information *
* contained herein are the confidential and proprietary information of Vayyar *
* and are protected by international copyright laws. The copyrights are owned *
* by  Vayyar  or  the  original  creator  of the material.  The materials and *
* information contained herein  are provided to you  for internal information *
* purposes only,  and no portion of the materials and  information herein may *
* be  copied,  reproduced,  distributed,  transmitted,  displayed, published, *
* broadcasted  or  used  in any way whatsoever directly or indirectly without *
* the  prior  written  consent  of  Vayyar  or  in  any  case  of third party *
* materials,  without  that  third  party's  consent.  This document shall be *
* returned to Vayyar promptly upon request.                                   *
*                                                                             *
* The materials  and  information  contained  herein are provided "AS IS" and *
* Vayyar  does  not  provide  any  warranties of any kind, whether express or *
* implied, including but not limited to implied warranties of merchantability,*
* fitness for a particular purpose, and non-infringement.                     *
*                                                                             *
******************************************************************************/

typedef enum WALABOT_RESULT_ENUM
{
    WALABOT_SUCCESS,                                
    WALABOT_ERROR                           
}WALABOT_RESULT;

typedef struct vcomplex_struct 
{
    double real; 
    double imag; 
}vcomplex;

typedef struct AntennaPair_struct 
{
    int txAntenna; 
    int rxAntenna; 
}AntennaPair;

enum APP_PROFILE 
{
    PROF_SHORT_RANGE_IMAGING = 0x00010000,  
    PROF_SHORT_RANGE_SINGLE_LINE,           
    PROF_KNOCK_KNOCK,                       

    PROF_SENSOR = 0x00020000,               
    PROF_SENSOR_NARROW,                     
    PROF_TRACKER = 0x00030000,
    PROF_WIDE_BAND = 0x00040000

};

enum APP_STATUS 
{
    STATUS_CLEAN,
    STATUS_INITIALIZED, 
    STATUS_CONNECTED,   
    STATUS_CONFIGURED,  
    STATUS_SCANNING,    
    STATUS_CALIBRATING, 
    STATUS_CALIBRATING_NO_MOVEMENT  
};

enum TARGET_TYPE
{
    TARGET_TYPE_UNKNOWN,
    TARGET_TYPE_PIPE,
    TARGET_TYPE_STUD,
    TARGET_TYPE_STUD90,
    TARGET_TYPE_STUD_METAL,
    TARGET_TYPE_OTHER
};

enum FILTER_TYPE  
{
    FILTER_TYPE_NONE,       
    FILTER_TYPE_DERIVATIVE, 
    FILTER_TYPE_MTI         
};

typedef struct ImagingTarget_struct 
{
    TARGET_TYPE     type;       
    double          angleDeg;   
    double          xPosCm;     
    double          yPosCm;     
    double          zPosCm;     
    double          widthCm;    
    double          amplitude;  
}ImagingTarget;


typedef struct SensorTarget_struct 
{
    double          xPosCm;     
    double          yPosCm;     
    double          zPosCm;     
    double          amplitude;  
}SensorTarget;


typedef struct TrackerTarget_struct 
{
    double          xPosCm;     
    double          yPosCm;     
    double          zPosCm;     
    double          amplitude;  
}TrackerTarget;


#ifdef _WIN32
    #ifdef WALABOT_EXPORTS
    #define WALABOT_API __declspec(dllexport) 
    #else
    #define WALABOT_API __declspec(dllimport)
    #endif
#else
    #define WALABOT_API
#endif


extern "C" {

WALABOT_API WALABOT_RESULT Walabot_Initialize(const char* configFilename);
WALABOT_API WALABOT_RESULT Walabot_Clean();

WALABOT_API int Walabot_GetExtendedError();

WALABOT_API const char* Walabot_GetErrorString();

WALABOT_API WALABOT_RESULT Walabot_SetSettingsFolder(char* folder);

WALABOT_API WALABOT_RESULT Walabot_GetInstrumentsList(int bufMaxSize, char* outputBuffer);

WALABOT_API WALABOT_RESULT Walabot_Connect(char* uid);

WALABOT_API WALABOT_RESULT Walabot_ConnectAny();

WALABOT_API WALABOT_RESULT Walabot_Disconnect();

WALABOT_API WALABOT_RESULT Walabot_Start();

WALABOT_API WALABOT_RESULT Walabot_Stop();

WALABOT_API WALABOT_RESULT Walabot_Trigger();

WALABOT_API WALABOT_RESULT Walabot_GetAntennaPairs(AntennaPair** antennaPairs, int* numPairs);

WALABOT_API WALABOT_RESULT Walabot_GetSignal(int txAntenna, int rxAntenna, double** signal, double** timeAxis, int* numSamples);

WALABOT_API WALABOT_RESULT Walabot_SetProfile(APP_PROFILE profile);

WALABOT_API WALABOT_RESULT Walabot_GetStatus(APP_STATUS* status, double* param);

WALABOT_API WALABOT_RESULT Walabot_StartCalibration();

WALABOT_API WALABOT_RESULT Walabot_CancelCalibration();

WALABOT_API WALABOT_RESULT Walabot_SetThreshold(double value);  

WALABOT_API WALABOT_RESULT Walabot_SetTrackerAquisitionThreshold(double value);
WALABOT_API WALABOT_RESULT Walabot_GetThreshold(double* threshold);

WALABOT_API WALABOT_RESULT Walabot_SetArenaX(double min, double max, double res);

WALABOT_API WALABOT_RESULT Walabot_SetArenaY(double min, double max, double res);

WALABOT_API WALABOT_RESULT Walabot_SetArenaZ(double start, double end, double res);

WALABOT_API WALABOT_RESULT Walabot_SetArenaR(double start, double end, double res);

WALABOT_API WALABOT_RESULT Walabot_SetArenaTheta(double min, double max, double res);

WALABOT_API WALABOT_RESULT Walabot_SetArenaPhi(double min, double max, double res);

WALABOT_API WALABOT_RESULT Walabot_GetArenaX(double* min, double* max, double* res);

WALABOT_API WALABOT_RESULT Walabot_GetArenaZ(double* start, double* end, double* res);

WALABOT_API WALABOT_RESULT Walabot_GetArenaY(double* min, double* max, double* res);

WALABOT_API WALABOT_RESULT Walabot_GetArenaR(double* start, double* end, double* res);

WALABOT_API WALABOT_RESULT Walabot_GetArenaTheta(double* min, double* max, double* res);

WALABOT_API WALABOT_RESULT Walabot_GetArenaPhi(double* min, double* max, double* res);

WALABOT_API WALABOT_RESULT Walabot_GetRawImageSlice(int** rasterImage, int* sizeX, int* sizeY, double* sliceDepth, double* power);

WALABOT_API WALABOT_RESULT Walabot_GetRawImage(int** rasterImage, int* sizeX, int* sizeY, int* sizeZ, double* power);

WALABOT_API WALABOT_RESULT Walabot_GetImageEnergy(double* energy);

WALABOT_API WALABOT_RESULT Walabot_GetImagingTargets(ImagingTarget** targets, int* numTargets);

WALABOT_API WALABOT_RESULT Walabot_GetSensorTargets(SensorTarget** targets, int* numTargets);

WALABOT_API WALABOT_RESULT Walabot_GetTrackerTargets(TrackerTarget** targets, int* numTargets);


WALABOT_API WALABOT_RESULT Walabot_SetDynamicImageFilter(FILTER_TYPE type);


WALABOT_API WALABOT_RESULT Walabot_GetDynamicImageFilter(FILTER_TYPE* type);

WALABOT_API WALABOT_RESULT Walabot_GetVersion(char** version);

#define PARAM_DIELECTRIC_CONSTANT   ((char*)"DielectricConstant")

#define PARAM_CONFIDENCE_FACTOR         ((char*)"ConfidenceFactor")

WALABOT_API WALABOT_RESULT Walabot_SetAdvancedParameter(char* paramName, double value);

WALABOT_API WALABOT_RESULT Walabot_GetAdvancedParameter(char* paramName, double* value);

WALABOT_API WALABOT_RESULT Walabot_GetAntennaLocation(int antennaNum, double& X, double& Y, double& Z);

}