imagebuf docs examples: c++ examples, outfile, run script, and doc (#3992) #4020
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,13 @@ | ||
| findaverages.exr : 640 x 480, 3 channel, float openexr | ||
| SHA-1: E8D3C267CBC4BBDE41343DCA008773A3E55B8159 | ||
| set-region-black.exr : 640 x 480, 3 channel, float openexr | ||
| SHA-1: 7006ED82385E7BCD1FB338B9D3DBFF754541E980 | ||
| set-region-black-template-dispatch.exr : 640 x 480, 3 channel, half openexr | ||
| SHA-1: FEB8B385D8784C4A16F3164D9B1A0F9113D64C86 | ||
| set-region-black-template-float.exr : 640 x 480, 3 channel, float openexr | ||
| SHA-1: 7006ED82385E7BCD1FB338B9D3DBFF754541E980 | ||
| set-region-black-template-uint8.exr : 640 x 480, 3 channel, half openexr | ||
| SHA-1: 9E09138C84FC4FDA52A6D76AED751B6551BB3417 | ||
| error: Uninitialized input image | ||
| error: Uninitialized input image | ||
| zero1.exr : 512 x 512, 3 channel, float openexr | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,6 +26,12 @@ | |
| # hashes merely check that the images don't change, but saves us the space | ||
| # of checking in a full copy of the image if it's not needed. | ||
| hashes = [ | ||
| # Outputs from the ImageBuf chapter: | ||
| "findaverages.exr", | ||
| "set-region-black.exr", | ||
| "set-region-black-template-dispatch.exr", | ||
| "set-region-black-template-float.exr", | ||
| "set-region-black-template-uint8.exr", | ||
| # Outputs from the ImageBufAlgo chapter: | ||
| "zero1.exr", | ||
| "zero2.exr", | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,12 +30,215 @@ void example1() | |
| // | ||
| /////////////////////////////////////////////////////////////////////////// | ||
|
|
||
| #include <OpenImageIO/imagebuf.h> | ||
|
|
||
| // BEGIN-imagebuf-get-pixel-avg | ||
| void print_channel_averages(const std::string& filename) | ||
| { | ||
| // Set up the ImageBuf and read the file | ||
| ImageBuf buf(filename); | ||
| bool ok = buf.read(0, 0, true, TypeDesc::FLOAT); // Force a float buffer | ||
| if (!ok) | ||
| return; | ||
|
|
||
| // Initialize a vector to contain the running total | ||
| int nc = buf.nchannels(); | ||
| std::vector<float> total(nc, 0.0f); | ||
|
|
||
| // Iterate over all pixels of the image, summing channels separately | ||
| for (ImageBuf::ConstIterator<float> it(buf); !it.done(); ++it) | ||
| for (int c = 0; c < nc; ++c) | ||
| total[c] += it[c]; | ||
|
|
||
| // Print the averages | ||
| imagesize_t npixels = buf.spec().image_pixels(); | ||
| for (int c = 0; c < nc; ++c) | ||
| std::cout << "Channel " << c << " avg = " << (total[c] / npixels) | ||
| << "\n"; | ||
| } | ||
|
|
||
| // END-imagebuf-get-pixel-avg | ||
|
|
||
| void print_channel_averages_example() | ||
| { | ||
| const std::string filename = "findaverages.exr"; | ||
| int x_sz = 640; | ||
| int y_sz = 480; | ||
| ImageBuf A(ImageSpec(x_sz, y_sz, 3, TypeDesc::FLOAT)); | ||
| for (int i = 0; i < x_sz; ++i) | ||
| for (int j = 0; j < y_sz; ++j) { | ||
| // Create a square RGB gradient so determining an average is interesting | ||
| A.setpixel(i, j, 0, | ||
| cspan<float>( | ||
| { powf(float(i) / (x_sz - 1), 2.0f), | ||
| powf(float(j) / (y_sz - 1), 2.0f), | ||
| powf(float(i * j) / (x_sz * y_sz - 1), 2.0f) })); | ||
| } | ||
| if (!A.write(filename)) { | ||
| std::cout << "error: " << A.geterror() << "\n"; | ||
| } else { | ||
| print_channel_averages(filename); | ||
| } | ||
| } | ||
|
|
||
| // BEGIN-imagebuf-set-region-black | ||
| bool make_black(ImageBuf& buf, ROI region) | ||
| { | ||
| if (buf.spec().format != TypeDesc::FLOAT) | ||
| return false; // Assume it's a float buffer | ||
|
|
||
| // Clamp the region's channel range to the channels in the image | ||
| region.chend = std::min(region.chend, buf.nchannels()); | ||
| // Iterate over all pixels in the region... | ||
| for (ImageBuf::Iterator<float> it(buf, region); !it.done(); ++it) { | ||
| if (!it.exists()) // Make sure the iterator is pointing | ||
| continue; // to a pixel in the data window | ||
| for (int c = region.chbegin; c < region.chend; ++c) | ||
| it[c] = 0.0f; // clear the value | ||
| } | ||
| return true; | ||
| } | ||
| // END-imagebuf-set-region-black | ||
|
|
||
| void make_black_example() | ||
| { | ||
| int x_sz = 640; | ||
| int y_sz = 480; | ||
| ImageBuf A(ImageSpec(x_sz, y_sz, 3, TypeDesc::FLOAT)); | ||
| for (int i = 0; i < x_sz; ++i) | ||
| for (int j = 0; j < y_sz; ++j) { | ||
| // Create RGB gradient so region changing is easy to see | ||
| A.setpixel(i, j, 0, | ||
| cspan<float>({ float(i) / (x_sz - 1), | ||
| float(j) / (y_sz - 1), | ||
| float(i * j) / (x_sz * y_sz - 1) })); | ||
| } | ||
| // A rectangular region straddling the middle of the image above | ||
| ROI region(x_sz / 4, x_sz * 3 / 4, y_sz / 4, y_sz * 3 / 4, 0, 1, 0, 3); | ||
| if (make_black(A, region)) { | ||
| A.write("set-region-black.exr"); | ||
| } else { | ||
| std::cout << "error: buffer is not a float buffer\n"; | ||
| } | ||
| } | ||
|
|
||
|
|
||
|
|
||
| // BEGIN-imagebuf-iterator-template | ||
| #include <OpenImageIO/half.h> | ||
| template<typename BUFT> | ||
| static bool make_black_impl(ImageBuf& buf, ROI region) | ||
| { | ||
| // Clamp the region's channel range to the channels in the image | ||
| region.chend = std::min(region.chend, buf.nchannels()); | ||
|
|
||
| // Iterate over all pixels in the region... | ||
| for (ImageBuf::Iterator<BUFT> it(buf, region); !it.done(); ++it) { | ||
| if (!it.exists()) // Make sure the iterator is pointing | ||
| continue; // to a pixel in the data window | ||
| for (int c = region.chbegin; c < region.chend; ++c) | ||
| it[c] = 0.0f; // clear the value | ||
| } | ||
| return true; | ||
| } | ||
|
|
||
| bool make_black_templated(ImageBuf& buf, ROI region) | ||
| { | ||
| if (buf.spec().format == TypeDesc::FLOAT) | ||
| return make_black_impl<float>(buf, region); | ||
| else if (buf.spec().format == TypeDesc::HALF) | ||
| return make_black_impl<half>(buf, region); | ||
| else if (buf.spec().format == TypeDesc::UINT8) | ||
| return make_black_impl<unsigned char>(buf, region); | ||
| else if (buf.spec().format == TypeDesc::UINT16) | ||
| return make_black_impl<unsigned short>(buf, region); | ||
| else { | ||
| buf.errorf("Unsupported pixel data format %s", | ||
| buf.spec().format.c_str()); | ||
| return false; | ||
| } | ||
| } | ||
| // END-imagebuf-iterator-template | ||
|
|
||
| void make_black_template_example() | ||
| { | ||
| int x_sz = 640; | ||
| int y_sz = 480; | ||
| ImageBuf A(ImageSpec(x_sz, y_sz, 3, TypeDesc::FLOAT)); | ||
| for (int i = 0; i < x_sz; ++i) | ||
| for (int j = 0; j < y_sz; ++j) { | ||
| // Create RGB gradient so region changing is easy to see | ||
| A.setpixel(i, j, 0, | ||
| cspan<float>({ float(i) / (x_sz - 1), | ||
| float(j) / (y_sz - 1), | ||
| float(i * j) / (x_sz * y_sz - 1) })); | ||
| } | ||
| // A rectangular region straddling the middle of the image above | ||
| ROI region(x_sz / 4, x_sz * 3 / 4, y_sz / 4, y_sz * 3 / 4, 0, 1, 0, 3); | ||
| if (make_black_templated(A, region)) { | ||
| A.write("set-region-black-template-float.exr"); | ||
| } else { | ||
| std::cout << "error: " << A.geterror() << "\n"; | ||
| } | ||
|
|
||
| ImageBuf B(ImageSpec(x_sz, y_sz, 3, TypeDesc::UINT8)); | ||
| for (int i = 0; i < x_sz; ++i) | ||
| for (int j = 0; j < y_sz; ++j) { | ||
| // Create RGB gradient so region changing is easy to see | ||
| B.setpixel(i, j, 0, | ||
| cspan<float>({ float(i) / (x_sz - 1), | ||
| float(j) / (y_sz - 1), | ||
| float(i * j) / (x_sz * y_sz - 1) })); | ||
| } | ||
| // A rectangular region straddling the middle of the image above | ||
| if (make_black_templated(B, region)) { | ||
| B.write("set-region-black-template-uint8.exr"); | ||
| } else { | ||
| std::cout << "error: " << B.geterror() << "\n"; | ||
| } | ||
| } | ||
|
|
||
| // BEGIN-imagebuf-dispatch | ||
| #include <OpenImageIO/imagebufalgo_util.h> | ||
| bool make_black_dispatch(ImageBuf& buf, ROI region) | ||
| { | ||
| bool ok; | ||
| OIIO_DISPATCH_COMMON_TYPES(ok, "make_black_dispatch", make_black_impl, | ||
| buf.spec().format, buf, region); | ||
| return ok; | ||
| } | ||
| // END-imagebuf-dispatch | ||
|
|
||
| void make_black_dispatch_example() | ||
| { | ||
| int x_sz = 640; | ||
| int y_sz = 480; | ||
| ImageBuf A(ImageSpec(x_sz, y_sz, 3, TypeDesc::UINT16)); | ||
| for (int i = 0; i < x_sz; ++i) | ||
| for (int j = 0; j < y_sz; ++j) { | ||
| // Create RGB gradient so region changing is easy to see | ||
| A.setpixel(i, j, 0, | ||
| cspan<float>({ float(i) / (x_sz - 1), | ||
| float(j) / (y_sz - 1), | ||
| float(i * j) / (x_sz * y_sz - 1) })); | ||
| } | ||
| // A rectangular region straddling the middle of the image above | ||
| ROI region(x_sz / 4, x_sz * 3 / 4, y_sz / 4, y_sz * 3 / 4, 0, 1, 0, 3); | ||
| if (make_black_templated(A, region)) { | ||
| A.write("set-region-black-template-dispatch.exr"); | ||
| } else { | ||
| std::cout << "error: " << A.geterror() << "\n"; | ||
| } | ||
| } | ||
|
|
||
| int main(int /*argc*/, char** /*argv*/) | ||
| { | ||
| // Each example function needs to get called here, or it won't execute | ||
| // as part of the test. | ||
| // example1(); | ||
| print_channel_averages_example(); | ||
| make_black_example(); | ||
| make_black_template_example(); | ||
| make_black_dispatch_example(); | ||
| return 0; | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the C++ code, you called this BEGIN/END-imagebuf-get-pixel-avg