Traverses image, returning samples. More...

#include <ImageModifierPack.h>

Inheritance diagram for ImageSampler:

Collaboration diagram for ImageSampler:

[legend]

Public Member Functions
	ImageSampler ()
	Default constructor.

	ImageSampler (const ImageSampler &op)

virtual void	process (Image &dst) const
	Runs Sampler on the given image. More...

const Sampler &	getSampler ()

virtual const std::string &	getFormat () const

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

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

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

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

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
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

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

const ReferenceMap &	getParameters () const

ReferenceMap &	getParameters ()

template<class F >
void	setParametersFromEntries (const F &args)

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". More...

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. More...

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

BeanLike &	operator= (const BeanLike &b)

virtual std::ostream &	toStream (std::ostream &ostr, bool compact=true) const

	BeanLike (const BeanLike &b)

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

Public Attributes
std::string	filename
	If defined, sampler will directly write to this file. The default constructor does not reference this.

Public Attributes inherited from ImageMod
bool	physicalScale

Protected Member Functions
	ImageSampler (const std::string &name, const std::string &description)

Protected Member Functions inherited from ImageMod
	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()

Protected Attributes
Sampler	sampler

std::string	format
	Output format, e.g. '{LON} {LAT} {AMVU} {AMVV} {QIND}'.

Protected Attributes inherited from BeanLike
const std::string	name

const std::string	description

ReferenceMap	parameters

Detailed Description

Traverses image, returning samples.

As convenience, provides also a filename

drainage image-gray.png --sample file=samples-gray.txt

drainage image.png --format '${i},${j}\t ${0},${-2}' --sample 50,50,file=samples.txt

drain::image::ImageSampler::format

std::string format

Output format, e.g. '{LON} {LAT} {AMVU} {AMVV} {QIND}'.

Definition: ImageModifierPack.h:454

Member Function Documentation

◆ process()

void process ( Image & dst ) const

virtual

Runs Sampler on the given image.

Parameters

dst	- target image

Reimplemented from ImageMod.

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

src/drain/imageops/ImageModifierPack.h
src/drain/imageops/ImageModifierPack.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ process()