Skip to content
Snippets Groups Projects
Commit beed2be4 authored by Julien Michel's avatar Julien Michel
Browse files

ENH: Enhancing filter documentation

parent 866ab554
No related branches found
No related tags found
No related merge requests found
...@@ -26,10 +26,19 @@ namespace otb { ...@@ -26,10 +26,19 @@ namespace otb {
namespace Statistics { namespace Statistics {
/** \class ShiftScaleSampleListFilter /** \class ShiftScaleSampleListFilter
* \brief This class generate a centered and reduced sample list from and input sample list. * \brief This class generate a shifted and scaled version of the input sample list
*
* For each component of the sample, the following formula is applied :
*
* \f[ output = \frac{input - shift}{scale} \f]
*
* Standard casting is applied between input and output type.
* *
* Shifts and scales can be set via the SetShift() and SetScales() methods. * Shifts and scales can be set via the SetShift() and SetScales() methods.
* *
* This filter provide pipeline support for itk::Statistics::ListSample via itk::DataObjectDecorator for
* both the input and the output sample list.
*
* \sa ImageToListAdaptor * \sa ImageToListAdaptor
*/ */
template < class TInputSampleList, class TOutputSampleList = TInputSampleList > template < class TInputSampleList, class TOutputSampleList = TInputSampleList >
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment