diff --git a/Modules/Core/Functor/include/otbFunctorImageFilter.h b/Modules/Core/Functor/include/otbFunctorImageFilter.h index 2b2be20a409b48faa10abc171fd5cba41df59e08..24dfd5569fafd7bc4ae831938faa94e9718061a2 100644 --- a/Modules/Core/Functor/include/otbFunctorImageFilter.h +++ b/Modules/Core/Functor/include/otbFunctorImageFilter.h @@ -267,21 +267,24 @@ public: /** Run-time type information (and related methods). */ itkTypeMacro(FunctorImageFilter, ImageToImageFilter); - - /** Get the functor object. The functor is returned by reference. - * (Functors do not have to derive from itk::LightObject, so they do - * not necessarily have a reference count. So we cannot return a - * SmartPointer.) */ - FunctorType& GetFunctor() + /** Get the functor object. + * + * \return A non-const reference to the Functor in use. Note that + * this call will call the Modified() function of the filter, which + * will trigger a full output computation upon Update(). For + * inspection only, prefer using GetFunctor() + */ + FunctorType& GetModifiableFunctor() { this->Modified(); return m_Functor; } - /** Get the functor object. The functor is returned by reference. - * (Functors do not have to derive from itk::LightObject, so they do - * not necessarily have a reference count. So we cannot return a - * SmartPointer.) */ + /** Get the functor object. + * + * \return A const reference to the Functor in use. For a + * modifiable version of the functor, see GetModifiableFunctor(). + */ const FunctorType& GetFunctor() const { return m_Functor;