File: pycomponent_list.cc

package info (click to toggle)
wsclean 3.6-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 16,296 kB
  • sloc: cpp: 129,246; python: 22,066; sh: 360; ansic: 230; makefile: 185
file content (73 lines) | stat: -rw-r--r-- 2,909 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
// SPDX-License-Identifier: LGPL-3.0-only

#include "component_list.h"
#include "radler.h"

#include <set>
#include <vector>
#include <stdexcept>

#include <pybind11/pybind11.h>
#include <pybind11/stl.h>
#include <pybind11/stl_bind.h>

namespace py = pybind11;

// Enables pass-by-reference of stl vectors, see
// https://pybind11.readthedocs.io/en/stable/advanced/cast/stl.html?highlight=PYBIND11_MAKE_OPAQUE#making-opaque-types
PYBIND11_MAKE_OPAQUE(std::vector<float>)
PYBIND11_MAKE_OPAQUE(std::vector<double>)

void init_component_list(py::module& m) {
  py::class_<radler::ComponentList>(m, "ComponentList", R"pbdoc(
           Construct a new empty ComponentList. This object has not been
           made available to python fully, this constructor is mainly for
           testing.
           )pbdoc")
      .def(py::init<>(), "Default constructor")
      .def(py::init<size_t, size_t, size_t, size_t>(), R"pbdoc(
           Constructor for multi-scale clean
           )pbdoc")
      .def_property("n_scales", &radler::ComponentList::NScales,
                    &radler::ComponentList::SetNScales)
      .def_property_readonly("n_frequencies",
                             &radler::ComponentList::NFrequencies)
      .def("clear", &radler::ComponentList::Clear)
      .def_property_readonly("width", &radler::ComponentList::Width)
      .def_property_readonly("height", &radler::ComponentList::Height)
      .def("component_count",
           [](const radler::ComponentList& self, size_t scale_index) {
             if (scale_index >= self.NScales()) {
               throw std::out_of_range(
                   "Scale index out of range in component count");
             }
             return self.ComponentCount(scale_index);
           })
      .def("write_sources", &radler::ComponentList::WriteSources,
           py::arg("radler"), py::arg("filename"), py::arg("pixel_scale_x"),
           py::arg("pixel_scale_y"), py::arg("phase_centre_ra"),
           py::arg("phase_centre_dec"), py::arg("l_shift") = 0.0,
           py::arg("m_shift") = 0.0,
           R"pbdoc(
           Write the sources in the component list to a file.

           Parameters
           ----------
           radler: Radler
               Radler object that created this component list
           filename: str
               File name to be written to, will be overwritten if existing
           pixel_scale_x: float
               Pixel scale x in arcseconds
           pixel_scale_y: float
               Pixel scale y in arcseconds
           phase_centre_ra: float
               Right ascension of phase centre in radians
           phase_centre_dec: float
               Declination of phase centre in radians
           l_shift: float
               l-shift of center (between -1 and 1, default 0)
           m_shift: float
               m-shift of center (between -1 and 1, default 0)
           )pbdoc");
}