#include <ImFusion/ImageMath/Poly/BinaryOp.h>

Specialization of ExprBase for binary operators (non template optimization) More...

Inheritance diagram for BinaryOp< Op >:

Detailed Description

template<typename Op>
class ImFusion::ImageMath::internal::BinaryOp< Op >

Specialization of ExprBase for binary operators (non template optimization)

Template Parameters

Op	A struct representing a binary expression examples can be found in SharedImageSetArithmeticOperators.h

Example for Op:

struct add
{
    template <typename LhsT, typename RhsT>
    IMFUSION_STRONG_INLINE auto operator()(LhsT lhs, RhsT rhs) const -> decltype(std::declval<LhsT>() + std::declval<RhsT>())
    {
        return lhs + rhs;
    }
 
    std::string evalString(const std::string& lhsStr, const std::string& rhsStr) const
    {
        std::string str;
        str.reserve(5 + lhsStr.size() + rhsStr.size());
 
        str += "(";
        str += lhsStr;
        str += ")+(";
        str += rhsStr;
        str += ")";
 
        return str;
    }
};

Public Member Functions
	BinaryOp (std::shared_ptr< ExprBase > lhs, std::shared_ptr< ExprBase > rhs, const Op &func=Op())

std::unique_ptr< ExprBase >	clone () const override
	Clone the current expression. May not return nullptr.

std::unique_ptr< ExprBase >	substituteVariableWithImg (const SharedImage &variable) const override

std::unique_ptr< ExprBase >	substituteVariableWithImg (const SharedImageSet &variable) const override
	Substitute all variables with `variable`.

void	evalImpl (Array< SharedImage, void > &img) const override

void	evalImpl (Array< SharedImageSet, void > &img) const override
	Implementation functionality used in eval()

GlExprInterface &	lhs () override

const GlExprInterface &	lhs () const override

GlExprInterface &	rhs () override

const GlExprInterface &	rhs () const override

const ImgOps::BinaryImgOpGl &	op () const override

std::unique_ptr< ExprBase >	convertToSharedImgExpr (std::size_t index) const override
	Convert a SharedImageSet expression to a SharedImage expression.

int	numImgs () const override
	Return number of images of this expression.

ExprType	exprType () const override
	Return the ImFusion image type, i.e. NoImage, SharedImage, SharedImageSet.

DeviceStrategy	deviceStrategy () const override
	Return DeviceStrategy of this expression.

Public Member Functions inherited from ExprBase
ImageDescriptor	imgDesc () const
	Return ImageDescriptor of the expression (forwards to the ExprInterface)

int	numImgs () const
	Return the number of images of the expression (forwards to the ExprInterface)

template<typename T, typename ImgType = void>
auto	evaluateIntoImage (bool clearShiftScale=false) const
	Evaluate expression into an image.

void	eval (Array< SharedImage, void > &img, const SharedImage *variable) const

void	eval (Array< SharedImage, void > &img) const
	Evaluate into SharedImage.

void	eval (Array< SharedImageSet, void > &img, const SharedImageSet *variable) const
	Evaluate into SharedImageSet. Variable leafs will be substituted with `variable`.

void	eval (Array< SharedImageSet, void > &img) const
	Evaluate into SharedImageSet.

internal::GlExprInterface &	glExprInterface ()

const internal::GlExprInterface &	glExprInterface () const

ExprInterface &	exprInterface ()

const ExprInterface &	exprInterface () const

template<typename Op>
reduction_type	reduce (std::vector< vec4i > *arg=nullptr) const

std::unique_ptr< ExprBase >	forceCPU () const
	Forces CPU execution.

std::unique_ptr< ExprBase >	forceGPU () const
	Forces GPU execution.

std::unique_ptr< ExprBase >	channelSwizzle (const std::vector< std::size_t > &indices) const

template<typename CastT>
std::unique_ptr< ExprBase >	cast () const

	ADD_REDUCTION_OP_DEF (sum, add)

	ADD_REDUCTION_OP_DEF (prod, mult)

	ADD_ARG_REDUCTION_OP_DEF (min, min)

	ADD_ARG_REDUCTION_OP_DEF (max, max)

Eigen::Matrix< double, Eigen::Dynamic, 1 >	mean () const

Eigen::Matrix< double, Eigen::Dynamic, 1 >	l1Norm () const

Eigen::Matrix< double, Eigen::Dynamic, 1 >	squaredl2Norm () const

Eigen::Matrix< double, Eigen::Dynamic, 1 >	l2Norm () const

Eigen::Matrix< double, Eigen::Dynamic, 1 >	lpNorm (double p) const

Eigen::Matrix< double, Eigen::Dynamic, 1 >	lInfNorm () const

Public Member Functions inherited from BinaryOpBase
	BinaryOpBase (PixelType pixelType)

ImageDescriptor	imgDesc () const override final
	Return ImageDescriptor of this expression. This reference is expected to remain the same while the class exists.

Public Member Functions inherited from BinaryOpGl
std::string	evalString (bool tagAndAssign=true) const override final
	Evaluate the operator as applied to lhs and rhs Overrides the behaviour of (in)equality operators for the single-channel case.

void	tagAndAssignNames (std::unordered_map< internal::TaggingIndex, const void * > &taggedLeaves, std::unordered_map< std::type_index, int > &countPerLeafType, const std::string &prefix) const override final
	We need to tag leaves and tell unique leaves that they are responsible to define the uniforms and set the shader arguments.

void	getUniformDefinitionList (std::string &definitionList, const std::vector< int > &indices, const std::string &prefix) const override final
	Collect uniform/sampler definitions.

void	getVariableDefinitionList (std::string &definitionList, const std::vector< int > &indices, const std::string &prefix) const override final
	Collect variable definitions.

int	setArguments (GL::Program &p, const std::vector< int > &indices, const std::string &prefix) const override final
	Set uniform/sampler arguments.

std::vector< GlExprInterface * >	children () override final
	Used for traversing the expression tree. Contains the immediate children of node.

std::vector< const GlExprInterface * >	children () const override final
	Used for traversing the expression tree. Contains the immediate children of node.

Public Member Functions inherited from GlExprInterface
ExprInterface &	exprInterface ()
	Get image descriptor of the wrapped expression.

const ExprInterface &	exprInterface () const

virtual bool	setMagFilter (ImageMath::MagFilter mag)
	Set interpolation behaviour of the current leaf (only)

virtual bool	setWrap (ImageMath::Wrap wrap)
	Set interpolation behaviour of the current leaf (only)

bool	setMagFilterRecursive (ImageMath::MagFilter mag)
	Set interpolation behaviour of the current leaf and all of its children.

bool	setWrapRecursive (ImageMath::Wrap wrap)
	Set wrap behaviour of the current leaf and all of its children.

Additional Inherited Members
Public Types inherited from ExprBase
enum class	ExprType { Scalar = 0 , SharedImage = 1 , SharedImageSet = 2 , Variable = 3 }

Protected Attributes inherited from BinaryOpBase
const PixelType	m_pixelType
	PixelType.

Member Function Documentation

◆ clone()

template<typename Op>

std::unique_ptr< ExprBase > clone ( ) const

inlineoverridevirtual

Clone the current expression. May not return nullptr.

Implements ExprBase.

◆ substituteVariableWithImg() [1/2]

template<typename Op>

std::unique_ptr< ExprBase > substituteVariableWithImg ( const SharedImage & variable ) const

inlineoverridevirtual

Substitute all variables with variable

Implements ExprBase.

◆ substituteVariableWithImg() [2/2]

template<typename Op>

std::unique_ptr< ExprBase > substituteVariableWithImg ( const SharedImageSet & variable ) const

inlineoverridevirtual

Substitute all variables with variable.

Implements ExprBase.

◆ evalImpl() [1/2]

template<typename Op>

void evalImpl ( Array< SharedImage, void > & img ) const

inlineoverridevirtual

Implementation functionality used in eval()

Implements ExprBase.

◆ evalImpl() [2/2]

template<typename Op>

void evalImpl ( Array< SharedImageSet, void > & img ) const

inlineoverridevirtual

Implementation functionality used in eval()

Implements ExprBase.

◆ lhs() [1/2]

template<typename Op>

GlExprInterface & lhs ( )

inlineoverridevirtual

Implements BinaryOpBase.

◆ lhs() [2/2]

template<typename Op>

const GlExprInterface & lhs ( ) const

inlineoverridevirtual

Implements BinaryOpBase.

◆ rhs() [1/2]

template<typename Op>

GlExprInterface & rhs ( )

inlineoverridevirtual

Implements BinaryOpBase.

◆ rhs() [2/2]

template<typename Op>

const GlExprInterface & rhs ( ) const

inlineoverridevirtual

Implements BinaryOpBase.

◆ op()

template<typename Op>

const ImgOps::BinaryImgOpGl & op ( ) const

inlineoverridevirtual

Implements BinaryOpBase.

◆ convertToSharedImgExpr()

template<typename Op>

std::unique_ptr< ExprBase > convertToSharedImgExpr ( std::size_t index ) const

inlineoverridevirtual

Convert a SharedImageSet expression to a SharedImage expression.

Implements ExprBase.

◆ numImgs()

template<typename Op>

int numImgs ( ) const

inlineoverridevirtual

Return number of images of this expression.

Implements ExprInterface.

◆ exprType()

template<typename Op>

ExprType exprType ( ) const

inlineoverridevirtual

Return the ImFusion image type, i.e. NoImage, SharedImage, SharedImageSet.

Implements ExprBase.

◆ deviceStrategy()

template<typename Op>

DeviceStrategy deviceStrategy ( ) const

inlineoverridevirtual

Return DeviceStrategy of this expression.

Implements ExprInterface.

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

ImFusion/ImageMath/Poly/BinaryOp.h
ImFusion/ImageMath/Utils/ForwardDeclarations.h

Detailed Description

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ clone()

◆ substituteVariableWithImg() [1/2]

◆ substituteVariableWithImg() [2/2]

◆ evalImpl() [1/2]

◆ evalImpl() [2/2]

◆ lhs() [1/2]

◆ lhs() [2/2]

◆ rhs() [1/2]

◆ rhs() [2/2]

◆ op()

◆ convertToSharedImgExpr()

◆ numImgs()

◆ exprType()

◆ deviceStrategy()