SPATMOD::IMAGE::FILTER_DATATYPE Class Reference

Filter to change data type of an image. More...

#include <spatmod/imagefilterdatatype.h>

Inheritance diagram for SPATMOD::IMAGE::FILTER_DATATYPE:

[legend]

List of all members.

Classes
class	SETTINGS
	Filter settings. More...
Public Types
enum	MODE {   MODE_Source = 0, MODE_RoundLimit = 1, MODE_RoundInvalidate = 2, MODE_RoundRescale = 3,   MODE_RoundNoCheck = 4, MODE_FloorLimit = 5, MODE_FloorInvalidate = 6, MODE_FloorRescale = 7,   MODE_FloorNoCheck = 8, MODE_Limit = MODE_RoundLimit, MODE_Invalidate = MODE_RoundInvalidate, MODE_Rescale = MODE_RoundRescale,   MODE_NoCheck = MODE_RoundNoCheck }
Public Member Functions
	FILTER_DATATYPE (STAGE *pSourceImage, bool TakeOwnership, const SETTINGS *Settings)
	FILTER_DATATYPE (STAGE *pSourceImage, bool TakeOwnership, DATATYPE TargetDataType, int Precision, MODE Mode, double MinValue, double MaxValue, bool PassOpacity=true)
	FILTER_DATATYPE (STAGE *pSourceImage, bool TakeOwnership, DATATYPE TargetDataType, int Precision, MODE Mode, bool PassOpacity=true)
	FILTER_DATATYPE (STAGE *pSourceImage, bool TakeOwnership, DATATYPE TargetDataType, MODE Mode, double MinValue, double MaxValue, bool PassOpacity=true)
	FILTER_DATATYPE (STAGE *pSourceImage, bool TakeOwnership, DATATYPE TargetDataType, MODE Mode, bool PassOpacity=true)
virtual	~FILTER_DATATYPE ()

---

Detailed Description

Filter to change data type of an image.

---

Member Enumeration Documentation

enum SPATMOD::IMAGE::FILTER_DATATYPE::MODE

Mode for how values are converted and handling for out of range values.

Enumerator:

MODE_Source	Use data type and sample values directly from source.
MODE_RoundLimit	Limit values to target range, rounding if integer result.
MODE_RoundInvalidate	Invalidate pixels with sample values outside target range, rounding if integer result.
MODE_RoundRescale	Rescale values to target range, rounding if integer result.
MODE_RoundNoCheck	Don't check value, only allowed if source type fits target, rounding if integer result.
MODE_FloorLimit	Limit values to target range, flooring if integer result.
MODE_FloorInvalidate	Invalidate pixels with sample values outside target range, flooring if integer result.
MODE_FloorRescale	Rescale values to target range, flooring if integer result.
MODE_FloorNoCheck	Don't check value, only allowed if source type fits target, flooring if integer result.
MODE_Limit
MODE_Invalidate
MODE_Rescale
MODE_NoCheck

---

Constructor & Destructor Documentation

SPATMOD::IMAGE::FILTER_DATATYPE::FILTER_DATATYPE	(	STAGE *	pSourceImage,
		bool	TakeOwnership,
		DATATYPE	TargetDataType,
		MODE	Mode,
		bool	PassOpacity = true
	)

Construct with same target data type and mode for all samples and default range.

Parameters:

	pSourceImage	Source image stage
	TakeOwnership	Filter takes ownership of source stage and will delete when needed
	TargetDataType	Target data type
	Mode	Mode for value conversion and range validation
	PassOpacity	Pass opacity samples unchanged

SPATMOD::IMAGE::FILTER_DATATYPE::FILTER_DATATYPE	(	STAGE *	pSourceImage,
		bool	TakeOwnership,
		DATATYPE	TargetDataType,
		MODE	Mode,
		double	MinValue,
		double	MaxValue,
		bool	PassOpacity = true
	)

Construct with same target data type and mode for all samples and specified range.

Parameters:

	pSourceImage	Source image stage
	TakeOwnership	Filter takes ownership of source stage and will delete when needed
	TargetDataType	Target data type
	Mode	Mode for value conversion and range validation
	MinValue	Minimum target sample value
	MaxValue	Maximum target sample value
	PassOpacity	Pass opacity samples unchanged

SPATMOD::IMAGE::FILTER_DATATYPE::FILTER_DATATYPE	(	STAGE *	pSourceImage,
		bool	TakeOwnership,
		DATATYPE	TargetDataType,
		int	Precision,
		MODE	Mode,
		bool	PassOpacity = true
	)

Construct with same target data type and mode for all samples and default range.

Parameters:

	pSourceImage	Source image stage
	TakeOwnership	Filter takes ownership of source stage and will delete when needed
	TargetDataType	Target data type
	Precision	Sample Precision
	Mode	Mode for value conversion and range validation
	PassOpacity	Pass opacity samples unchanged

SPATMOD::IMAGE::FILTER_DATATYPE::FILTER_DATATYPE	(	STAGE *	pSourceImage,
		bool	TakeOwnership,
		DATATYPE	TargetDataType,
		int	Precision,
		MODE	Mode,
		double	MinValue,
		double	MaxValue,
		bool	PassOpacity = true
	)

Construct with same target data type and mode for all samples and specified range.

Parameters:

	pSourceImage	Source image stage
	TakeOwnership	Filter takes ownership of source stage and will delete when needed
	TargetDataType	Target data type
	Precision	Sample Precision
	Mode	Mode for value conversion and range validation
	MinValue	Minimum target sample value
	MaxValue	Maximum target sample value
	PassOpacity	Pass opacity samples unchanged

SPATMOD::IMAGE::FILTER_DATATYPE::FILTER_DATATYPE	(	STAGE *	pSourceImage,
		bool	TakeOwnership,
		const SETTINGS *	Settings
	)

Construct with SETTINGS array.

Parameters:

	pSourceImage	Source image stage
	TakeOwnership	Filter takes ownership of source stage and will delete when needed
	Settings	Array of settings, one entry for each input sample

virtual SPATMOD::IMAGE::FILTER_DATATYPE::~FILTER_DATATYPE

(

)

[virtual]

---

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

• spatmod/imagefilterdatatype.h