1 /*
2  * Copyright (c) 2017, 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_IMAGER_FILTER_TIME_H_
30 #define OSKAR_IMAGER_FILTER_TIME_H_
31 
32 /**
33  * @file oskar_imager_filter_time.h
34  */
35 
36 #include <oskar_global.h>
37 #include <mem/oskar_mem.h>
38 #include <stddef.h>
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 /**
45  * @brief
46  * Filters supplied visibility data using the time range.
47  *
48  * @details
49  * Filters supplied visibility data using the time range,
50  * if it has been set. If not set, this function returns immediately.
51  *
52  * @param[in,out] h             Handle to imager.
53  * @param[in,out] num_vis       On input, number of supplied visibilities;
54  *                              on output, number of visibilities remaining.
55  * @param[in,out] uu            Baseline uu coordinates, in wavelengths.
56  * @param[in,out] vv            Baseline vv coordinates, in wavelengths.
57  * @param[in,out] ww            Baseline ww coordinates, in wavelengths.
58  * @param[in,out] amp           Baseline complex visibility amplitudes.
59  * @param[in,out] weight        Baseline visibility weights.
60  * @param[in,out] time_centroid Time centroid values as MJD(UTC) _seconds_
61  *                              (double precision).
62  * @param[in,out] status        Status return code.
63  */
64 OSKAR_EXPORT
65 void oskar_imager_filter_time(oskar_Imager* h, size_t* num_vis,
66         oskar_Mem* uu, oskar_Mem* vv, oskar_Mem* ww, oskar_Mem* amp,
67         oskar_Mem* weight, oskar_Mem* time_centroid, int* status);
68 
69 #ifdef __cplusplus
70 }
71 #endif
72 
73 #endif /* OSKAR_IMAGER_FILTER_TIME_H_ */
74