1 /* 2 * Copyright (c) 2012-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_SKY_SCALE_FLUX_WITH_FREQUENCY_H_ 30 #define OSKAR_SKY_SCALE_FLUX_WITH_FREQUENCY_H_ 31 32 /** 33 * @file oskar_sky_scale_flux_with_frequency.h 34 */ 35 36 #include <oskar_global.h> 37 38 #ifdef __cplusplus 39 extern "C" { 40 #endif 41 42 /** 43 * @brief 44 * Scales all current source brightnesses according to the spectral index for 45 * the given frequency. 46 * 47 * @details 48 * This function evaluates all fluxes (all Stokes parameters) at the specified 49 * frequency using the spectral index of each source. The reference frequency 50 * of each source is also updated to the specified frequency. 51 * 52 * Frequency scaling is performed using the expression: 53 * 54 * \f[ 55 * F = F * (\nu / \nu_0)^\alpha 56 * \f] 57 * 58 * where \f$F\f$ is the flux, \f$\nu\f$ is the new frequency, \f$\nu_0\f$ is 59 * the reference frequency, and \f$\alpha\f$ is the spectral index value. 60 * 61 * @param[in,out] sky The sky model to re-scale. 62 * @param[in] frequency The required frequency, in Hz. 63 * @param[in,out] status Status return code. 64 */ 65 OSKAR_EXPORT 66 void oskar_sky_scale_flux_with_frequency(oskar_Sky* sky, double frequency, 67 int* status); 68 69 #ifdef __cplusplus 70 } 71 #endif 72 73 #endif /* OSKAR_SKY_SCALE_FLUX_WITH_FREQUENCY_H_ */ 74