1 /*
2  * Copyright (c) 2011-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_MS_CREATE_H_
30 #define OSKAR_MS_CREATE_H_
31 
32 /**
33  * @file oskar_ms_create.h
34  */
35 
36 #include <ms/oskar_ms_macros.h>
37 
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 /**
43  * @brief Creates a new Measurement Set.
44  *
45  * @details
46  * Creates a new, empty Measurement Set with the given name.
47  *
48  * @param[in] file_name       The file name to use.
49  * @param[in] app_name        The name of the application creating the MS.
50  * @param[in] num_stations    The number of antennas/stations.
51  * @param[in] num_channels    The number of channels in the band.
52  * @param[in] num_pols        The number of polarisations (1, 2 or 4).
53  * @param[in] freq_start_hz   The frequency at the centre of channel 0, in Hz.
54  * @param[in] freq_inc_hz     The channel separation, in Hz.
55  * @param[in] write_autocorr  If set, write auto-correlation data.
56  * @param[in] write_crosscorr If set, write cross-correlation data.
57  */
58 OSKAR_MS_EXPORT
59 oskar_MeasurementSet* oskar_ms_create(const char* file_name,
60         const char* app_name, unsigned int num_stations,
61         unsigned int num_channels, unsigned int num_pols, double freq_start_hz,
62         double freq_inc_hz, int write_autocorr, int write_crosscorr);
63 
64 #ifdef __cplusplus
65 }
66 #endif
67 
68 #endif /* OSKAR_MS_CREATE_H_ */
69