Skip to content

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

New issue
New issue
Open
#2248
Open
Documentation for ImageReaderBase::Execute is the same as ImageReaderBase::SetOutputPixelType#2225
#2248
@function2-llx

Description

@function2-llx
function2-llx
opened on Dec 30, 2024

Found this issue in the v2.4.0 doc, as well as the latest doc (archive).

The same issue also exists for all derived classes such as ImageFileReader.

This issue may due to the lack of documentation for the ImageReaderBase::Execute method in the code:

SimpleITK/Code/IO/include/sitkImageReaderBase.h

Lines 52 to 67 in 9a29ed9

/** \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;

Activity

blowekamp
linked a pull request that will close this issue on Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions
      Documentation for `ImageReaderBase::Execute` is the same as `ImageReaderBase::SetOutputPixelType` · Issue #2225 · SimpleITK/SimpleITK