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_ERR_INVALID_PORT_DEFINITION,            
    WALABOT_ERR_TOO_MANY_SAMPLES,                   
    WALABOT_ERR_RECORDING_THREAD_ALREADY_RUNNING,   
    WALABOT_ERR_RECORDING_WITHOUT_APPLY_SETTINGS,   
    WALABOT_ERR_READ_WITHOUT_APPLY_SETTINGS,        
    WALABOT_ERR_INVALID_PAGE_INDEX,                 
    WALABOT_ERR_INVALID_TXRX_PAIR,                  
    WALABOT_ERR_AMBIGUOUS_TXRX_PAIR,                
    WALABOT_ERR_PORTGROUP_INDEX_OUT_OF_BOUNDS,      
    WALABOT_ERR_RX_PORT_OUT_OF_BOUNDS,              
    WALABOT_ERR_NO_DATA,                            
    WALABOT_ERR_USB_READ_FAILURE,                   
    WALABOT_PARAMETER_NOT_FOUND,                    
    WALABOT_OUT_OF_RANGE,                           
    WALABOT_READONLY_PARAMETER,                     
    WALABOT_ERR_ARENA_SIZE_TOO_BIG,                 
    WALABOT_DD_ERR_USB_DEVICE_WENT_DOWN,            
    WALABOT_ERR_INVALID_PARAMETER,                  
    WALABOT_INSTRUMENT_NOT_FOUND,                   
    WALABOT_BUFFER_TOO_SMALL,                       
    WALABOT_INVALID_ARRAY_SIZE,                     
    WALABOT_INVALID_PROFILE,                        
    WALABOT_ERR_NO_IMAGE,                           
    WALABOT_ERR_GENERAL,                            
    // Here are the error groups
    WALABOT_ERR_PROTOCOL = 0x00010000,              
    WALABOT_ERR_DEVICE_STORAGE = 0x00020000,        
    WALABOT_ERR_DB = 0x00030000,                    
    WALABOT_ERR_USB = 0x00040000,                   
    WALABOT_ERR_SEQ = 0x00050000,
    
    WALABOT_ERR_SCHEDULER = 0x00070000,             
    WALABOT_ERR_HW_PLAN = 0x00080000,               
    WALABOT_ERR_MULTI_CHIP = 0x00090000,            
    WALABOT_ERR_REC_PLAN = 0x000A0000,              
    WALABOT_ERR_NULL_OBJECT = 0x000B0000,           
    WALABOT_ERR_IN_COMPILER = 0x000C0000,           
    WALABOT_ERR_IN_INITIALIZATION = 0x000D0000,     
    WALABOT_ERR_SETTING_FOLDER = 0x000E0000,        
    WALABOT_ERR_LOG = 0x000F0000,                   

    WALABOT_GENERAL_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_SENSOR                 = 0x00020000,   
    PROF_SENSOR_NARROW                          
};

enum APP_STATUS 
{
    STATUS_DISCONNECTED, 
    STATUS_CONNECTED,   
    STATUS_IDLE,        
    STATUS_SCANNING,    
    STATUS_CALIBRATING  
};

enum TARGET_TYPE 
{
    TARGET_TYPE_UNKNOWN,  
    TARGET_TYPE_PIPE
};

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;


#define WALABOT_API extern "C" __declspec(dllimport)

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_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_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);