HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Functions
GA_AIFInterp.h File Reference
#include "GA_API.h"
#include "GA_Types.h"
#include <SYS/SYS_Types.h>
+ Include dependency graph for GA_AIFInterp.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define GA_AIFINTERP_OPERAND_METHODS(BASECLASS)
 

Functions

virtual bool endSum (GA_Attribute &d, GA_Offset di, const GA_WeightedSum &sum, fpreal scale_factor=1) const =0
 Attribute Interface class to perform interpolation operations on attributes. More...
 
virtual bool endSquare (GA_Attribute &d, GA_Offset di, const GA_WeightedSum &sum, fpreal scale_factor=1) const =0
 
virtual bool addHSum (GA_Attribute &d, GA_Offset di, const GA_WeightedSum &sum, const GA_Attribute &a, GA_Offset ai) const
 
virtual bool addHSquare (GA_Attribute &d, GA_Offset di, const GA_WeightedSum &sum, const GA_Attribute &a, GA_Offset ai) const
 Add the square of the homogeneous input to the sum. More...
 
virtual bool endHSum (GA_Attribute &d, GA_Offset di, const GA_WeightedSum &sum, fpreal scale_factor=1) const
 
virtual bool endHSquare (GA_Attribute &d, GA_Offset di, const GA_WeightedSum &sum, fpreal scale_factor=1) const
 
virtual bool lerp (GA_AttributeOperand &d, GA_AttributeOperand &a, GA_AttributeOperand &b, GA_AttributeOperand &t) const
 d = SYSlerp(a, b, t); More...
 
virtual bool smooth (GA_AttributeOperand &d, GA_AttributeOperand &min, GA_AttributeOperand &max, GA_AttributeOperand &t) const
 d = SYSsmooth(min, max, t); More...
 
virtual bool fit (GA_AttributeOperand &d, GA_AttributeOperand &a, GA_AttributeOperand &omin, GA_AttributeOperand &omax, GA_AttributeOperand &nmin, GA_AttributeOperand &nmax) const
 d = SYSfit(a, omin, omax, nmin, nmax); More...
 
virtual bool fit01 (GA_AttributeOperand &d, GA_AttributeOperand &a, GA_AttributeOperand &nmin, GA_AttributeOperand &nmax) const
 d = SYSfit(a, 0, 1, nmin, nmax); More...
 
virtual bool fit01 (GA_Attribute &d, const GA_Range &di, const GA_Attribute &a, const GA_Range &ai, fpreal nmin, fpreal nmax) const
 
virtual bool fit01 (GA_Attribute &d, GA_Offset di, const GA_Attribute &a, GA_Offset ai, fpreal nmin, fpreal nmax) const
 
virtual bool lerp (GA_Attribute &d, GA_Offset di, const GA_Attribute &a, GA_Offset ai, const GA_Attribute &b, GA_Offset bi, fpreal t) const =0
 
virtual bool lerp (GA_Attribute &d, const GA_Range &di, const GA_Attribute &a, const GA_Range &ai, const GA_Attribute &b, const GA_Range &bi, fpreal t) const =0
 
virtual bool lerp (GA_Attribute &d, const GA_Range &di, const GA_Attribute &a, const GA_Range &ai, const GA_Attribute &b, const GA_Range &bi, const GA_Attribute &t, const GA_Range &ti) const =0
 
virtual bool smooth (GA_Attribute &d, GA_Offset di, fpreal min, fpreal max, const GA_Attribute &a, GA_Offset ai) const =0
 
virtual bool smooth (GA_Attribute &d, const GA_Range &di, fpreal min, fpreal max, const GA_Attribute &a, const GA_Range &ai) const =0
 
virtual bool fit (GA_Attribute &d, GA_Offset di, const GA_Attribute &a, GA_Offset ai, fpreal omin, fpreal omax, fpreal nmin, fpreal nmax) const =0
 
virtual bool fit (GA_Attribute &d, const GA_Range &di, const GA_Attribute &a, const GA_Range &ai, fpreal omin, fpreal omax, fpreal nmin, fpreal nmax) const =0
 

Macro Definition Documentation

#define GA_AIFINTERP_OPERAND_METHODS (   BASECLASS)
Value:
bool lerp(GA_AttributeOperand &d, \
GA_AttributeOperand &a, \
GA_AttributeOperand &b, \
GA_AttributeOperand &t) const override \
{ return BASECLASS::lerp(d, a, b, t); } \
bool smooth(GA_AttributeOperand &d, \
GA_AttributeOperand &min, \
GA_AttributeOperand &max, \
GA_AttributeOperand &t) const override \
{ return BASECLASS::smooth(d, min, max, t); } \
bool fit(GA_AttributeOperand &d, \
GA_AttributeOperand &a, \
GA_AttributeOperand &omin, \
GA_AttributeOperand &omax, \
GA_AttributeOperand &nmin, \
GA_AttributeOperand &nmax) const override \
{ return BASECLASS::fit(d, a, omin, omax, nmin, nmax); }
lerp
virtual bool lerp(GA_AttributeOperand &d, GA_AttributeOperand &a, GA_AttributeOperand &b, GA_AttributeOperand &t) const
d = SYSlerp(a, b, t);
a
GLboolean GLboolean GLboolean GLboolean a
Definition: glcorearb.h:1222
ImageBufAlgo::min
ImageBuf OIIO_API min(Image_or_Const A, Image_or_Const B, ROI roi={}, int nthreads=0)
GA_AttributeOperand
Definition: GA_AttributeOperand.h:35
fit
virtual bool fit(GA_AttributeOperand &d, GA_AttributeOperand &a, GA_AttributeOperand &omin, GA_AttributeOperand &omax, GA_AttributeOperand &nmin, GA_AttributeOperand &nmax) const
d = SYSfit(a, omin, omax, nmin, nmax);
b
GLboolean GLboolean GLboolean b
Definition: glcorearb.h:1222
t
GLdouble t
Definition: glad.h:2397
smooth
virtual bool smooth(GA_AttributeOperand &d, GA_AttributeOperand &min, GA_AttributeOperand &max, GA_AttributeOperand &t) const
d = SYSsmooth(min, max, t);
ImageBufAlgo::max
ImageBuf OIIO_API max(Image_or_Const A, Image_or_Const B, ROI roi={}, int nthreads=0)

This macro can be used to implement the non-pure virtual attribute operand methods by calling the baseclass given (usually GA_AIFMath). For example, it might be used as:

class MyTupleInterface : public GA_AIFTuple
{
public:
GA_AIFMATH_OPERAND_METHODS(GA_AIFTuple)
... implement rest of class
}

Definition at line 253 of file GA_AIFInterp.h.

Function Documentation

virtual bool addHSquare ( GA_Attribute &  d,
GA_Offset  di,
const GA_WeightedSum &  sum,
const GA_Attribute &  a,
GA_Offset  ai 
) const
virtual

Add the square of the homogeneous input to the sum.

virtual bool addHSum ( GA_Attribute &  d,
GA_Offset  di,
const GA_WeightedSum &  sum,
const GA_Attribute &  a,
GA_Offset  ai 
) const
virtual

Add an element into the weighted sum where the element refers to homogeneous coordinates.

The wsum should be used in the endSum() to correct the normalization. That is, the endSum() code should look like:

endSum(d, di, sum, scale_factor / wsum, ...);

where the scale_factor is the non-homogeneous scale factor.

Parameters
dDestination attribute
diDestination offset
sumStorage for state of weighted sum
aAttribute to add into the sum
aiIndex of the attribute to add into the sum
Note
The default behaviour of this method is to call addSum()
virtual bool endHSquare ( GA_Attribute &  d,
GA_Offset  di,
const GA_WeightedSum &  sum,
fpreal  scale_factor = 1 
) const
virtual

Finish a weighted sum for homogeneous coordinates by scaling then taking the square root. For example:

endHSquare(d, di, sum, 1./sum.getTotalWeight());
virtual bool endHSum ( GA_Attribute &  d,
GA_Offset  di,
const GA_WeightedSum &  sum,
fpreal  scale_factor = 1 
) const
virtual

Finish a weighted sum for homogeneous coordinates. The scale_factor can be used to normalize weighting. For example:

endHSum(d, di, sum, 1./sum.getTotalWeight());
virtual bool endSquare ( GA_Attribute &  d,
GA_Offset  di,
const GA_WeightedSum &  sum,
fpreal  scale_factor = 1 
) const
pure virtual

Finish a weighted sum by scaling then taking the square root of the sum. The scale_factor can be used to normalize weighting. For example:

endSquare(d, di, sum, 1./sum.getTotalWeight());

A scale of 1 will result in the result being the square root of the sum.

virtual bool endSum ( GA_Attribute &  d,
GA_Offset  di,
const GA_WeightedSum &  sum,
fpreal  scale_factor = 1 
) const
pure virtual

Attribute Interface class to perform interpolation operations on attributes.

This class provides an interface to perform interpolation operations on attribute data.

  • lerp(d, a, b, t)
    d = SYSlerp(a, b, t) = (t-1)*a + t*b
  • smooth(d, min, max, t)
    d = SYSsmooth(min, max, t)
  • fit(d, t, omin, omax, nmin, nmax)
    d = SYSfit(t, omin, omax, nmin, nmax)
  • fit01(d, t, nmin, nmax)
    d = SYSfit(t, 0, 1, nmin, nmax)
  • Weighted sum
    • startSum(d, sum)
      Initializes the weighted sum for a given attribute
    • addSum(d, sum, a, w)
      Add a*w to the sum.
    • addSquare(d, sum, a, w)
      Add a*a*w to the sum
    • endSum(d, sum, scale_factor)
      Complete the sum, scaling the value. If scale_factor is 1, then no scaling is performed.
    • endSquare(d, sum, scale_factor)
      Complete the sum by scaling, then taking the square root of the result. If scale_factor is 1, then no scaling is performed. For example, the lerp function can be implemented as:
      lerp(d, a, b, t) {
      GA_AIFInterp *i = d.getAIFInterp();
      i->startSum(d, sum);
      i->addSum(d, sum, a, 1-t);
      i->addSum(d, sum, b, t);
      i->finishSum(d, sum);
      }
      // To compute the RMS of an attribute: @code
      rms(d, a, b, t) {
      GA_AIFInterp *i = d.getAIFInterp();
      i->startSum(d, sum);
      i->addSquare(d, sum, a, 1);
      i->addSquare(d, sum, b, 1);
      i->finishSquare(d, sum, 1/sum.getTotalWeight());
      }
      // Compute the sum of the squares of the input
      sumSquares(d, a, b, t) {
      GA_AIFInterp *i = d.getAIFInterp();
      i->startSum(d, sum);
      i->addSquare(d, sum, a, 1);
      i->addSquare(d, sum, b, 1);
      i->finishSum(d, sum, 1.0);
      }
      class GA_API GA_AIFInterp
      {
      public:
      GA_AIFInterp() {}
      virtual ~GA_AIFInterp();
      Return whether this interpolator is a conditional interpolation or
      whether values are actually interpolated.
      virtual bool isConditionalInterpolation() const { return false; }
      Note: Weighted sums can only be performed on a single element, and thus
      don't have a generic GA_AttributeOperand method.
      @param d The destination attribute
      @param di The index in the destination attribute used to store results
      @param sum Weighted sum to keep track of partial sums
      virtual bool startSum(GA_Attribute &d, GA_Offset di,
      const GA_WeightedSum &sum) const = 0;
      Add an element into the weighted sum
      @param d Destination attribute
      @param di Destination offset
      @param sum Storage for state of weighted sum
      @param a Attribute to add into the sum
      @param ai Index of the attribute to add into the sum
      virtual bool addSum(GA_Attribute &d, GA_Offset di,
      const GA_WeightedSum &sum,
      const GA_Attribute &a, GA_Offset ai) const = 0;
      Add the square of an element to the weighted sum
      @param d Destination attribute
      @param di Destination offset
      @param sum Storage for state of weighted sum
      @param a Attribute to add into the sum
      @param ai Index of the attribute to add into the sum
      virtual bool addSquare(GA_Attribute &d, GA_Offset di,
      const GA_WeightedSum &sum,
      const GA_Attribute &a, GA_Offset ai) const = 0;
      Finish a weighted sum. The scale_factor can be used to normalize
      weighting. For example: @code
      endSum(d, di, sum, 1./sum.getTotalWeight());
virtual bool fit ( GA_AttributeOperand &  d,
GA_AttributeOperand &  a,
GA_AttributeOperand &  omin,
GA_AttributeOperand &  omax,
GA_AttributeOperand &  nmin,
GA_AttributeOperand &  nmax 
) const
virtual

d = SYSfit(a, omin, omax, nmin, nmax);

Examples:
karma_procedurals/grasspatch.vfl, karma_procedurals/mandelbulb_intersect.vfl, and karma_procedurals/sphere_intersect.vfl.
virtual bool fit ( GA_Attribute &  d,
GA_Offset  di,
const GA_Attribute &  a,
GA_Offset  ai,
fpreal  omin,
fpreal  omax,
fpreal  nmin,
fpreal  nmax 
) const
pure virtual

Specializations of common method

virtual bool fit ( GA_Attribute &  d,
const GA_Range &  di,
const GA_Attribute &  a,
const GA_Range &  ai,
fpreal  omin,
fpreal  omax,
fpreal  nmin,
fpreal  nmax 
) const
pure virtual

Specializations of common method

virtual bool fit01 ( GA_AttributeOperand &  d,
GA_AttributeOperand &  a,
GA_AttributeOperand &  nmin,
GA_AttributeOperand &  nmax 
) const
virtual

d = SYSfit(a, 0, 1, nmin, nmax);

Examples:
karma_procedurals/grasspatch.vfl.
virtual bool fit01 ( GA_Attribute &  d,
const GA_Range &  di,
const GA_Attribute &  a,
const GA_Range &  ai,
fpreal  nmin,
fpreal  nmax 
) const
virtual
virtual bool fit01 ( GA_Attribute &  d,
GA_Offset  di,
const GA_Attribute &  a,
GA_Offset  ai,
fpreal  nmin,
fpreal  nmax 
) const
virtual
virtual bool lerp ( GA_AttributeOperand &  d,
GA_AttributeOperand &  a,
GA_AttributeOperand &  b,
GA_AttributeOperand &  t 
) const
virtual

d = SYSlerp(a, b, t);

virtual bool lerp ( GA_Attribute &  d,
GA_Offset  di,
const GA_Attribute &  a,
GA_Offset  ai,
const GA_Attribute &  b,
GA_Offset  bi,
fpreal  t 
) const
pure virtual

Specializations of common method

virtual bool lerp ( GA_Attribute &  d,
const GA_Range &  di,
const GA_Attribute &  a,
const GA_Range &  ai,
const GA_Attribute &  b,
const GA_Range &  bi,
fpreal  t 
) const
pure virtual

Specializations of common method

virtual bool lerp ( GA_Attribute &  d,
const GA_Range &  di,
const GA_Attribute &  a,
const GA_Range &  ai,
const GA_Attribute &  b,
const GA_Range &  bi,
const GA_Attribute &  t,
const GA_Range &  ti 
) const
pure virtual

Specializations of common method

virtual bool smooth ( GA_AttributeOperand &  d,
GA_AttributeOperand &  min,
GA_AttributeOperand &  max,
GA_AttributeOperand &  t 
) const
virtual

d = SYSsmooth(min, max, t);

Examples:
alligator/alligator.C.
virtual bool smooth ( GA_Attribute &  d,
GA_Offset  di,
fpreal  min,
fpreal  max,
const GA_Attribute &  a,
GA_Offset  ai 
) const
pure virtual

Specializations of common method

virtual bool smooth ( GA_Attribute &  d,
const GA_Range &  di,
fpreal  min,
fpreal  max,
const GA_Attribute &  a,
const GA_Range &  ai 
) const
pure virtual

Specializations of common method