ophLightField.h

Go to the documentation of this file.

/*M///////////////////////////////////////////////////////////////////////////////////////
//
//  IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING.
//
//  By downloading, copying, installing or using the software you agree to this license.
//  If you do not agree to this license, do not download, install, copy or use the software.
//
//
//                           License Agreement
//                For Open Source Digital Holographic Library
//
// Openholo library is free software;
// you can redistribute it and/or modify it under the terms of the BSD 2-Clause license.
//
// Copyright (C) 2017-2024, Korea Electronics Technology Institute. All rights reserved.
// E-mail : contact.openholo@gmail.com
// Web : http://www.openholo.org
//
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
//
//  1. Redistribution's of source code must retain the above copyright notice,
//     this list of conditions and the following disclaimer.
//
//  2. Redistribution's in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation
//     and/or other materials provided with the distribution.
//
// This software is provided by the copyright holders and contributors "as is" and
// any express or implied warranties, including, but not limited to, the implied
// warranties of merchantability and fitness for a particular purpose are disclaimed.
// In no event shall the copyright holder or contributors be liable for any direct,
// indirect, incidental, special, exemplary, or consequential damages
// (including, but not limited to, procurement of substitute goods or services;
// loss of use, data, or profits; or business interruption) however caused
// and on any theory of liability, whether in contract, strict liability,
// or tort (including negligence or otherwise) arising in any way out of
// the use of this software, even if advised of the possibility of such damage.
//
// This software contains opensource software released under GNU Generic Public License,
// NVDIA Software License Agreement, or CUDA supplement to Software License Agreement.
// Check whether software you use contains licensed software.
//
//M*/

#ifndef __ophLightField_h
#define __ophLightField_h

#include "ophGen.h"
using namespace oph;


//Build Option : Multi Core Processing (OpenMP)
#ifdef _OPENMP
#include <omp.h>
#endif



class GEN_DLL ophLF : public ophGen
{
public:
    explicit ophLF(void);

protected:
    virtual ~ophLF(void) {}

public:
    inline void setNumImage(int nx, int ny) { num_image[_X] = nx; num_image[_Y] = ny; }
    inline void setNumImage(ivec2 num) { num_image = num; }
    inline void setResolImage(int nx, int ny) { resolution_image[_X] = nx; resolution_image[_Y] = ny; }
    inline void setResolImage(ivec2 num) { resolution_image = num; }
    inline void setDistRS2Holo(Real dist) { distanceRS2Holo = dist; }
    inline void setFieldLens(Real lens) { fieldLens = lens; }
    inline ivec2 getNumImage() { return num_image; }
    inline ivec2 getResolImage() { return resolution_image; }
    inline Real getDistRS2Holo() { return distanceRS2Holo; }
    inline Real getFieldLens() { return fieldLens; }
    inline vector<uchar*> getLF() { return m_vecImages; }
    inline vector<Complex<Real>*> getRSPlane() { return m_vecRSplane; }
public:
    bool readConfig(const char* fname);

    int loadLF(const char* directory, const char* exten);
    //void readPNG(const string filename, uchar* data);

    void generateHologram();

    // for Testing 
    void writeIntensity_gray8_bmp(const char* fileName, int nx, int ny, Complex<Real>* complexvalue, int k = -1);
    void setViewingWindow(bool is_ViewingWindow);
protected:
    
    // Inner functions

    void initializeLF();
    void convertLF2ComplexField();

    // ==== GPU Methods ===============================================
    void convertLF2ComplexField_GPU();
    
    void ophFree();

private:
    ivec2 num_image;                        
    ivec2 resolution_image;                 
    Real distanceRS2Holo;                   
    Real fieldLens;
    bool is_ViewingWindow;
    int nImages;
    std::vector<int> m_vecImgSize;
    std::vector<uchar*> m_vecImages;                        // Light Field array / 4-D array
    std::vector<Complex<Real>*> m_vecRSplane;
    //Complex<Real>** RSplane_complex_field;            /// Complex field in Ray Sampling plane
};


#endif