未验证 提交 747329e0 编写于 作者: N Nicky Chan 提交者: GitHub

Fix image APIs docs to explain what image shape params are (#377)

上级 2e43421e
......@@ -197,19 +197,21 @@ PYBIND11_MODULE(core, m) {
End a sampling period, it will clear all states for reservoir sampling.
)pbdoc")
.def("set_sample", &cp::Image::SetSample, R"pbdoc(
Store the image shape with the flatten image data.
Store the flatten image data as vector of float types. Image params need to be
specified as a tuple of 3 integers for [width, height, number of channels(3 for RGB)]
:param index:
:type index: integer
:param image_shape: Image size
:param image_shape: [width, height, number of channels(3 for RGB)]
:type image_shape: tuple
:param image_data: Flatten image data
:type image_data: list
)pbdoc")
.def("add_sample", &cp::Image::AddSample, R"pbdoc(
A combined interface for is_sample_taken and set_sample, simpler but is less efficient.
Image shape params details see set_sample
:param image_shape: Image size
:param image_shape: [width, height, number of channels(3 for RGB)]
:type image_shape: tuple
:param image_data: Flatten image data
:type image_data: list
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册