"imread" method documentation a bit confusing (Bug #2406)
| Status: | Done | Start date: | 2012-10-02 |
|---|---|---|---|
| Priority: | Low | Due date: | |
| Assignee: |  Kirill Kornyakov |
% Done: | 90% |
| Category: | documentation | ||
| Target version: | 2.4.3 | ||
| Affected version: | Operating System: | ||
| Difficulty: | HW Platform: | ||
| Pull request: |
Description
When searching for info about how to use function "imread" I felt a bit confused after reading description of "flags" parameter. More precisely, the third case (when flags < 0) confuses me, especially the phrase "if flags >= 0" at the end of a sentence. From my point of view, the third case should look like this: "< 0: Return the loaded image as is. Note that in the current implementation the alpha channel, if any, is stripped from the output image. For example, a 4-channel RGBA image is loaded as RGB."
Note: I used current version of documentation from docs.opencv.org.
Associated revisions
Removed the phrase, that was causing all the confusion. Issue #2406.
+ Some minor formatting fixes.
made imread description slightly better #2406
Merge pull request #2406 from ilya-lavrenov:abf
History
Updated by Vadim Pisarevsky over 12 years ago
- Target version deleted ()
- Assignee deleted (
Vsevolod Glumov)
Updated by dongsun shin over 12 years ago
I read your problem. But I think that 'for example...' is an example of all cases ( >0, ==0, <0 )
Best regards,
dsshin. ( [email protected] )
Alexey Fedotov wrote:
When searching for info about how to use function "imread" I felt a bit confused after reading description of "flags" parameter. More precisely, the third case (when flags < 0) confuses me, especially the phrase "if flags >= 0" at the end of a sentence. From my point of view, the third case should look like this: "< 0: Return the loaded image as is. Note that in the current implementation the alpha channel, if any, is stripped from the output image. For example, a 4-channel RGBA image is loaded as RGB."
Note: I used current version of documentation from docs.opencv.org.
Updated by Vsevolod Glumov over 12 years ago
- % Done changed from 0 to 50
- Assignee set to Vsevolod Glumov
Updated by Vsevolod Glumov over 12 years ago
Removed the confusing phrase altogether. It was the wrong place to give general usage examples anyway. May, however, require approval.
- % Done changed from 50 to 90
- Assignee changed from Vsevolod Glumov to Kirill Kornyakov
Updated by Kirill Kornyakov over 12 years ago
- Status changed from Open to Done
Updated by Andrey Kamaev about 12 years ago
- Target version set to 2.4.3