IWPOCTConverter.h

Go to the documentation of this file.

 
#pragma once
 
// Forward declarations.
struct IWPOCTInOutData;
 
struct IWPOCTConverter
{
    enum ErrorCode
    {
        NoError = 0,
        NullPointer = 1,
        FileReadError = 2,
        FileWriteError = 3,
        FileOrDirNotFound = 4,
        InvalidFileOrDirName = 5,
        InvalidArgumentValue = 6,
        MemoryAllocationError = 7,
        BackgroundUpdateError = 8,
        ConversionError = 9,
        CompatibleGraphicsCardNotFound = 10,
        StartOpenCLError = 11,
        ScanProcessorInitError = 12,
        DongleNotFound = 13,
        NumErrors = 14
    };
 
    virtual ~IWPOCTConverter() { }
 
    // Getters
 
    virtual const char* GetQualifiedInputFileName   () const = 0;
 
    virtual const char* GetOutputIntensityName      () const = 0;
 
    virtual const char* GetOutputPhaseName          () const = 0;
 
    virtual const char* GetOutputDirectory          () const = 0;
 
    virtual const char* GetCalibrationFringeFile    () const = 0;
 
    virtual bool    GetOutputIntensity              () const = 0;
 
    virtual bool    GetOutputPhase                  () const = 0;
 
    virtual bool    GetDeleteInputFileAfterConversion() const = 0;
 
    virtual bool    GetOutputTiffFormat             () const = 0;
 
    virtual bool    GetOutputLogOfData              () const = 0;
 
    virtual bool    GetUseScaling                   () const = 0;
 
    virtual bool    GetUseContrast                  () const = 0;
 
    virtual int     GetAScansPerBScan               () const = 0;
 
    virtual int     GetAScanSize                    () const = 0;
 
    virtual int     GetAScanAverage                 () const = 0;
 
    virtual bool    GetScanDimensions               (int* width, int* height) const = 0;
 
    virtual bool    GetDispersionCoefficients       (float* coefficients, int length) const = 0;
 
    virtual bool    GetNumberOfLinesToIgnore        (int* top, int* bottom) const = 0;
 
    virtual bool    GetMinMaxScaling                (float* min, float* max) const = 0;
 
    virtual int     GetNumScanProcessors            () const = 0;
 
    virtual bool    GetUseMovingAverage             () const = 0;
 
    virtual int     GetMovingAverageWindowSize      ()  const = 0;
 
    // Setters
 
    virtual bool    SetQualifiedInputFileName       (const char* name) = 0;
 
    virtual bool    SetOutputIntensityName          (const char* name) = 0;
 
    virtual bool    SetOutputPhaseName              (const char* name) = 0;
 
    virtual bool    SetOutputDirectory              (const char* name) = 0;
 
    virtual bool    SetCalibrationFringeFile        (const char* name) = 0;
 
    virtual bool    UpdateBackgroundImage           () = 0;
 
    // Gets the background image, which is the size of AscanSize.  It can be the
    // result of averaging an input image or it can be an image specified by the
    // user by calling SetBackgroundImage.
    virtual bool    GetBackgroundImage              (float* buffer, int size) = 0;
 
    virtual bool    SetBackgroundImage              (float* buffer, int size) = 0;
 
    virtual bool    SetOutputIntensity              (bool value) = 0;
 
    virtual bool    SetOutputPhase                  (bool value) = 0;
 
    virtual bool    SetDeleteInputFileAfterConversion(bool value) = 0;
 
    virtual bool    SetOutputTiffFormat             (bool value) = 0;
 
    virtual bool    SetOutputLogOfData              (bool value) = 0;
 
    virtual bool    SetUseScaling                   (bool value) = 0;
 
    virtual bool    SetUseContrast                  (bool value) = 0;
 
    virtual bool    SetAScansPerBScan               (int value) = 0;
 
    virtual bool    SetAScanSize                    (int value) = 0;
 
    virtual bool    SetAScanAverage                 (int value) = 0;
 
    virtual bool    SetScanDimensions               (int aScansPerBScan , int aScanSize) = 0;
 
    virtual bool    SetDispersionCoefficients       (const float* coefficients, int length) = 0;
 
    virtual bool    SetDispersionOptimizationParameters(int numCoefficients, int maxIterations, 
                                                        float* initialGuesses, int startLine, 
                                                        int stopLine, int offset) = 0;
 
    virtual bool    SetNumberOfLinesToIgnore        (int top, int bottom) = 0;
 
    virtual bool    SetMinMaxScaling                (float min, float max) = 0;
 
    virtual bool    SetNumScanProcessors(int value) = 0;
 
    virtual bool    SetUseMovingAverage             (bool value) = 0;
 
    virtual bool    SetMovingAverageWindowSize      (int value) = 0;
 
    virtual bool    ResetMovingAverage              () = 0;
 
    // Conversion Commands
 
    virtual bool    ConvertSpectralDataToIntensity  (IWPOCTInOutData* inOutData) = 0;
 
    virtual bool    ConvertSpectralDataToIntensity  (const unsigned short* inData, float* outIntensity) = 0;
 
    virtual bool    ConvertSpectralDataToPhaseIntensity (IWPOCTInOutData* inOutData) = 0;
 
    virtual bool    ConvertSpectralDataToPhaseIntensity (const unsigned short* inData, 
                                                         float* outIntensity, float* outPhase) = 0;
 
    virtual bool    ConvertSpectralFileToPhaseIntensity () = 0;
 
    virtual bool    ConvertSpectralFileToPhaseIntensity (const char* qualifiedFileName) = 0;
 
    virtual bool    ConvertSpectralDirToPhaseIntensity  () = 0;
 
    virtual bool    ConvertFloatToUnsignedChar          (const float* inData, unsigned char* outData, 
                                                         int size) const = 0;
 
    virtual bool    ConvertFloatToUnsignedShort         (const float* inData, unsigned short* outData, 
                                                            int size) const = 0;
    // Transformation Commands
 
    virtual bool    TransposeArray  (const float *inData, float *outData, int inWidth, int inHeight) const = 0;
 
    virtual bool    TransposeArray  (const unsigned short* inData, unsigned short* outData, int inWidth, 
                                     int inHeight) const = 0;
 
    virtual bool    TransposeArray  (const unsigned char* src, unsigned char* dst, int inWidth, 
                                     int inHeight) const = 0;
 
    virtual bool    FlipVertical    (unsigned short* data, int width, int height) const = 0;
 
    virtual bool    FlipHorizontal  (unsigned short* data, int width, int height) const = 0;
 
    virtual bool    RotateImage     (const unsigned short* inData, unsigned short* outData, int width, 
                                     int height, unsigned int cw90Multiplier) const = 0;
 
    // Calculation Commands
 
    virtual bool    CalcDispersionCoefficients      (const unsigned short* inData, int width, 
                                                     int height, float* coefficients) = 0;
    // Status Commands
 
    virtual IWPOCTConverter::ErrorCode  GetLastError() const = 0;
 
// Include the section below when compiling with Swig.
#ifdef _RUNSWIG
    static IWPOCTConverter* GetOCTConverter();
 
    static bool DestroyOCTConverter();
};
 
// Include the section below when compiling in Visual Studio.
#else
};
#ifdef __cplusplus
extern "C" {
#endif
 
__declspec(dllexport) IWPOCTConverter*  GetOCTConverter     ();
 
__declspec(dllexport) bool              DestroyOCTConverter ();
 
#ifdef __cplusplus
}
#endif
#endif