ScalingFunctor Class Reference

Rescales intensities linearly: f' = scale*f + offset. More...

#include <FunctorPack.h>

Inheritance diagram for ScalingFunctor:

Collaboration diagram for ScalingFunctor:

Public Member Functions
	ScalingFunctor (double scale=1.0, double bias=0.0)
	ScalingFunctor (const ScalingFunctor &ftor)
double	operator() (double s) const
Public Member Functions inherited from UnaryFunctor
	UnaryFunctor (const std::string &name, const std::string &description="", double scale=1.0, double bias=0.0)
Public Member Functions inherited from Functor
void	setScale (double scale, double bias=0.0)
virtual void	updateBean () const override
	Called after setParameters()
Public Member Functions inherited from BeanLike
	BeanLike (const BeanLike &b)
	BeanLike (const std::string &name, const std::string &description="")
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 map_t &	getParameters () const
map_t &	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".
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)
virtual std::ostream &	toStream (std::ostream &ostr, bool compact=true) const

Protected Member Functions
	ScalingFunctor (const std::string &name, const std::string &description, double scale=1.0, double bias=0.0)
Protected Member Functions inherited from Functor
	Functor (const std::string &name, const std::string &description="", double scale=1.0, double bias=0.0)
	Functor (const Functor &fct)
virtual void	updateScale () const
Protected Member Functions inherited from BeanLike
virtual void	storeLastArguments (const std::string &p)
	Called after setParameters()

Additional Inherited Members
Public Types inherited from BeanLike
typedef ReferenceMap	map_t
Protected Attributes inherited from Functor
double	scale
	Relative scale, typically 1. Optional.
double	bias
	"Relative" bias, typically 0. Optional.
double	scaleFinal
	Scaling factor after encodings of src and dst images are known.
double	biasFinal
	Scaling factor after encodings of src and dst images are known.
Protected Attributes inherited from BeanLike
const std::string	name
const std::string	description
map_t	parameters

Detailed Description

Rescales intensities linearly: f' = scale*f + offset.

Scale determines the contrast, offset determines the brightness of the resulting image.

drainage image-gray.png  --iRescale 0.5              -o scale-dark.png
drainage image-gray.png  --target S --iRescale 128   -o scale-dark16.png
drainage image-gray.png  --iRescale 0.5,128          -o scale-dim.png
drainage image.png --iRescale 0.5,128          -o scale-dim-image.png
drainage image-gray.png  --iRescale 2.0,-128,LIMIT=1 -o scale-contrast.png

Member Function Documentation

operator()()

double operator() ( double  s ) const

inlinevirtual

Implements UnaryFunctor.

---

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

• src/drain/util/FunctorPack.h