DGtal-team / DGtal

Digital Geometry Tools and Algorithm Library
https://dgtal.org
GNU Lesser General Public License v3.0
370 stars 115 forks source link

Documentation issue in RawReader #1640

Open dcoeurjo opened 2 years ago

dcoeurjo commented 2 years ago

Checking https://dgtal-team.github.io/doc-nightly/structDGtal_1_1RawReader.html, the code snippet is incorrect as you have to add the domain extent as parameter to the importRaw

dcoeurjo commented 2 years ago

Additionally, how does this work for the GenericReader?

kerautret commented 2 years ago

Checking https://dgtal-team.github.io/doc-nightly/structDGtal_1_1RawReader.html, the code snippet is incorrect as you have to add the domain extent as parameter to the importRaw

Agree the doc is wrong the dim is missing in the example. For GenericReader, from the test is see you can specify the domain: DGtal::GenericReader::import(filenameImage5, 5, 5)

kerautret commented 2 years ago

I will correct the doc and perhaps check genericReader to avoid call without dim like the doc example.

dcoeurjo commented 2 years ago

yeah that would be great