eLynx::Image::IImageOperators Class Reference

Interface defining image operators functionnalities. More...

#include <IImageOperators.h>

Inheritance diagram for eLynx::Image::IImageOperators:

List of all members.

Public Member Functions
virtual bool	Operator (AbstractImage &ioImage, EImageOperator iOperator, double iValue, uint32 iChannelMask, ProgressNotifier &iNotifier) const =0
	Apply operator with const value.
virtual bool	Operator (AbstractImage &ioImage, EImageOperator iOperator, const AbstractImage &iImage, uint32 iChannelMask, ProgressNotifier &iNotifier) const =0
	Apply operator with another image, ioImage = ioImage (operator) iImage ioImage and iImage must have the same format and size.
virtual bool	Operator (AbstractImage &ioImage, EImageOperator iOperator, const AbstractImage &iImage, const ImageLub &iImageMask, uint32 iChannelMask, ProgressNotifier &iNotifier) const =0
	Apply operator with another image, ioImage = ioImage (operator) iImage ioImage and iImage must have the same format and size.
virtual bool	Operator (AbstractImage &ioImage, EImageOperator iOperator, const std::vector< const AbstractImage * > &iImageList, uint32 iChannelMask, ProgressNotifier &iNotifier) const =0
	Apply operator on image list, oImage = operator iImageList.
virtual boost::shared_ptr < AbstractImage >	CreateImage (EImageListOperator iOperator, const std::vector< const AbstractImage * > &iImageList, uint32 iChannelMask, ProgressNotifier &iNotifier) const =0
	Creates an image from the list of images by using one of the following methods: Adding them together Multiplying by each other Taking Min pixel value Taking Max pixel value Taking Mean pixel value Taking Median pixel value.
virtual boost::shared_ptr < AbstractImage >	CreateClipped (EImageListOperator iOperator, const std::vector< const AbstractImage * > &iImageList, uint32 iIteration, double iKappa, uint32 iChannelMask, ProgressNotifier &iNotifier) const =0
	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.
virtual boost::shared_ptr < AbstractImage >	CreateWeightedEntropy (const std::vector< const AbstractImage * > &iImageList, uint32 iW, uint32 iH, uint32 iChannelMask, ProgressNotifier &iNotifier) const =0
	Creates an image from the list of images by using Weighted Entropy method.

---

Detailed Description

Interface defining image operators functionnalities.

---

Member Function Documentation

virtual boost::shared_ptr< AbstractImage > eLynx::Image::IImageOperators::CreateClipped	(	EImageListOperator	iOperator,
		const std::vector< const AbstractImage * > &	iImageList,
		uint32	iIteration,
		double	iKappa,
		uint32	iChannelMask,
		ProgressNotifier &	iNotifier
	)		const [pure 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.

Implemented in eLynx::Image::ImageOperatorsImpl< Pixel >.

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

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

• Adding them together
• Multiplying by each other
• Taking Min pixel value
• Taking Max pixel value
• Taking Mean pixel value
• Taking Median pixel value.

Parameters:

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

Returns:

new clipped image.

Implemented in eLynx::Image::ImageOperatorsImpl< Pixel >.

virtual boost::shared_ptr< AbstractImage > eLynx::Image::IImageOperators::CreateWeightedEntropy	(	const std::vector< const AbstractImage * > &	iImageList,
		uint32	iW,
		uint32	iH,
		uint32	iChannelMask,
		ProgressNotifier &	iNotifier
	)		const [pure 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.

Implemented in eLynx::Image::ImageOperatorsImpl< Pixel >.

virtual bool eLynx::Image::IImageOperators::Operator	(	AbstractImage &	ioImage,
		EImageOperator	iOperator,
		const AbstractImage &	iImage,
		uint32	iChannelMask,
		ProgressNotifier &	iNotifier
	)		const [pure 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.

Implemented in eLynx::Image::ImageOperatorsImpl< Pixel >.

virtual bool eLynx::Image::IImageOperators::Operator	(	AbstractImage &	ioImage,
		EImageOperator	iOperator,
		const std::vector< const AbstractImage * > &	iImageList,
		uint32	iChannelMask,
		ProgressNotifier &	iNotifier
	)		const [pure 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.

Implemented in eLynx::Image::ImageOperatorsImpl< Pixel >.

virtual bool eLynx::Image::IImageOperators::Operator	(	AbstractImage &	ioImage,
		EImageOperator	iOperator,
		const AbstractImage &	iImage,
		const ImageLub &	iImageMask,
		uint32	iChannelMask,
		ProgressNotifier &	iNotifier
	)		const [pure 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.

Implemented in eLynx::Image::ImageOperatorsImpl< Pixel >.

virtual bool eLynx::Image::IImageOperators::Operator	(	AbstractImage &	ioImage,
		EImageOperator	iOperator,
		double	iValue,
		uint32	iChannelMask,
		ProgressNotifier &	iNotifier
	)		const [pure 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.

Implemented in eLynx::Image::ImageOperatorsImpl< Pixel >.

---

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

• E:/dev/eLynx/include/elx/image/IImageOperators.h