Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 9, 2018
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions visualdl/logic/pybind.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down