Skip to content

[Chore] Minor documentation / style fixes #179

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

Open
daniellegillai wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

[Chore] Minor documentation / style fixes #179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6b0537c
Fix dst docstring for gamma contrast and convert to
daniellegillai May 29, 2026
756785c
fixed GoldenConvertTo documentation to have correct tparams
daniellegillai Jun 2, 2026
30e2f2d
Fixed param documentation in bilateral filter cpp test
daniellegillai Jun 16, 2026
f05fd17
Merge branch 'develop' into doc-cleanup
daniellegillai Jul 14, 2026
3fa5742
Merge branch 'develop' into doc-cleanup
daniellegillai Jul 14, 2026
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
2 changes: 1 addition & 1 deletion python/src/operators/py_op_convert_to.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ void PyOpConvertTo::Export(py::module& m) {
Refer to the rocCV C++ API reference for more information on this operation.

Args:
dst (rocpycv.Tensor): The output tensor with gamma correction applied.
dst (rocpycv.Tensor): Output tensor which image results are written to.
src (rocpycv.Tensor): Input tensor containing one or more images.
alpha (double, optional): Scalar for output data. Defaults to 1.0.
beta (double, optional): Offset for the data. Defaults to 0.0.
Expand Down
2 changes: 1 addition & 1 deletion python/src/operators/py_op_gamma_contrast.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ void PyOpGammaContrast::Export(py::module& m) {
Refer to the rocCV C++ API reference for more information on this operation.

Args:
dst (rocpycv.Tensor): The output tensor with gamma correction applied.
dst (rocpycv.Tensor): Output tensor which image results are written to.
src (rocpycv.Tensor): Input tensor containing one or more images.
gamma (float): Gamma correction value to apply to the images.
stream (rocpycv.Stream, optional): HIP stream to run this operation on.
Expand Down
8 changes: 5 additions & 3 deletions tests/roccv/cpp/src/tests/operators/test_op_bilateral_filter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,20 @@ namespace {
* @brief Verified golden C++ model for the bilateral filtering operation on one image.
*
* @tparam T Vectorized datatype of the image's pixels.
* @tparam BorderMode Border pixel extrapolation method
* @tparam BT Base type of the image data.
* @param[in] input Input tensor containing image data.
* @param[out] output Output tensor containing normalized image data.
* @param[in] diameter Diameter of the work region
* @param[in] sigmaColor Sigma component of Gaussian exponent for color difference
* @param[in] sigmaSpace Sigma component of Gaussian exponent for pixel spatial distance
* @param[in] borderMode Border pixel extrapolation method
* @param[in] borderValue Color for constant border mode
* @return None.
*/
template <typename T, eBorderType borderMode, typename BT = detail::BaseType<T>>
template <typename T, eBorderType BorderMode, typename BT = detail::BaseType<T>>
void GenerateGoldenBilateral(std::vector<BT>& input, std::vector<BT>& output, int32_t batchSize, Size2D imageSize,
int diameter, float sigmaColor, float sigmaSpace, T borderValue) {
BorderWrapper<T, borderMode> src(ImageWrapper<T>(input, batchSize, imageSize.w, imageSize.h), borderValue);
BorderWrapper<T, BorderMode> src(ImageWrapper<T>(input, batchSize, imageSize.w, imageSize.h), borderValue);
ImageWrapper<T> dst(output, batchSize, imageSize.w, imageSize.h);
using namespace roccv::detail;
using Worktype = MakeType<float, NumElements<T>>;
Expand Down Expand Up @@ -112,6 +113,7 @@ void GenerateGoldenBilateral(std::vector<BT>& input, std::vector<BT>& output, in
* @brief Tests correctness of the bilateral filter operator, comparing it against a generated golden result.
*
* @tparam T Underlying datatype of the image's pixels.
* @tparam BorderMode Border pixel extrapolation method
* @tparam BT Base type of the image data.
* @param[in] batchSize Number of images in the batch.
* @param[in] width Width of each image in the batch.
Expand Down
6 changes: 4 additions & 2 deletions tests/roccv/cpp/src/tests/operators/test_op_convert_to.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,10 @@ namespace {
/**
* @brief Verified golden C++ model for the ConvertTo operation.
*
* @tparam T Vectorized datatype of the image's pixels.
* @tparam BT Base type of the image's data.
* @tparam SRC_DT Vectorized datatype of the input image's pixels.
* @tparam DEST_DT Vectorized datatype of the output image's pixels.
* @tparam BT_SRC Base type of the input image's data.
* @tparam BT_DEST Base type of the output image's data.
* @param[in] input An input vector containing image data.
* @param[in] batchSize The number of images in the batch.
* @param[in] width Image width.
Expand Down