1 /* 2 * Copyright (c) 2016-2019, The University of Oxford 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 1. Redistributions of source code must retain the above copyright notice, 8 * this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright notice, 10 * this list of conditions and the following disclaimer in the documentation 11 * and/or other materials provided with the distribution. 12 * 3. Neither the name of the University of Oxford nor the names of its 13 * contributors may be used to endorse or promote products derived from this 14 * software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 #ifndef OSKAR_GRID_CORRECTION_H_ 30 #define OSKAR_GRID_CORRECTION_H_ 31 32 /** 33 * @file oskar_grid_correction.h 34 */ 35 36 #include <oskar_global.h> 37 #include <mem/oskar_mem.h> 38 39 #ifdef __cplusplus 40 extern "C" { 41 #endif 42 43 /** 44 * @brief 45 * Applies grid correction to an image. 46 * 47 * @details 48 * Applies grid correction to an image, given the correction function to use. 49 * This correction should be applied to the complex image, 50 * immediately after taking the FFT. 51 * 52 * @param[in] image_size Side length of image. 53 * @param[in] corr_func Correction function, length \p image_size. 54 * @param[in,out] complex_image Complex image array. 55 * @param[in,out] status Status return code. 56 */ 57 OSKAR_EXPORT 58 void oskar_grid_correction(const int image_size, 59 const oskar_Mem* corr_func, oskar_Mem* complex_image, int* status); 60 61 #ifdef __cplusplus 62 } 63 #endif 64 65 #endif /* OSKAR_GRID_CORRECTION_H_ */ 66