Commit 66f4fe62 authored by Simon Perkins's avatar Simon Perkins

docstrings

parent cab2176b
......@@ -683,10 +683,10 @@ template<typename T> pyarr_c<complex<T>> vis2grid_c(
template<typename T> pyarr_c<T> vis2grid(const Baselines<T> &baselines,
const GridderConfig<T> &gconf, const pyarr_c<uint32_t> &idx_,
const pyarr_c<complex<T>> &vis_)
const pyarr_c<complex<T>> &vis_, py::object user_grid)
{
return complex2hartley(vis2grid_c(baselines, gconf,
idx_, vis_, py::none()));
idx_, vis_, user_grid));
}
template<typename T> pyarr_c<complex<T>> ms2grid_c(
......@@ -1038,6 +1038,9 @@ idx: np.array((nvis,), dtype=np.uint32)
the indices for the entries to be gridded
vis: np.array((nvis,), dtype=np.complex)
The visibility data for the index array
user_grid: np.array((nv, nu), dtype=np.complex128), optional
User supplied grid which will be used instead of internally
allocating an array. Defaults to None
Returns
=======
......@@ -1122,14 +1125,14 @@ PYBIND11_MODULE(nifty_gridder, m)
"gconf"_a, "flags"_a, "chbegin"_a=-1, "chend"_a=-1,
"wmin"_a=-1e30, "wmax"_a=1e30);
m.def("vis2grid",&vis2grid<double>, vis2grid_DS, "baselines"_a, "gconf"_a,
"idx"_a, "vis"_a);
"idx"_a, "vis"_a, "user_grid"_a);
m.def("ms2grid",&ms2grid<double>, "baselines"_a, "gconf"_a, "idx"_a, "ms"_a);
m.def("grid2vis",&grid2vis<double>, grid2vis_DS, "baselines"_a, "gconf"_a,
"idx"_a, "grid"_a);
m.def("grid2ms",&grid2ms<double>, "baselines"_a, "gconf"_a, "idx"_a,
"grid"_a, "ms_in"_a=py::none());
m.def("vis2grid_c",&vis2grid_c<double>, "baselines"_a, "gconf"_a, "idx"_a,
"vis"_a, "user_grid"_a.none(true));
"vis"_a, "user_grid"_a);
m.def("ms2grid_c",&ms2grid_c<double>, "baselines"_a, "gconf"_a, "idx"_a,
"ms"_a);
m.def("grid2vis_c",&grid2vis_c<double>, "baselines"_a, "gconf"_a, "idx"_a,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment