1 /* 2 * Copyright (c) 2016, 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_SKY_FROM_FITS_FILE_H_ 30 #define OSKAR_SKY_FROM_FITS_FILE_H_ 31 32 /** 33 * @file oskar_sky_from_fits_file.h 34 */ 35 36 #include <oskar_global.h> 37 38 #ifdef __cplusplus 39 extern "C" { 40 #endif 41 42 /** 43 * @brief 44 * Creates a sky model from an array of image pixels. 45 * 46 * @details 47 * Creates a sky model from an array of image pixels. 48 * 49 * The \p default_map_units can be either "Jy/beam", "Jy/pixel", "K" or "mK". 50 * 51 * @param[in] precision Enumerated precision of the output sky model. 52 * @param[in] filename Pathname of FITS file to load. 53 * @param[in] min_peak_fraction Minimum allowed fraction of image peak. 54 * @param[in] min_abs_val Ignore pixels below this value. 55 * @param[in] default_map_units Map units, if not found from the file. 56 * @param[in] override_units If set, override map units with the default. 57 * @param[in] frequency_hz Frequency of image data, in Hz, if not found. 58 * @param[in] spectral_index Spectral index to give each pixel. 59 * @param[in,out] status Status return code. 60 */ 61 OSKAR_EXPORT 62 oskar_Sky* oskar_sky_from_fits_file(int precision, const char* filename, 63 double min_peak_fraction, double min_abs_val, 64 const char* default_map_units, int override_units, double frequency_hz, 65 double spectral_index, int* status); 66 67 #ifdef __cplusplus 68 } 69 #endif 70 71 #endif /* OSKAR_SKY_FROM_FITS_FILE_H_ */ 72