eLynx::Image::ImageOperatorsImpl< Pixel > Class Template Reference

#include <ImageOperatorsImpl.h>

Inheritance diagram for eLynx::Image::ImageOperatorsImpl< Pixel >:

List of all members.

Public Types
typedef Pixel	Pixel_t
Public Member Functions
Generic virtual services
virtual bool	Operator (AbstractImage &ioImage, EImageOperator iOperator, double iValue, uint32 iChannelMask=CM_All, ProgressNotifier &iNotifier=ProgressNotifier_NULL) const
virtual bool	Operator (AbstractImage &ioImage, EImageOperator iOperator, const AbstractImage &iImage, uint32 iChannelMask=CM_All, ProgressNotifier &iNotifier=ProgressNotifier_NULL) const
virtual bool	Operator (AbstractImage &ioImage, EImageOperator iOperator, const AbstractImage &iImage, const ImageLub &iImageMask, uint32 iChannelMask=CM_All, ProgressNotifier &iNotifier=ProgressNotifier_NULL) const
virtual bool	Operator (AbstractImage &ioImage, EImageOperator iOperator, const std::vector< const AbstractImage * > &iImageList, uint32 iChannelMask=CM_All, ProgressNotifier &iNotifier=ProgressNotifier_NULL) const
virtual boost::shared_ptr < AbstractImage >	CreateImage (EImageListOperator iOperator, const std::vector< const AbstractImage * > &iImageList, uint32 iChannelMask, ProgressNotifier &iNotifier) const
	Image factory.
virtual boost::shared_ptr < AbstractImage >	CreateClipped (EImageListOperator iOperator, const std::vector< const AbstractImage * > &iImageList, uint32 iIteration, double iKappa, uint32 iChannelMask, ProgressNotifier &iNotifier) const
virtual boost::shared_ptr < AbstractImage >	CreateWeightedEntropy (const std::vector< const AbstractImage * > &iImageList, uint32 iW, uint32 iH, uint32 iChannelMask, ProgressNotifier &iNotifier) const
Static Public Member Functions
Specialized static services
static bool	Operator (ImageImpl< Pixel > &ioImage, EImageOperator iOperator, const ImageImpl< Pixel > &iImage, uint32 iChannelMask=CM_All, ProgressNotifier &iNotifier=ProgressNotifier_NULL)
static bool	OperatorMedian (AbstractImage &oImage, const std::vector< const AbstractImage * > &iImageList, uint32 iChannelMask=CM_All, ProgressNotifier &iNotifier=ProgressNotifier_NULL)
static bool	OperatorMean (AbstractImage &oImage, const std::vector< const AbstractImage * > &iImageList, uint32 iChannelMask=CM_All, ProgressNotifier &iNotifier=ProgressNotifier_NULL)

---

Detailed Description

template<class Pixel>
class eLynx::Image::ImageOperatorsImpl< Pixel >

Implementation of image operators interface.

Definition at line 32 of file ImageOperatorsImpl.h.

---

Member Typedef Documentation

template<class Pixel >

typedef Pixel eLynx::Image::ImageOperatorsImpl< Pixel >::Pixel_t

Definition at line 35 of file ImageOperatorsImpl.h.

---

Member Function Documentation

template<class Pixel >

virtual bool eLynx::Image::ImageOperatorsImpl< Pixel >::Operator	(	AbstractImage &	ioImage,
		EImageOperator	iOperator,
		double	iValue,
		uint32	iChannelMask = CM_All,
		ProgressNotifier &	iNotifier = ProgressNotifier_NULL
	)			const [virtual]

Apply operator with const value.

Parameters:

	ioImage	image to process.
	iOperator	Operator to apply.
	iValue	double value as argument of operator.
	iChannelMask	selected channels to be processed. Default is all.
	iNotifier	a notifier for progression, log and cancel.

Returns:

Method running status.

Implements eLynx::Image::IImageOperators.

template<class Pixel >

virtual bool eLynx::Image::ImageOperatorsImpl< Pixel >::Operator	(	AbstractImage &	ioImage,
		EImageOperator	iOperator,
		const AbstractImage &	iImage,
		uint32	iChannelMask = CM_All,
		ProgressNotifier &	iNotifier = ProgressNotifier_NULL
	)			const [virtual]

Apply operator with another image, ioImage = ioImage (operator) iImage ioImage and iImage must have the same format and size.

Parameters:

	ioImage	image to process.
	iOperator	Operator to apply.
	iImage	2nd image as operator argument.
	iChannelMask	selected channels to be processed. Default is all.
	iNotifier	a notifier for progression, log and cancel.

Returns:

Method running status.

Implements eLynx::Image::IImageOperators.

template<class Pixel >

virtual bool eLynx::Image::ImageOperatorsImpl< Pixel >::Operator	(	AbstractImage &	ioImage,
		EImageOperator	iOperator,
		const AbstractImage &	iImage,
		const ImageLub &	iImageMask,
		uint32	iChannelMask = CM_All,
		ProgressNotifier &	iNotifier = ProgressNotifier_NULL
	)			const [virtual]

Apply operator with another image, ioImage = ioImage (operator) iImage ioImage and iImage must have the same format and size.

Parameters:

	ioImage	image to process.
	iOperator	Operator to apply.
	iImage	2nd image as operator argument.
	iImageMask	image mask, operator is not applied where value is 0.
	iChannelMask	selected channels to be processed. Default is all.
	iNotifier	a notifier for progression, log and cancel.

Returns:

Method running status.

Implements eLynx::Image::IImageOperators.

template<class Pixel >

virtual bool eLynx::Image::ImageOperatorsImpl< Pixel >::Operator	(	AbstractImage &	ioImage,
		EImageOperator	iOperator,
		const std::vector< const AbstractImage * > &	iImageList,
		uint32	iChannelMask = CM_All,
		ProgressNotifier &	iNotifier = ProgressNotifier_NULL
	)			const [virtual]

Apply operator on image list, oImage = operator iImageList. All images including the output one must have the same format and size.

Parameters:

	ioImage	image to process.
	iOperator	Operator to apply.
	iImageList	collection of the input images to compute the average.
	iChannelMask	selected channels to be processed. Default is all.
	iNotifier	a notifier for progression, log and cancel.

Returns:

Method running status.

Implements eLynx::Image::IImageOperators.

template<class Pixel >

virtual boost::shared_ptr< AbstractImage > eLynx::Image::ImageOperatorsImpl< Pixel >::CreateImage	(	EImageListOperator	iOperator,
		const std::vector< const AbstractImage * > &	iImageList,
		uint32	iChannelMask,
		ProgressNotifier &	iNotifier
	)			const [virtual]

Image factory.

Implements eLynx::Image::IImageOperators.

template<class Pixel >

virtual boost::shared_ptr< AbstractImage > eLynx::Image::ImageOperatorsImpl< Pixel >::CreateClipped	(	EImageListOperator	iOperator,
		const std::vector< const AbstractImage * > &	iImageList,
		uint32	iIteration,
		double	iKappa,
		uint32	iChannelMask,
		ProgressNotifier &	iNotifier
	)			const [virtual]

Creates an image from the list of images by using one of the following methods:

• Kappa-sigma clipping where first extreme values are rejected iteratively then the remaining values are averaged,
• Median Kappa-sigma clipping is the same as the first one but instead of averaging remaining values, the median of the remaining values is used,
• Auto Adaptive weighted average where extreme values are not rejected but instead assigned a very low weight. So all the values are kept but the weight of each value depends on how far the value is from the mean.

  Parameters:

  	iOperator	Method to apply.
  	iImageList	Vector of pointers to input images.
  	iIteration	Number of iterations.
  	iKappa	Kappa parameter.
  	iChannelMask	selected channels to be processed. Default is all.
  	iNotifier	a notifier for progression, log and cancel.

  Returns:

  new clipped image.

Implements eLynx::Image::IImageOperators.

template<class Pixel >

virtual boost::shared_ptr< AbstractImage > eLynx::Image::ImageOperatorsImpl< Pixel >::CreateWeightedEntropy	(	const std::vector< const AbstractImage * > &	iImageList,
		uint32	iW,
		uint32	iH,
		uint32	iChannelMask,
		ProgressNotifier &	iNotifier
	)			const [virtual]

Creates an image from the list of images by using Weighted Entropy method.

Parameters:

	iImageList	Vector of pointers to input images.
	iW	Width of the window to calculate the entropy.
	iH	Height of the window to calculate the entropy.
	iChannelMask	selected channels to be processed. Default is all.
	iNotifier	a notifier for progression, log and cancel.

Returns:

new averaged image.

Implements eLynx::Image::IImageOperators.

template<class Pixel >

static bool eLynx::Image::ImageOperatorsImpl< Pixel >::Operator	(	ImageImpl< Pixel > &	ioImage,
		EImageOperator	iOperator,
		const ImageImpl< Pixel > &	iImage,
		uint32	iChannelMask = CM_All,
		ProgressNotifier &	iNotifier = ProgressNotifier_NULL
	)			[static]

template<class Pixel >

static bool eLynx::Image::ImageOperatorsImpl< Pixel >::OperatorMedian	(	AbstractImage &	oImage,
		const std::vector< const AbstractImage * > &	iImageList,
		uint32	iChannelMask = CM_All,
		ProgressNotifier &	iNotifier = ProgressNotifier_NULL
	)			[static]

template<class Pixel >

static bool eLynx::Image::ImageOperatorsImpl< Pixel >::OperatorMean	(	AbstractImage &	oImage,
		const std::vector< const AbstractImage * > &	iImageList,
		uint32	iChannelMask = CM_All,
		ProgressNotifier &	iNotifier = ProgressNotifier_NULL
	)			[static]

---

The documentation for this class was generated from the following file:

• ImageOperatorsImpl.h