Commit 59119185 authored by Martin Reinecke's avatar Martin Reinecke
Browse files

add docstring

parent f122e045
......@@ -526,6 +526,24 @@ np.array((nxdirty, nydirty), dtype=np.float64)
the image with the taper applied
)""";
constexpr auto apply_wscreen_DS = R"""(
Applies the w screen to an image
Parameters
==========
dirty: nd.array((nxdirty, nydirty), dtype=np.complex128)
the image
w : float
the w value to use
adjoint: bool
if True, apply the complex conjugate of the w screen
Returns
=======
np.array((nxdirty, nydirty), dtype=np.complex128)
the image with the w screen applied
)""";
constexpr auto GridderConfig_DS = R"""(
Class storing information related to the gridding/degridding process.
......@@ -1530,7 +1548,8 @@ PYBIND11_MODULE(nifty_gridder, m)
.def("dirty2grid", &GridderConfig<double>::dirty2grid,
dirty2grid_DS, "dirty"_a)
.def("dirty2grid_c", &GridderConfig<double>::dirty2grid_c, "dirty"_a)
.def("apply_wscreen", &GridderConfig<double>::apply_wscreen, "dirty"_a, "w"_a, "adjoint"_a)
.def("apply_wscreen", &GridderConfig<double>::apply_wscreen,
apply_wscreen_DS, "dirty"_a, "w"_a, "adjoint"_a)
// pickle support
.def(py::pickle(
......
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