Documentation for `ImageReaderBase::Execute` is the same as `ImageReaderBase::SetOutputPixelType`

Found this issue in the [v2.4.0 doc](https://simpleitk.org/doxygen/v2_4/html/classitk_1_1simple_1_1ImageReaderBase.html#a01ce8e9187cada5b600a1464ddaad47f), as well as [the latest doc](https://simpleitk.org/doxygen/latest/html/classitk_1_1simple_1_1ImageReaderBase.html#a01ce8e9187cada5b600a1464ddaad47f) ([archive](https://web.archive.org/web/20241230140830/https://simpleitk.org/doxygen/latest/html/classitk_1_1simple_1_1ImageReaderBase.html#a01ce8e9187cada5b600a1464ddaad47f)).

The same issue also exists for all derived classes such as [ImageFileReader](https://simpleitk.org/doxygen/v2_4/html/classitk_1_1simple_1_1ImageSeriesReader.html#a8274da0a6f4a04b5b504b9e6b377e706).

This issue may due to the lack of documentation for the `ImageReaderBase::Execute` method in the code:

https://github.com/SimpleITK/SimpleITK/blob/9a29ed954f1e6dab603397cfb35b553d6e7494e9/Code/IO/include/sitkImageReaderBase.h#L52-L67

	/** \brief Set/Get The output PixelType of the image.
	*
	* By default the value is sitkUnknown, which enable the output
	* pixel type to be same as the file. If the pixel type is
	* specified then the itk::ConvertPixelBuffer will be used to
	* convert the pixels.
	* @{
	*/
	SITK_RETURN_SELF_TYPE_HEADER
	SetOutputPixelType(PixelIDValueEnum pixelID);
	PixelIDValueEnum
	GetOutputPixelType() const;
	/* @} */

	virtual Image
	Execute() = 0;

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Documentation for `ImageReaderBase::Execute` is the same as `ImageReaderBase::SetOutputPixelType` #2225

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Documentation for ImageReaderBase::Execute is the same as ImageReaderBase::SetOutputPixelType #2225

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions

Documentation for `ImageReaderBase::Execute` is the same as `ImageReaderBase::SetOutputPixelType` #2225