Class for operations that modify an existing image instead of producing a new image. More...

#include <ImageMod.h>

Inheritance diagram for ImageMod:

[legend]

Collaboration diagram for ImageMod:

[legend]

Public Member Functions
virtual int	srcAlpha () const
	Tell if alpha channel(s) is required in input.

virtual void	process (Image &dst) const
	Run this modifier for an image.

virtual void	traverseChannels (ImageTray< Channel > &dst) const
	Run this modifier for a set of channels.

virtual void	traverseChannel (Channel &dst) const
	Run this modifier for an image frame.

virtual void	traverseChannel (Channel &dst, Channel &dstAlpha) const
	Run this modifier for an image frame.

virtual void	help (std::ostream &ostr=std::cout) const

virtual void	traverseChannels (ImageFrame &dst) const
	Converts dst to ImageTray<Channel> and calls traverseFrame(ImageTray<Channel> &) .

Public Member Functions inherited from BeanLike
	BeanLike (const BeanLike &b)
	Copy constructor. Re-links `parameters` to the member variables of this (new) instance.

	BeanLike (const std::string &name, const std::string &description="")
	Constructor.

virtual const std::string &	getName () const
	Return the name of an instance.

virtual const std::string &	getDescription () const
	Return a brief description.

bool	hasParameters () const
	Tells if any parameters have been linked (registered) for this bean.

template<class F >
F	getParameter (const std::string &p) const
	Gets a single parameter.

const map_t &	getParameters () const
	Returns the parameter map (const access).

map_t &	getParameters ()
	Returns the parameter map.

template<class F >
void	setParametersFromEntries (const F &args)
	Sets several parameters at once from a sequence of key-value pairs.

void	setParameters (std::initializer_list< Variable::init_pair_t > args)
	Grants access to (if above hidden)

virtual void	setParameters (const std::string &p, char assignmentSymbol='=', char separatorSymbol=0)
	Sets comma-separated parameters in a predetermined order "a,b,c" or by specifing them "b=2".

template<class T >
void	setParameters (const std::map< std::string, T > &args)
	Set parameters.

template<class T >
void	setParameters (const SmartMap< T > &args)
	Set parameters.

void	setParameter (const std::string &p, const Castable &value)
	Sets a single parameter.

template<class T >
void	setParameter (const std::string &p, const VariableT< T > &value)

template<class F >
void	setParameter (const std::string &p, const F &value)
	Sets a single parameter.

template<class F >
void	setParameter (const std::string &p, std::initializer_list< F > value)
	Sets a single parameter.

BeanLike &	operator= (const BeanLike &b)
	Assigns the parameter values of another bean (by key) to this one's own parameters.

virtual std::ostream &	toStream (std::ostream &ostr, bool compact=true) const
	Prints the name, description and current parameter values.

Public Attributes
bool	physicalScale

Protected Member Functions
	ImageMod (const std::string &name=__FUNCTION__, const std::string &description="")

	ImageMod (const ImageMod &op)

virtual void	processChannelsSeparately (ImageTray< Channel > &dst) const
	Run this modifier by calling traverseChannel(Channel &) for each image.

virtual void	initialize (Image &dst) const
	Modifies the geometry and the type of dst such that traverseChannel(Channel &) can be called.

virtual void	initializeAlpha (const Image &srcAlpha, Image &dstAlpha) const
	Modifies the geometry and the type of dst such that traverseChannel(Channel &) can be called.

Protected Member Functions inherited from BeanLike
virtual void	storeLastArguments (const std::string &p)
	Called after setParameters()

virtual void	updateBean () const
	Called after setParameters()

Additional Inherited Members
Public Types inherited from BeanLike
typedef ReferenceMap	map_t
	Reference map type used to store this bean's parameters (name -> linked variable).

Protected Attributes inherited from BeanLike
const std::string	name
	Name of this bean, typically also the name of the (derived) class.

const std::string	description
	Brief, human-readable description of this bean.

map_t	parameters
	Parameters (name -> linked variable), typically linked to member variables of the derived class.

Detailed Description

Class for operations that modify an existing image instead of producing a new image.

Constructor & Destructor Documentation

◆ ImageMod()

ImageMod	(	const std::string &	name = `__FUNCTION__`,
		const std::string &	description = `""`
	)

inlineprotected

TODO: CHECK: previously documented parameter 'weight_supported' - not supported (0), flexibly supported (1) or required (2) - no longer in the signature; reconsider or remove. TODO: CHECK: previously documented parameter 'in_place' - 0 = separate dst required, 1 = separate dst encouraged, 2 = dst is allowed to be src - no longer in the signature; reconsider or remove.

Member Function Documentation

◆ help()

virtual void help ( std::ostream & ostr = std::cout ) const

inlinevirtual

Reimplemented in ImageOp, and PaletteOp.

◆ initialize()

virtual void initialize ( Image & dst ) const

inlineprotectedvirtual

Modifies the geometry and the type of dst such that traverseChannel(Channel &) can be called.

Reimplemented in ImageChannels, ImageCoordPolicy, ImageEncoding, and ImageGeometry.

◆ process()

void process ( Image & dst ) const

virtual

Run this modifier for an image.

The default implementation redirects to traverseChannel(Channel & dst) .

Reimplemented in ImageSampler, and ImageOp.

◆ srcAlpha()

virtual int srcAlpha ( ) const

inlinevirtual

Tell if alpha channel(s) is required in input.

Future option: 0: not used 1: optional, supported 2: required

Reimplemented in DistanceTransformFillOp< T >, DistanceTransformFillOp< DistanceModelExponential >, DistanceTransformFillOp< DistanceModelLinear >, and FastAverageWeightedOp.

◆ traverseChannel() [1/2]

virtual void traverseChannel ( Channel & dst ) const

inlinevirtual

Run this modifier for an image frame.

The default implementation calls applyToEachChannel(Channel &) for each image. Run this modifier for an image frame. The default implementation calls traverseFrame(ChannelView & dst) for each image.

Reimplemented in ImageChannels, ImageCoordPolicy, ImageEncoding, ImageFill, ImageHistogram, and ImageGeometry.

◆ traverseChannel() [2/2]

virtual void traverseChannel	(	Channel &	dst,
		Channel &	dstAlpha
	)		const

inlinevirtual

Run this modifier for an image frame.

The default implementation calls traverseFrame(ChannelView & dst) for each image.

◆ traverseChannels()

void traverseChannels ( ImageTray< Channel > & dst ) const

virtual

Run this modifier for a set of channels.

The default implementation forwards to applyToEachChannel(ImageTray<Channel> & dst) & dst)

By definition of Channel, geometries and types will be unaltered.

Reimplemented in ImageFill, ImagePlot, and ImageBox.

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

src/drain/imageops/ImageMod.h
src/drain/imageops/ImageMod.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ImageMod()

Member Function Documentation

◆ help()

◆ initialize()

◆ process()

◆ srcAlpha()

◆ traverseChannel() [1/2]

◆ traverseChannel() [2/2]

◆ traverseChannels()