Into API documentation

Modules

▶

Core module

▶
Pii namespace
- Abs
 An adaptable unary function for taking the absolute value.
 Template parameters
 <class T>
 Specializations
 - < std::complex< T > >
- Abs2
 An adaptable unary function for taking the absolute value of the square of a real number.
 Template parameters
 <class T>
 Specializations
 - < std::complex< T > >
- AbsDiff
 
 An adaptable binary function that calculates the absolute difference of its arguments, .
 Template parameters
 <class T>
- AbsPow
 
 An adaptable binary function that raises the absolute value of its first argument to the power of the second argument.
 Template parameters
 <class T, class U, class R>
- AbsSum
 
 An adaptable binary function that calculates the sum of absolute values, .
 Template parameters
 <class T>
- Acos
 A unary function that returns acos(x).
 Template parameters
 <class T>
 Specializations
 - < float >
- And
 A template that performs a logical AND operation on its boolean template parameters.
 Template parameters
 <bool, bool, bool, bool, bool, bool, bool>
 Specializations
 - < true, true, true, true, true, true, true >
- Asin
 A unary function that returns asin(x).
 Template parameters
 <class T>
 Specializations
 - < float >
- Atan
 A unary function that returns tan(x).
 Template parameters
 <class T>
 Specializations
 - < float >
- Atan2
 An adaptable binary function that calculates the arc tangent of two variables.
 Template parameters
 <class T>
 Specializations
 - < float >
- BinaryAnd
 
 An adaptable binary functor that performs the binary AND operation.
 Template parameters
 <class T>
- BinaryCompose
 
 A unary/binary function adaptor that makes the results of two unary functions the arguments of a binary function.
 Template parameters
 <class AdaptableBinaryFunction, class AdaptableUnaryFunction1, class AdaptableUnaryFunction2>
- BinaryFunction
 
 An stl-compatible model for an adaptable binary function.
 Template parameters
 <class, class, class>
- BinaryNot
 
 An adaptable binary unary functor that performs the binary NOT operation.
 Template parameters
 <class T>
- BinaryOr
 
 An adaptable binary functor that performs the binary OR operation.
 Template parameters
 <class T>
- BinaryShiftLeft
 
 An adaptable binary binary functor that shifts the left operand left as many times as indicated by the right operand.
 Template parameters
 <class T>
- BinaryShiftRight
 
 An adaptable binary binary functor that shifts the left operand right as many times as indicated by the right operand.
 Template parameters
 <class T>
- BinaryXor
 
 An adaptable binary functor that performs the binary XOR operation.
 Template parameters
 <class T>
- Bound
 
 A unary function that bounds its argument to a predefined range.
 Template parameters
 <class T>
- Cast
 
 An adaptable unary function that casts its argument from type From to type To.
 Template parameters
 <class From, class To>
- Ceil
 
 A unary function that returns ceil(x).
 Template parameters
 <class T>
- Conj
 
 An adaptable unary function that returns the complex conjugate of a real number (which is the argument itself) or a complex number.
 Template parameters
 <class T>
- Cos
 A unary function that returns cos(x).
 Template parameters
 <class T>
 Specializations
 - < float >
- CountFunction
 
 A unary function that increments/decrements its internal counter by a predefined value each time the function is called.
 Template parameters
 <class T>
- EigenSystem
 
 Implements eigenvalue calculations and stores the results of the calculations (eigenvalues and eigenvectors).
 Template parameters
 <class tT, class tReal>
- Empty
 
 An empty structure.
- Exp
 
 An adaptable unary function for calculating the base-e exponential.
 Template parameters
 <class T>
- False
 
 A structure whose constant boolValue member evaluates to false.
- FastAtan2
 
 An adaptable binary function that uses a fast approximation (0.01 rad accuracy) to calculate the arc tangent of two variables.
 Template parameters
 <class T>
- FastestAtan2
 
 An adaptable binar function that uses a very fast but crude approximation (0.07 rad accuracy) to calculate the arc tangent of two variables.
 Template parameters
 <class T>
- Floor
 
 A unary function that returns floor(x).
 Template parameters
 <class T>
- ForEachFunction
 
 Helper function for algorithms that involve scrolling elements.
 Template parameters
 <class FuItem, class FuMemory>
- Generator
 
 An stl-compatible model for a generator function that takes no arguments.
 Template parameters
 <class>
- Hypotenuse
 An adaptable binary function that calculates the hypotenuse given two orthogonal sides of a triangle, .
 Template parameters
 <class T>
 Specializations
 - < int >
- Id
 
 A structure whose nested type, Type, is T.
 Template parameters
 <class T>
- Identity
 
 A unary function that returns its argument: f(x) = x.
 Template parameters
 <class T>
- IeeeFloat
 
 A class that wraps a floating-point number and allows one to twiddle its bits.
 Template parameters
 <class >
- IeeeFloatTraits< double >
 A traits structure that specifies the bit counts and corresponding integer types for the double type.
 Specializations
 - < double >
 - < float >
- If
 A conditional template.
 Template parameters
 <bool, class, class>
 Specializations
 - < false, Then, Else >
- IfClass
 
 A conditional template that accepts a type name as the condition parameter.
 Template parameters
 <class Condition, class Then, class Else>
- Imag
 A unary function that returns the imaginary part of its argument.
 Template parameters
 <class T>
 Specializations
 - < std::complex< T > >
- IntIdentity
 
 Template parameters
 <int>
- Invert
 
 An adaptable unary function that returns the inverse of its argument (1/x).
 Template parameters
 <class T>
- IsArray
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is an array.
 Template parameters
 <class T>
 Specializations
 - < T[]>
- IsBaseOf
 
 A structure whose boolValue member evaluates statically to true if (and only if) Base is a base class of Derived.
 Template parameters
 <class Base, class Derived>
- IsColor
 A type trait for checking the colorness of a type.
 Template parameters
 <class T>
 Specializations
 - < PiiColor4< T > >
 - < PiiColor< T > >
- IsColor3
 Template parameters
 <class T>
 Specializations
 - < PiiColor< T > >
- IsColor4
 Template parameters
 <class T>
 Specializations
 - < PiiColor4< T > >
- IsComplex
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is a complex number (std::complex).
 Template parameters
 <class T>
 Specializations
 - < std::complex< T > >
- IsConst
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is a const type.
 Template parameters
 <class T>
 Specializations
 - < const T >
- IsFloatingPoint
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is a floating point number type.
 Template parameters
 <class T>
 Specializations
- IsInteger
 
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is an integer type (either signed or unsigned).
 Template parameters
 <class T>
- IsNumeric
 
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is a numeric primitive (non-bool) type.
 Template parameters
 <class T>
- IsNumericOrComplex
 
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is a numeric primitive (non-bool) type or a complex number (std::complex).
 Template parameters
 <class T>
- IsPointer
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is a pointer.
 Template parameters
 <class T>
 Specializations
 - < T * >
- IsPrimitive
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is a primitive type.
 Template parameters
 <class T>
 Specializations
 - < bool >
- IsReference
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is a reference.
 Template parameters
 <class T>
 Specializations
 - < T & >
- IsSame
 A tester struct whose boolValue member evaluates statically to true if the template parameters T and U are the same type.
 Template parameters
 <class T, class U>
 Specializations
 - < T, T >
- IsSigned
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is a signed integer type.
 Template parameters
 <class T>
 Specializations
- IsUnsigned
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is an unsigned integer type.
 Template parameters
 <class T>
 Specializations
- Log
 
 An adaptable unary function for calculating the natural logarithm.
 Template parameters
 <class T>
- MatrixRowAdder
 
 A unary function that adds rows to a matrix.
 Template parameters
 <class T>
- Max
 
 An adaptable binary function that returns the maximum of its two arguments.
 Template parameters
 <class T>
- MaxInt
 
 Template parameters
 <int, int>
- Mean
 
 An adaptable unary function that calculates the sum of its arguments in successive calls and records the number of times the function has been called.
 Template parameters
 <class, class>
- Min
 
 An adaptable binary function that returns the minimum of its two arguments.
 Template parameters
 <class T>
- MinInt
 
 Template parameters
 <int, int>
- NoFunction
 
 A unary function (predicate) that always returns false.
 Template parameters
 <class T>
- Not
 
 Logical not operation.
 Template parameters
 <bool>
- NotClass
 
 Logical not operation.
 Template parameters
 <class T>
- Numeric
 
 Utility for miscellaneous numerical property definitions.
 Template parameters
 <class T>
- OnlyComplex
 
 A structure that has a nested type Type if and only if T is a numeric primitive type.
 Template parameters
 <class T>
- OnlyFloatingPoint
 
 A structure that has a nested type Type if and only if T is a floating-point type.
 Template parameters
 <class T>
- OnlyNumeric
 
 A structure that has a nested type Type if and only if T is a numeric primitive type.
 Template parameters
 <class T>
- OnlyNumericOrComplex
 
 A structure that has a nested type Type if and only if T is a numeric primitive type or a complex number.
 Template parameters
 <class T>
- OnlyPrimitive
 
 A structure that has a nested type Type if and only if T is a primitive type.
 Template parameters
 <class T>
- Or
 A template that performs a logical OR operation on its boolean template parameters.
 Template parameters
 <bool, bool, bool, bool, bool, bool, bool>
 Specializations
 - < false, false, false, false, false, false, false >
- Pow
 
 An adaptable binary function that raises its first argument to the power of the second argument.
 Template parameters
 <class T, class U>
- PtrToValue
 A static functor that converts pointers to values and keeps other types as such.
 Template parameters
 <class T>
 Specializations
 - < T * >
- Real
 A unary function that returns the real part of its argument.
 Template parameters
 <class T>
 Specializations
 - < std::complex< T > >
- RealReturnValue
 A trait structure that converts any input type to a real output type.
 Template parameters
 <class T>
 Specializations
 - < float >
- RefToValue
 A static functor that converts references to values and keeps other types as such.
 Template parameters
 <class T>
 Specializations
 - < T & >
- Round
 
 An adaptable unary function that rounds its argument to the closest integer.
 Template parameters
 <class From, class To>
- SelectFirst
 
 A binary function that returns its first argument: f(x,y) = x.
 Template parameters
 <class T, class U>
- SelectSecond
 
 A binary function that returns its second argument: f(x,y) = y.
 Template parameters
 <class T, class U>
- Sign
 
 A unary function that returns the sign (1, 0, or -1) of its argument.
 Template parameters
 <class T>
- Sin
 A unary function that returns sin(x).
 Template parameters
 <class T>
 Specializations
 - < float >
- Sqrt
 A unary function that returns the square root of its argument.
 Template parameters
 <class T>
 Specializations
 - < float >
- Square
 
 An adaptable unary function that returns the square of its argument.
 Template parameters
 <class T>
- SquaredDiff
 
 An adaptable binary function that calculates the squared difference of its arguments, .
 Template parameters
 <class T>
- Tan
 A unary function that returns tan(x).
 Template parameters
 <class T>
 Specializations
 - < float >
- TernaryFunction
 
 A model for an adaptable ternary function.
 Template parameters
 <class, class, class, class>
- ToFloatingPoint
 Converts a type to a corresponding floating-point type.
 Template parameters
 <class T>
 Specializations
- ToNonConst
 A structure whose member type Type is a non-const version of the template parameter T.
 Template parameters
 <class>
 Specializations
 - < const T >
- ToPointer
 A static functor that converts references to pointers and keeps pointers as such.
 Template parameters
 <class T>
 Specializations
 - < T * >
- ToReference
 A static functor that converts pointers to references and keeps references as such.
 Template parameters
 <class T>
 Specializations
 - < T * >
- True
 
 A structure whose constant boolValue member evaluates to true.
- UnaryCompose
 
 A unary function adaptor that makes the result of one unary function the argument of another.
 Template parameters
 <class AdaptableUnaryFunction1, class AdaptableUnaryFunction2>
- UnaryFunction
 
 An stl-compatible model for an adaptable unary function.
 Template parameters
 <class, class>
- VaArg
 Type for values passed through the va_arg mechanism ("..." in function parameters).
 Template parameters
 <class>
 Specializations
- ValueType
 The Type member typedef of this structure maps to the value_type member type of the type given as the template argument.
 Template parameters
 <class T>
 Specializations
 - < T * >
- YesFunction
 
 A unary function (predicate) that always returns true.
 Template parameters
 <class T>
- abs
 A generic template for absolute value.
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
 Overloads
- abs2
 Returns the absolute value ov value squared.
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
 Overloads
 - (const std::complex< T > & value)
- accumulate
 
 Loops through all values in the range [begin, end) and applies func to each element and the current value of initialValue.
 Parameters
 (InputIterator begin, InputIterator end, BinaryFunction func, T initialValue)
- accumulateIf
 
 Loops through all values in the range [begin, end) and applies func to each element and the current value of initialValue, if predicate returns a non-zero value for the element.
 Parameters
 (InputIterator begin, InputIterator end, UnaryPredicate predicate, BinaryFunction func, T initialValue)
- accumulateN
 
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This fuction works in the range [begin, begin + n).
 Parameters
 (InputIterator begin, int n, BinaryFunction func, T initialValue)
- acos
 Parameters
 (T value)
 Overloads
 - (float value)
- alignAddress
 
 Align a memory address.
 Parameters
 (T address, size_t bitMask)
- almostEqual
 Compares each element in the range [begin, end) to the corresponding element in the range starting at begin2.
 Parameters
 (InputIterator1 begin1, InputIterator1 end1, InputIterator2 begin2, typename std::iterator_traits< InputIterator1 >::value_type tolerance)
 Overloads
 - (const PiiConceptualMatrix< Matrix1 > & mat1, const PiiConceptualMatrix< Matrix2 > & mat2, typename Matrix1::value_type tolerance)
- angleDiff
 
 Returns the difference between two angles (in radians).
 Parameters
 (T angle1, T angle2, typename Pii::OnlyFloatingPoint< T >::Type )
- argsToList
 Converts args to to a QVariantList, assuming that each argument is a valid pointer of the type specified by types.
 Parameters
 (const QList< int > & types, void ** args)
 Overloads
 - (int argc, char * argv)
- arrayCopy
 
 Performs array copy of non-overlapping arrays.
 Parameters
 (T * to, const T * from, const size_type itemCount)
- asin
 Parameters
 (float value)
 Overloads
 - (T value)
- atan
 Parameters
 (float value)
 Overloads
 - (T value)
- atan2
 
 A fast (but slower than fastAtan2()) approximation to four-quadrant arctan.
 Parameters
 (float y, float x)
- bdDecompose
 
 Reduces a rectangular matrix to a bidiagonal form.
 Parameters
 (PiiMatrix< Real > & A, PiiMatrix< Real > & tauQ, PiiMatrix< Real > & tauP)
- bdUnpackB
 
 Unpacks the result of bidiagonal decomposition.
 Parameters
 (PiiMatrix< Real > & A)
- bdUnpackDiagonals
 
 Unpacks the result of bidiagonal decomposition.
 Parameters
 (const PiiMatrix< Real > & A, Real * d, Real * e)
- bdUnpackP
 Unpacks the result of bidiagonal decomposition.
 Parameters
 (PiiMatrix< Real > & V, const Real * tauP, const int diagonal, PiiMatrix< Real > & T)
 Overloads
 - (const PiiMatrix< Real > & A, const Real * tauP)
- bdUnpackQ
 Unpacks the result of bidiagonal decomposition.
 Parameters
 (PiiMatrix< Real > & V, const Real * tauQ, const int diagonal, PiiMatrix< Real > & T)
 Overloads
 - (const PiiMatrix< Real > & A, const Real * tauQ)
- calculateArea
 
 Calculates the area of a triangle, given the lenghts of its sides.
 Parameters
 (double a, double b, double c)
- calculateInterveningAngle
 
 Calculates the angle between sides a and b, given the known lengths of the sides and the angle opposite to side a.
 Parameters
 (double a, double b, double angle)
- calculateOppositeAngle
 
 Calculates the angle opposite to side a, given the known lengths of all sides of a triangle.
 Parameters
 (double a, double b, double c)
- calculateThirdSide
 
 Calculates the length of the third side of a triangle, given the lengths of two adjacent sides and the angle between them.
 Parameters
 (double a, double b, double angle)
- ceil
 Returns ceil(value).
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
 Overloads
 - (float value)
- centralDiff
 
 Calculates two-point central difference.
 Parameters
 (const PiiMatrix & mat, MatrixDirection direction)
- collectionToVariants
 
 Convert any collection to a QVariantList that contains the same values as QVariant objects.
 Parameters
 (const Collection & lst)
- columnToList
 
 Get a column from a matrix as a collection (QList, QVector)
 Parameters
 (const PiiMatrix< T > & matrix, int column)
- combinations
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 Parameters
 (int n, int k, UnaryFunction func, Storage storage)
 Overloads
 - (int n, int k, UnaryFunction func)
- concatenate
 
 Concatenate two matrices.
 Parameters
 (const PiiConceptualMatrix< Matrix1 > & mat1, const PiiConceptualMatrix< Matrix2 > & mat2, Pii::MatrixDirection direction)
- conj
 Calculates the complex conjugate of a real number.
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
 Overloads
 - (const std::complex< T > & value)
- convertToGray
 
 Converts any color image (rgb/indexed) to gray scale.
 Parameters
 (QImage & img)
- convertToRgba
 
 Converts any image to 32-bit rgb.
 Parameters
 (QImage & img)
- copy
 
 Copies all elements in the range [begin, end) to output.
 Parameters
 (InputIterator begin, InputIterator end, OutputIterator output)
- copyMetaType
 
 Copies the object pointed to by source to the memory location at target.
 Parameters
 (QVariant::Type type, const void * source, void * target)
- copyN
 
 Copies n elements starting at begin to output.
 Parameters
 (InputIterator begin, int n, OutputIterator output)
- copySign
 
 Parameters
 (T value, T sign)
- copyVaArgs
 
 Copies a variable number of arguments to a range of elements bounded by the iterators begin and end.
 Parameters
 (Iterator begin, Iterator end, typename Pii::VaArg< typename std::iterator_traits< Iterator >::value_type >::Type first, ... )
- copyVaList
 
 Copies a variable argument list to a range of elements.
 Parameters
 (Iterator begin, Iterator end, typename Pii::VaArg< typename std::iterator_traits< Iterator >::value_type >::Type first, va_list rest)
- cos
 Returns cos(value).
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
 Overloads
 - (float value)
- countOnes
 Get the number of ones in a binary number.
 Parameters
 (unsigned int c, const unsigned char bits)
 Overloads
 - (unsigned int c)
- countTransitions
 Get the number of 0-to-1 or 1-to-0 transitions in a binary number.
 Parameters
 (unsigned int c, const unsigned char bits)
 Overloads
 - (unsigned int c)
- covariance
 
 Calculates the covariance matrix for a set of measurements.
 Parameters
 (const PiiMatrix< T > & mat, PiiMatrix< double > * mean)
- createQImage
 Parameters
 (PiiMatrix< T > & matrix)
 Overloads
 - (const PiiMatrix< T > & matrix)
 - (const PiiMatrix< PiiColor< T > > & matrix)
- crossProduct
 
 Calculates the cross product of two vectors m1 and m2.
 Parameters
 (const PiiMatrix< T > & m1, const PiiMatrix< T > & m2)
- cumulativeSum
 Calculates two-dimensional cumulative sum of a matrix.
 Parameters
 (const PiiRandomAccessMatrix & matrix, UnaryFunction func, CumulativeSumMode mode)
 Overloads
 - (const PiiRandomAccessMatrix & mat, CumulativeSumMode mode)
 - (const PiiRandomAccessMatrix & mat, MatrixDirection direction)
- decodeProperties
 
 Decode string-encoded properties into a variant map.
 Parameters
 (const QString & encodedProperties, QChar propertySeparator, QChar valueSeparator, QChar escape, PropertyDecodingFlags flags)
- degToRad
 
 Convert an angle from degrees to radians.
 Parameters
 (double deg)
- deleteAll
 
 Delete all members of a collection.
 Parameters
 (Collection & c)
- determinant
 
 calculate the determinant of a matrix.
 Parameters
 (const PiiMatrix< T > & mat)
- determinant2x2
 
 Calculates determinant of 2x2 matrix with direct calculation.
 Parameters
 (const PiiMatrix< T > & m)
- determinant3x3
 
 Calculates determinant of 3x3 matrix with direct calculation.
 Parameters
 (const PiiMatrix< T > & m)
- diff
 
 Difference and approximate derivative.
 Parameters
 (const PiiMatrix< T > & mat, int step, int order, MatrixDirection direction)
- divide
 
 Divide the elements in m1 by the corresponding elements in m2.
 Parameters
 (PiiConceptualMatrix< Matrix1 > & m1, const PiiConceptualMatrix< Matrix2 > & m2)
- divided
 
 Divide the elements in m1 by the corresponding elements in m2.
 Parameters
 (const PiiConceptualMatrix< Matrix1 > & m1, const PiiConceptualMatrix< Matrix2 > & m2)
- epsilon
 
 Calculates the distance from abs(value) to the next real number larger in magnitude.
 Parameters
 (Real value)
- equals
 
 Compare two matrices.
 Parameters
 (const PiiConceptualMatrix< Matrix1 > & mat1, const PiiConceptualMatrix< Matrix2 > & mat2)
- erf
 
 Returns the value of the inverse normal cumulative distribution function (a.k.a the error function, erf) at p.
 Parameters
 (double p)
- exp
 Returns exp(value).
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
 Overloads
 - (float value)
- extend
 Extend a matrix by adding new rows/columns to its sides.
 Parameters
 (const PiiMatrix< T > & mat, int amount, ExtendMode mode, int sides)
 Overloads
 - (const PiiMatrix< T > & mat, int topRows, int bottomRows, int leftCols, int rightCols, ExtendMode mode)
- factorial
 
 Returns the factorial of n (n!).
 Parameters
 (T n)
- fastAtan2
 
 A very fast approximation to four-quadrant arctan.
 Parameters
 (float y, float x)
- fastMedian
 
 Returns the median of all elements in data.
 Parameters
 (Iterator data, int len)
- fastMovingAverage
 Fast 2-D moving average.
 Parameters
 (const PiiMatrix< T > & cumulativeSum, int windowRows, int windowColumns)
 Overloads
 - (InputIterator input, int n, OutputIterator output, int windowSize)
- fileList
 
 Fetch a list of files matching a wildcard.
 Parameters
 (const QString & pattern, QDir::Filters filters, QDir::SortFlags sort)
- fill
 
 Sets all values in the range [begin, end) to value.
 Parameters
 (Iterator begin, Iterator end, typename std::iterator_traits< Iterator >::value_type value)
- fillIf
 
 Sets all values in the range [begin, end) for which predicate returns a non-zero value to value.
 Parameters
 (Iterator begin, Iterator end, UnaryPredicate predicate, typename std::iterator_traits< Iterator >::value_type value)
- fillN
 
 Sets all values in the range [begin, begin + b) to value.
 Parameters
 (Iterator begin, int n, typename std::iterator_traits< Iterator >::value_type value)
- find
 Find the row and column coordinates of all elements in mat that match predicate.
 Parameters
 (const PiiMatrix< T > & mat, UnaryPredicate predicate, int cnt)
 Overloads
 - (const PiiMatrix< T > & mat, int cnt)
- findAllParents
 
 Find all parent objects of obj up to maxParents parent objects.
 Parameters
 (const QObject * obj, unsigned int maxParents)
- findCommonParent
 
 Find the object that is the closest common ancestor of obj1 and obj2 in the object hierarchy.
 Parameters
 (const QObject * obj1, const QObject * obj2, int * parentIndex)
- findFirst
 Find the first occurrence of an element that matches Rule.
 Parameters
 (const PiiMatrix< T > & matrix, T value, int & r, int & c)
 Overloads
 - (const PiiMatrix< T > & matrix, T value, int & r, int & c)
- findFirstParent
 
 Find the first parent of obj whose type matches T.
 Parameters
 (const QObject * obj)
- findLast
 Find the last occurrence (bottom to top, right to left) of value in matrix.
 Parameters
 (const PiiMatrix< T > & matrix, T value, int & r, int & c)
 Overloads
 - (const PiiMatrix< T > & matrix, T value, int & r, int & c)
- findMaxima
 
 Find cnt largest values in mat.
 Parameters
 (const PiiMatrix< T > & mat, int cnt)
- findMinima
 
 Find cnt smallest values in mat.
 Parameters
 (const PiiMatrix< T > & mat, int cnt)
- findNeighbors
 
 Recursively connects neighbors given as a list of pairs.
 Parameters
 (QLinkedList< QPair< int, int > > & pairs)
- findSeparator
 
 Returns the index of the first occurrence of separator in str, starting at startIndex.
 Parameters
 (const QString & str, QChar separator, int startIndex, QChar escape)
- findSpecialValue
 
 Find a special value such as maximum or minimum in the range specified by begin and end.
 Parameters
 (InputIterator begin, InputIterator end, BinaryPredicate op, UnaryFunction f)
- firstOneBit
 
 Find the index of the first bit set to one.
 Parameters
 (T c)
- fitPolynomial
 
 Fit a polynomial curve to data.
 Parameters
 (unsigned int order, const PiiMatrix< double > & x, const PiiMatrix< double > & y)
- flip
 
 Flip matrix in place either horizontally, vertically or both.
 Parameters
 (PiiMatrix< T > & matrix, Pii::MatrixDirections directions)
- flipped
 
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function doesn't modify the source matrix, but returns a copy.
 Parameters
 (const PiiMatrix< T > & mat, Pii::MatrixDirections directions)
- floatSignBit
 Returns the sign bit of value1 - value2.
 Parameters
 (double value1, float value2)
 Overloads
 - (T value1, float value2)
- floor
 Returns floor(value).
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
 Overloads
 - (float value)
- forEach
 
 Applies func to each element in the range [begin, end).
 Parameters
 (InputIterator begin, InputIterator end, UnaryFunction func)
- forEachIf
 
 Applies func to each element in the range [begin, end) for which predicate returns a non-zero value.
 Parameters
 (InputIterator begin, InputIterator end, UnaryPredicate predicate, UnaryFunction func)
- gaussian
 
 A Gaussian function.
 Parameters
 (T x, double mu, double sigma)
- gcd
 
 Find the greatest common divisor (gcd) for the given two numbers using Euclid's algorithm.
 Parameters
 (T number1, T number2)
- generate
 
 Sets all values in the range [begin, end) to the value returned by generator.
 Parameters
 (Iterator begin, Iterator end, Generator generator)
- generateN
 
 Sets all values in the range [begin, begin + n) to the value returned by generatore.
 Parameters
 (Iterator begin, int n, Generator generator)
- grayColorTable
 
 Returns a color table with shades of gray from zero to 255.
- hammingDistance
 Calculate the Hamming distance between two binary numbers.
 Parameters
 (unsigned int a, unsigned int b, const unsigned char bits)
 Overloads
 - (unsigned int a, unsigned int b)
- householderTransform
 
 Generates an elementary reflector (a.k.a the Householder transformation).
 Parameters
 (Iterator x, int n, typename std::iterator_traits< Iterator >::value_type * tau, typename std::iterator_traits< Iterator >::value_type * beta)
- hypotenuse
 
 Calculates the hypotenuse given two orthogonal sides of a triangle.
 Parameters
 (T a, T b)
- imag
 Returns the imaginary part of a real number, i.e.
 Parameters
 (T , typename OnlyNumeric< T >::Type )
 Overloads
 - (const std::complex< T > & value)
- innerProduct
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 Parameters
 (const PiiVector< T, D > & v1, const PiiVector< T, D > & v2)
 Overloads
- innerProductN
 
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Returns the inner product of two n-dimensional vectors.
 Parameters
 (InputIterator1 begin1, int n, InputIterator2 begin2, T initialValue)
- insertionSort
 
 Classical insertion sort.
 Parameters
 (T * data, int size)
- intersect
 
 Find the intersection of two lists.
 Parameters
 (const Collection & list1, const Collection & list2)
- inverse
 
 Invert a matrix.
 Parameters
 (const PiiMatrix< T > & mat)
- isAntiSymmetric
 
 Tests if a matrix is antisymmetric.
 Parameters
 (const PiiMatrix< T > & mat)
- isDiagonal
 
 Test if a matrix is diagonal.
 Parameters
 (const PiiMatrix< T > & mat)
- isInf
 
 Returns true if f equals Inf.
 Parameters
 (T f)
- isNan
 
 Returns true if f is NaN.
 Parameters
 (T f)
- isOrthogonalLike
 Tests whether the given real matrix is "orthogonal-like".
 Parameters
 (const PiiMatrix< T > & mat, const T & tolerance)
 Overloads
 - (const PiiMatrix< T > & mat)
- isParent
 
 Returns true if parent is a parent of child.
 Parameters
 (const QObject * parent, const QObject * child)
- isSingular
 
 Test if a matrix is singular.
 Parameters
 (const PiiMatrix< T > & mat)
- isSquare
 
 Tests whether the given matrix is square matrix.
 Parameters
 (const PiiMatrix< T > & mat)
- isSymmetric
 
 Test if a matrix is symmetric about the diagonal.
 Parameters
 (const PiiMatrix< T > & mat)
- join
 
 Find the union of two lists.
 Parameters
 (const Collection & list1, const Collection & list2)
- kthSmallest
 
 Returns the k:th smallest element from array.
 Parameters
 (T * data, int size, int k)
- lastOneBit
 
 Find the index of the last bit set to one.
 Parameters
 (T c)
- listToMatrix
 
 Converts a collection to a row matrix.
 Parameters
 (const Collection & lst, Pii::MatrixDirection direction)
- listToVariants
 
 Convert a QList to a QVariantList that contains the same values as QVariant objects.
 Parameters
 (const QList< T > & lst)
- log
 Returns log(value).
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
 Overloads
 - (float value)
- map
 Applies a unary function func to all elements in the range [begin, end), and stores the result in place.
 Parameters
 (Iterator begin, Iterator end, UnaryFunction func)
 Overloads
 - (Iterator1 begin1, Iterator1 end1, Iterator2 begin2, BinaryFunction func)
- mapIf
 
 Applies a unary function func to all elements in the range [begin, end) for which predicate returns a non-zero value.
 Parameters
 (Iterator begin, Iterator end, UnaryPredicate predicate, UnaryFunction func)
- mapMatrix
 
 Applies the unary function func to all elements of matrix.
 Parameters
 (PiiConceptualMatrix< Matrix > & matrix, UnaryFunction func)
- mapMatrixIf
 
 Applies the unary function func to all elements of matrix that match the given predicate.
 Parameters
 (PiiConceptualMatrix< Matrix > & matrix, UnaryPredicate predicate, UnaryFunction func)
- mapN
 Applies a binary function func to all elements in the range [begin1, begin1 + n), and stores the result in place.
 Parameters
 (Iterator1 begin1, int n, Iterator2 begin2, BinaryFunction func)
 Overloads
 - (Iterator begin, int n, UnaryFunction func)
- mappedMatrix
 
 Applies the unary function func to all elements of matrix.
 Parameters
 (PiiConceptualMatrix< Matrix > & matrix, UnaryFunction func)
- mappedMatrixIf
 
 Applies the unary function func to all elements of matrix that match the given predicate.
 Parameters
 (const PiiConceptualMatrix< Matrix > & matrix, UnaryPredicate predicate, UnaryFunction func)
- matchCrontab
 
 Match a list of crontab-like strings against the given time stamp.
 Parameters
 (QStringList list, QDateTime timeStamp)
- matlabParse
 
 Parse a string that describes a matrix in Matlab syntax.
 Parameters
 (const QString & str)
- matlabPrint
 
 Print out a matrix in a matlab-friendly format.
 Parameters
 (Stream & out, const PiiConceptualMatrix< Matrix, RandomAccessMatrix > & mat)
- matrix
 
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This specialization just returns mat.
 Parameters
 (const PiiMatrix< T > & mat)
- max
 Calculates the maximum among all elements in the specified direction.
 Parameters
 (const PiiMatrix< T > & mat, MatrixDirection direction)
 Overloads
- maxAbsAll
 
 Like maxAll(), but finds the maximum absolute value.
 Parameters
 (const PiiMatrix< T > & mat, int * r, int * c)
- maxAll
 Shorthand for maxAll(collection.begin(), collection.end()).
 Parameters
 (const Collection & collection)
 Overloads
 - (InputIterator begin, InputIterator end)
 - (const PiiMatrix< T > & mat, int * r, int * c)
- mean
 
 Calculates the mean of matrix elements in the specified direction.
 Parameters
 (const PiiRandomAccessMatrix & mat, MatrixDirection direction)
- meanAll
 
 Calculates the mean of all entries in a matrix.
 Parameters
 (const PiiConceptualMatrix< Matrix > & mat)
- median
 
 Returns the median of all elements in data.
 Parameters
 (Iterator data, int len)
- median25
 
 Median of 25 values optimized to the theoretical maximum efficiency.
 Parameters
 (Iterator data)
- median3
 
 Median of three values optimized to the theoretical maximum efficiency.
 Parameters
 (Iterator data)
- median5
 
 Median of five values optimized to the theoretical maximum efficiency.
 Parameters
 (Iterator data)
- median7
 
 Median of seven values optimized to the theoretical maximum efficiency.
 Parameters
 (Iterator data)
- median9
 
 Median of nine values optimized to the theoretical maximum efficiency.
 Parameters
 (Iterator data)
- medianAll
 
 Returns the median of all elements in mat.
 Parameters
 (const PiiMatrix< T > & mat)
- min
 Calculates the minimum among all elements in the specified direction.
 Parameters
 (const PiiMatrix< T > & mat, MatrixDirection direction)
 Overloads
- minAll
 Calculates the minimum of all elements in a matrix.
 Parameters
 (const PiiMatrix< T > & mat, int * r, int * c)
 Overloads
 - (InputIterator begin, InputIterator end)
 - (const Collection & collection)
- minMax
 
 Find the maximum and maximum of all elements in a matrix.
 Parameters
 (const PiiMatrix< T > & mat, T * minimum, T * maximum, int * minR, int * minC, int * maxR, int * maxC)
- mod
 
 Returns the "modulus" of a floating point number.
 Parameters
 (T d1, T d2, typename OnlyFloatingPoint< T >::Type )
- movingAverage
 Calculates the moving average of a sequence bounded by begin and end.
 Parameters
 (Iterator begin, Iterator end, int width)
 Overloads
 - (const PiiMatrix & mat, int width, MatrixDirection direction, EndPointHandling endPointHandling)
- multiplied
 
 Multiplies the elements in m1 and m2.
 Parameters
 (const PiiConceptualMatrix< Matrix1 > & m1, const PiiConceptualMatrix< Matrix2 > & m2)
- multiply
 Multiply the elements in m1 by the corresponding elements in m2.
 Parameters
 (PiiConceptualMatrix< Matrix1 > & m1, const PiiConceptualMatrix< Matrix2 > & m2)
 Overloads
 - (const PiiMatrix< T > & matrix, InputIterator input, OutputIterator output)
 - (InputIterator input, const PiiMatrix< T > & matrix, OutputIterator output)
- normalize
 
 Normalizes vectors in a matrix.
 Parameters
 (PiiRandomAccessMatrix & mat, MatrixDirection direction)
- normalized
 
 Normalizes vectors in a matrix.
 Parameters
 (const PiiRandomAccessMatrix & mat, MatrixDirection direction)
- normalRandom
 
 Returns a random number from a distribution that follows N(0,1) (zero mean, unit variance Gaussian distribution).
- normalRandomMatrix
 
 Returns a rows x columns matrix filled with normally distributed random numbers.
 Parameters
 (int rows, int columns)
- operator<<
 
 Write a QString to an std output stream.
 Parameters
 (std::ostream & out, const QString & str)
- parseTypes
 
 Converts comma-separated type names to a list of type IDs.
 Parameters
 (const QByteArray & types)
- partition
 
 Returns array which is arranged so that; there exist index k which value is restricted to 0 <= k < size.
 Parameters
 (T * data, int size, int pivot)
- pcaDecorrelate
 
 Decorrelates a possibly correlated set of data.
 Parameters
 (const PiiRandomAccessMatrix & X)
- permutations
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 Parameters
 (int n, UnaryFunction func, Storage storage)
 Overloads
 - (int n, UnaryFunction func)
- PII_DECLARE_EXPORTED_FUNCTION_TEMPLATE
 Parameters
 (void , setProperties< QSettings > , (QObject &obj, const QStringList &properties, const QSettings &valueMap, Qt::CaseSensitivity sensitivity, const QString &commentMark) , PII_BUILDING_CORE )
 Overloads
 - (void , setProperties< QVariantMap > , (QObject &obj, const QStringList &properties, const QVariantMap &valueMap, Qt::CaseSensitivity sensitivity, const QString &commentMark) , PII_BUILDING_CORE )
- PII_MATH_MATRIX_TRANSFORM
 Returns a matrix whose elements are absolute values of mat squared.
 Parameters
 (abs2 , Abs2 )
 Overloads
 - (abs , Abs )
- pow
 Raise value to an integer power (n).
 Parameters
 (T value, int n, typename OnlyNumeric< T >::Type )
 Overloads
 - (double value, double n)
 - (float value, float n)
- principalComponents
 
 Returns the PCA base vectors for a data set in X.
 Parameters
 (const PiiRandomAccessMatrix & X, PiiMatrix< typename Matrix::value_type > * S)
- printMatrix
 
 Print matrix in a user-defined format.
 Parameters
 (Stream & out, const PiiConceptualMatrix< Matrix, RandomAccessMatrix > & mat, const ColSeparator & columnSeparator, const RowSeparator & rowSeparator)
- properties
 
 Fetch the properties of a QObject as a map of name-value pairs.
 Parameters
 (const QObject & obj, int propertyOffset, PropertyFlags flags)
- propertyList
 
 Returns the properties of obj as a list.
 Parameters
 (const QObject & obj, int propertyOffset, PropertyFlags flags)
- propertyName
 
 Finds the name of a property in obj that matches name in a case-insensitive manner.
 Parameters
 (const QObject & obj, const QString & name)
- pseudoInverse
 
 Returns the Moore-Penrose pseudoinverse of an m-by-n matrix.
 Parameters
 (const PiiRandomAccessMatrix & A)
- Q_DECLARE_FLAGS
 Parameters
 (MatrixDirections , MatrixDirection )
 Overloads
 - (SvdOptions , SvdOption )
 - (PropertyFlags , PropertyFlag )
- Q_FLAGS
 
 Parameters
 (MatrixDirection MatrixDirections)
- qHash
 
 Hash function for null-terminated C strings.
 Parameters
 (const char * key)
- qrDecompose
 QR decomposition.
 Parameters
 (PiiRandomAccessMatrix & A, PiiMatrix< typename Matrix::value_type > & tau)
 Overloads
 - (PiiRandomAccessMatrix & A, typename Matrix::value_type * tau, typename Matrix::value_type * bfr)
 - (const PiiRandomAccessMatrix & A, PiiMatrix< typename Matrix::value_type > * R, QrUnpackStyle style)
- qrUnpack
 Unpacks the result of QR decomposition.
 Parameters
 (PiiMatrix< Real > & A, const Real * tau, PiiMatrix< Real > & T, PiiMatrix< Real > & gram)
 Overloads
 - (PiiMatrix< Real > & A, const PiiMatrix< Real > & tau, PiiMatrix< Real > * R, QrUnpackStyle style)
- radToDeg
 
 Convert an angle from radians to degrees.
 Parameters
 (double rad)
- randomizeMatrix
 
 Set random elements from range specified by parameters lowerBound and upperBound to matrix.
 Parameters
 (PiiMatrix< T > & mat, const T & lowerBound, const T & upperBound)
- rank
 
 Estimates the number of linearly independent rows or columns of a matrix.
 Parameters
 (const PiiRandomAccessMatrix & mat, typename Matrix::value_type tolerance)
- real
 Returns the real part of a complex number.
 Parameters
 (const std::complex< T > & value)
 Overloads
 - (T value, typename OnlyNumeric< T >::Type )
- reflectColumns
 Applies a reflection transform to a rectangular matrix from the left.
 Parameters
 (PiiConceptualMatrix< Matrix, Pii::RandomAccessMatrix > & A, InputIterator v, typename Matrix::value_type tau, typename Matrix::value_type * bfr)
 Overloads
 - (PiiConceptualMatrix< Matrix, Pii::RandomAccessMatrix > & A, InputIterator v, typename Matrix::value_type tau)
- reflectRows
 
 Applies a reflection transform to a rectangular matrix from the right.
 Parameters
 (PiiConceptualMatrix< Matrix, Pii::RandomAccessMatrix > & A, InputIterator v, typename Matrix::value_type tau)
- replaceVariables
 
 Replaces variables in string and returns a new string.
 Parameters
 (const QString & string, const VariableMap & variables)
- replicate
 
 Replicate a matrix vertical times vertically and horizontal times horizontally.
 Parameters
 (const PiiMatrix< T > & matrix, int vertical, int horizontal)
- rol
 Parameters
 (unsigned short c, const unsigned char n)
 Overloads
- rol< INTBITS >
 
 Parameters
 (unsigned int c, const unsigned char n)
- ror
 Rotate a binary code right by n positions.
 Parameters
 (unsigned int c, const unsigned char n, const unsigned char bits)
 Overloads
- ror< INTBITS >
 
 Parameters
 (unsigned int c, const unsigned char n)
- rotateColumns
 
 Parameters
 (mat , 0 , 1 )
- rotateToMinimum
 Rotate a binary number to its minimum value.
 Parameters
 (unsigned int n, const unsigned char bits)
 Overloads
 - (unsigned int n)
- round
 Rounds a double argument to the closest integer.
 Parameters
 (double value)
 Overloads
 - (T value, typename OnlyNumeric< T >::Type )
- rowToList
 
 Get a row from a matrix as a collection (QList, QVector)
 Parameters
 (const PiiMatrix< T > & matrix, int row)
- scoreOverload
 
 Returns a numerical score for the goodness of a parameter set given a list of expected types.
 Parameters
 (const QVariantList & params, const QList< int > & types)
- seedRandom
 Seeds the random number generator with your favourite value.
 Parameters
 (long value)
 Overloads
 - ()
- selectRandomly
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Randomly selects n distinct integers in [0, max-1] and stores them to indices.
 Parameters
 (QVector< int > & indices, int n, int max)
 Overloads
 - (Collection & target, const Collection & source, int n)
 - (int n, int max)
- sequence
 Assigns sequentially increasing values to the range [begin, end).
 Parameters
 (Iterator begin, Iterator end, typename std::iterator_traits< Iterator >::value_type initialValue)
 Overloads
 - (Iterator begin, Iterator end, typename std::iterator_traits< Iterator >::value_type initialValue, typename std::iterator_traits< Iterator >::value_type step)
- sequenceN
 Assigns sequentially increasing values to the range [begin, end + n).
 Parameters
 (Iterator begin, int n, typename std::iterator_traits< Iterator >::value_type initialValue)
 Overloads
 - (Iterator begin, int n, typename std::iterator_traits< Iterator >::value_type initialValue, typename std::iterator_traits< Iterator >::value_type step)
- setDiagonal
 
 Sets diagonal entries in matrix to the values read from vector.
 Parameters
 (PiiRandomAccessMatrix & matrix, Iterator vector)
- setIdentity
 
 Sets diagonal entries in matrix to ones and other entries to zero.
 Parameters
 (PiiRandomAccessMatrix & matrix)
- setProperties
 Sets many properties in a bunch.
 Parameters
 (QObject & obj, const QVariantMap & lstProperties)
 Overloads
 - (QObject & obj, const QStringList & properties, const Map & valueMap, Qt::CaseSensitivity sensitivity, const QString & commentMark)
- setPropertyList
 
 Parameters
 (QObject & obj, const QList< QPair< QString, QVariant > > & lstProperties)
- setValueAt
 
 Parameters
 (T value, PiiMatrix< T > & img, double dr, double dc)
- shuffle
 Randomize the order of elements in a collection.
 Parameters
 (Collection & lst)
 Overloads
 - (Iterator begin, Iterator end)
- shuffleN
 
 Randomize the order of elements in a sequence.
 Parameters
 (Iterator begin, PII_DIFF_TYPE n)
- sign
 
 Returns the sign of value.
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
- signBit
 Returns the sign bit of value1 - value2.
 Parameters
 (T value1, T value2)
 Overloads
 - (float value1, float value2)
 - (double value1, double value2)
- signMask
 Get a binary mask for the sign bit of any integer type.
 Overloads
 - ()
- sin
 Parameters
 (float value)
 Overloads
 - (T value, typename OnlyNumeric< T >::Type )
- sortedRows
 Sort matrix rows.
 Parameters
 (const PiiMatrix< T > & matrix, int column)
 Overloads
 - (const PiiMatrix< T > & matrix, LessThan lessThan, int column)
- sortRows
 
 Sort matrix rows into ascending order based on the value on the specified column.
 Parameters
 (PiiMatrix< T > & matrix, LessThan lessThan, int column)
- splitQuoted
 
 Splits a string in which each part may be quoted.
 Parameters
 (const QString & str, QChar separator, QChar quote, QString::SplitBehavior behavior)
- sqrt
 Returns the square root of value.
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
 Overloads
 - (float value)
- square
 
 Returns the value * value.
 Parameters
 (T value, typename OnlyNumericOrComplex< T >::Type )
- stdAll
 
 Calculates the standard deviation over all elements in a matrix.
 Parameters
 (const PiiMatrix< T > & mat, U * mean)
- stringTo
 
 Convert a string to any type.
 Parameters
 (const QString & number, bool * ok)
- stringTo< double >
 
 Parameters
 (const QString & number, bool * ok)
- stringTo< float >
 
 Parameters
 (const QString & number, bool * ok)
- stringTo< int >
 
 Parameters
 (const QString & number, bool * ok)
- stringTo< long >
 
 Parameters
 (const QString & number, bool * ok)
- stringTo< long long >
 
 Parameters
 (const QString & number, bool * ok)
- stringTo< short >
 
 Parameters
 (const QString & number, bool * ok)
- stringTo< unsigned int >
 
 Parameters
 (const QString & number, bool * ok)
- stringTo< unsigned long >
 
 Parameters
 (const QString & number, bool * ok)
- stringTo< unsigned long long >
 
 Parameters
 (const QString & number, bool * ok)
- stringTo< unsigned short >
 
 Parameters
 (const QString & number, bool * ok)
- subtract
 
 Create a list that consists of the elements of list1 that are not present in list2.
 Parameters
 (const Collection & list1, const Collection & list2)
- subtractMean
 
 Subtracts sample mean from a data set.
 Parameters
 (PiiRandomAccessMatrix & matrix, Pii::MatrixDirection direction)
- sum
 
 Calculates the sum of matrix elements in the specified direction.
 Parameters
 (const PiiRandomAccessMatrix & mat, MatrixDirection direction)
- sumAll
 
 Calculates the sum of all entries in a matrix.
 Parameters
 (const PiiConceptualMatrix< Matrix > & mat)
- swap
 
 Parameters
 (Iterator1 begin1, Iterator1 end1, Iterator2 begin2)
- swapN
 
 Parameters
 (Iterator1 begin1, int n, Iterator2 begin2)
- tan
 Returns tan(value).
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
 Overloads
 - (float value)
- toDouble
 
 Converts a string into a number.
 Parameters
 (const QString & number, bool * ok)
- transform
 Applies a binary function func to all elements in the range [begin1, end1), using the corresponding element in the range starting at begin2 as the second argument to the function.
 Parameters
 (InputIterator1 begin1, InputIterator1 end1, InputIterator2 begin2, OutputIterator output, BinaryFunction func)
 Overloads
 - (InputIterator begin, InputIterator end, OutputIterator output, UnaryFunction func)
- transformColumns
 
 Performs func on each column of the given matrix.
 Parameters
 (PiiConceptualMatrix< Matrix, RandomAccessMatrix > & matrix, InputIterator input, BinaryFunction func)
- transformedColumns
 
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Returns a new matrix.
 Parameters
 (const PiiRandomAccessMatrix & matrix, InputIterator input, BinaryFunction func)
- transformedRows
 
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Returns a new matrix.
 Parameters
 (const PiiConceptualMatrix< Matrix, RandomAccessMatrix > & matrix, InputIterator input, BinaryFunction func)
- transformN
 Applies a unary function func to all elements in the range [begin, begin + n), and stores the returned value to output.
 Parameters
 (InputIterator begin, int n, OutputIterator output, UnaryFunction func)
 Overloads
 - (InputIterator1 begin1, int n, InputIterator2 begin2, OutputIterator output, BinaryFunction func)
- transformRows
 
 Performs func on each row of the given matrix.
 Parameters
 (PiiConceptualMatrix< Matrix, RandomAccessMatrix > & matrix, InputIterator input, BinaryFunction func)
- uniformRandom
 Returns a uniformly distributed random number in [0,1].
 Overloads
 - (double min, double max)
- uniformRandomMatrix
 Returns a rows x columns matrix filled with uniformly distributed random numbers in [0,1].
 Parameters
 (int rows, int columns)
 Overloads
 - (int rows, int columns, double min, double max)
- unpackReflectors
 
 Unpacks a matrix in which a series of elementary reflections are represented as row or column vectors.
 Parameters
 (MatrixDirection direction, const PiiConceptualMatrix< Matrix, RandomAccessMatrix > & V, const typename Matrix::value_type * tau, PiiMatrix< typename Matrix::value_type > & T, PiiMatrix< typename Matrix::value_type > & gram, int diagonal)
- valueAt
 Sample a matrix (typically an image) at continuous positions.
 Parameters
 (const PiiMatrix< T > & img, double dr, double dc)
 Overloads
 - (const PiiMatrix< T > & img, int r, int c)
- var
 
 Calculates the variance of matrix elements in the specified direction.
 Parameters
 (const PiiMatrix< T > & mat, MatrixDirection direction)
- varAll
 
 Calculates the variance over all elements in a matrix.
 Parameters
 (const PiiMatrix< T > & mat, U * mean)
- variantsToList
 
 Converts a list of QVariant objects into a QList of type T.
 Parameters
 (const QVariantList & variants)
- variantsToVector
 
 Convert a list of QVariant objects into a QVector of type T.
 Parameters
 (const QVariantList & variants)
- vectorToVariants
 
 Convert a QVector to a QVariantList that contains the same values as QVariant objects.
 Parameters
 (const QVector< T > & lst)
- windowSum
 
 Calculates the sum of neighbors in a sequence bounded by begin and end.
 Parameters
 (Iterator begin, Iterator end, int width, UnaryFunction function)
▶
Other classes
- PiiArithmeticBase
  A template that adds support for arithmetic operators for any data structure that can be iterated over.
- PiiAsyncCall
  A utility class for calling functions asynchronously.
- PiiBinaryFunctionIterator
  An iterator that uses two iterators in parallel and transforms their values using a binary function.
- PiiCircle
  Stores the center and radius of a circle.
- PiiColor
  A three-channel color.
- PiiColor4
  A four-channel color.
- PiiColor4Traits
  Type information structure for PiiColor4.
- PiiColorBase
  A structure that represents a three-channel color.
- PiiColorBaseTraits
  Type information structure for PiiColorBase.
- PiiColorTraits
  Type information structure for PiiColor.
- PiiConfigurable
  This is an interface class, which can be used for setting and getting the configuration values for the class inherited from this interface.
- PiiConstCharWrapper
  A wrapper structure for const char pointers that can be used with QHash and QMap as a light-weight replacement for QString.
- PiiDefaultConfigurable
  This class adds to the base class PiiConfigurable some functionality related to handling the meta configuration information.
- PiiDelay
  A utility class that reveals the protected msleep() member of QThread so that program flow can be delayed anywhere.
- PiiEventProcessor
  A home-made event loop.
- PiiEventProcessorRunner
  A utility class that automatically starts the event processing thread upon construction and stops it when destructed.
- PiiException
  PiiException is the base class of all exceptions.
- PiiFifoBuffer
  A first in first out I/O device.
- PiiFilteredIterator
  An iterator that picks selected elements out of another iterator.
- PiiFixedPoint
  A replacement for float/double numbers.
- PiiFraction
  A template class that represents fractions.
- PiiInvalidArgumentException
  An exception for situations in which invalid arguments were used in a function or constructor call.
- PiiIOException
  An exception for input/output errors.
- PiiMathException
  PiiMathException is thrown when errors occur in calculations.
- PiiMetaConfigurationValue
  This class provides meta information about a configuration value in the class derived from the interface class PiiConfigurable.
- PiiPoint
  A two-dimensional point.
- PiiProgressController
  An interface for objects that control the functioning of operations that take a long time.
- PiiQImage
  A matrix that shares data with a QImage, and an image that shares data with a PiiMatrix.
- PiiReadWriteLock
  A read-write lock.
- PiiRectangle
  Stores the upper left corner and the size of a rectangle.
- PiiResourceDatabase
  A database that stores statements about resources.
- PiiResourceStatement
  A class used by PiiResourceDatabase to store statements about resources.
- PiiSharedObject
  A shared object.
- PiiSharedPtr
  An implicitly shared pointer.
- PiiSimpleMemoryManager
  A simple segregated storage.
- PiiSize
  Stores the width and height of an area.
- PiiSmartPtr
  A utility class that works as a simple alternative to std::auto_ptr.
- PiiTimer
  PiiTimer uses QTime to achieve microsecond-resolution timing of intervals.
- PiiUnaryFunctionIterator
  An iterator that transforms another iterator using a unary function.
- PiiUndoCommandProducer
  An interface for UI components that support undo/redo functionality.
- PiiUniversalSlot
  An object that can be used as a slot for any signal.
- PiiVariant
  An extensible variant class that can store any data type.
- PiiVector
  A D -dimensional vector.
- PiiVectorTraits
  Type information structure for PiiVector.
- PiiVersionNumber
  A class that can be used to compare version numbers composed of multiple dot-separated parts.
▶
Macros

▶

User interface classes

▶

Matrices and linear algebra

▶
Pii namespace
- Abs
 An adaptable unary function for taking the absolute value.
 Template parameters
 <class T>
 Specializations
 - < std::complex< T > >
- Abs2
 An adaptable unary function for taking the absolute value of the square of a real number.
 Template parameters
 <class T>
 Specializations
 - < std::complex< T > >
- AbsDiff
 
 An adaptable binary function that calculates the absolute difference of its arguments, .
 Template parameters
 <class T>
- AbsPow
 
 An adaptable binary function that raises the absolute value of its first argument to the power of the second argument.
 Template parameters
 <class T, class U, class R>
- AbsSum
 
 An adaptable binary function that calculates the sum of absolute values, .
 Template parameters
 <class T>
- Acos
 A unary function that returns acos(x).
 Template parameters
 <class T>
 Specializations
 - < float >
- And
 A template that performs a logical AND operation on its boolean template parameters.
 Template parameters
 <bool, bool, bool, bool, bool, bool, bool>
 Specializations
 - < true, true, true, true, true, true, true >
- Asin
 A unary function that returns asin(x).
 Template parameters
 <class T>
 Specializations
 - < float >
- Atan
 A unary function that returns tan(x).
 Template parameters
 <class T>
 Specializations
 - < float >
- Atan2
 An adaptable binary function that calculates the arc tangent of two variables.
 Template parameters
 <class T>
 Specializations
 - < float >
- BinaryAnd
 
 An adaptable binary functor that performs the binary AND operation.
 Template parameters
 <class T>
- BinaryCompose
 
 A unary/binary function adaptor that makes the results of two unary functions the arguments of a binary function.
 Template parameters
 <class AdaptableBinaryFunction, class AdaptableUnaryFunction1, class AdaptableUnaryFunction2>
- BinaryFunction
 
 An stl-compatible model for an adaptable binary function.
 Template parameters
 <class, class, class>
- BinaryNot
 
 An adaptable binary unary functor that performs the binary NOT operation.
 Template parameters
 <class T>
- BinaryOr
 
 An adaptable binary functor that performs the binary OR operation.
 Template parameters
 <class T>
- BinaryShiftLeft
 
 An adaptable binary binary functor that shifts the left operand left as many times as indicated by the right operand.
 Template parameters
 <class T>
- BinaryShiftRight
 
 An adaptable binary binary functor that shifts the left operand right as many times as indicated by the right operand.
 Template parameters
 <class T>
- BinaryXor
 
 An adaptable binary functor that performs the binary XOR operation.
 Template parameters
 <class T>
- Bound
 
 A unary function that bounds its argument to a predefined range.
 Template parameters
 <class T>
- Cast
 
 An adaptable unary function that casts its argument from type From to type To.
 Template parameters
 <class From, class To>
- Ceil
 
 A unary function that returns ceil(x).
 Template parameters
 <class T>
- Conj
 
 An adaptable unary function that returns the complex conjugate of a real number (which is the argument itself) or a complex number.
 Template parameters
 <class T>
- Cos
 A unary function that returns cos(x).
 Template parameters
 <class T>
 Specializations
 - < float >
- CountFunction
 
 A unary function that increments/decrements its internal counter by a predefined value each time the function is called.
 Template parameters
 <class T>
- EigenSystem
 
 Implements eigenvalue calculations and stores the results of the calculations (eigenvalues and eigenvectors).
 Template parameters
 <class tT, class tReal>
- Empty
 
 An empty structure.
- Exp
 
 An adaptable unary function for calculating the base-e exponential.
 Template parameters
 <class T>
- False
 
 A structure whose constant boolValue member evaluates to false.
- FastAtan2
 
 An adaptable binary function that uses a fast approximation (0.01 rad accuracy) to calculate the arc tangent of two variables.
 Template parameters
 <class T>
- FastestAtan2
 
 An adaptable binar function that uses a very fast but crude approximation (0.07 rad accuracy) to calculate the arc tangent of two variables.
 Template parameters
 <class T>
- Floor
 
 A unary function that returns floor(x).
 Template parameters
 <class T>
- ForEachFunction
 
 Helper function for algorithms that involve scrolling elements.
 Template parameters
 <class FuItem, class FuMemory>
- Generator
 
 An stl-compatible model for a generator function that takes no arguments.
 Template parameters
 <class>
- Hypotenuse
 An adaptable binary function that calculates the hypotenuse given two orthogonal sides of a triangle, .
 Template parameters
 <class T>
 Specializations
 - < int >
- Id
 
 A structure whose nested type, Type, is T.
 Template parameters
 <class T>
- Identity
 
 A unary function that returns its argument: f(x) = x.
 Template parameters
 <class T>
- IeeeFloat
 
 A class that wraps a floating-point number and allows one to twiddle its bits.
 Template parameters
 <class >
- IeeeFloatTraits< double >
 A traits structure that specifies the bit counts and corresponding integer types for the double type.
 Specializations
 - < double >
 - < float >
- If
 A conditional template.
 Template parameters
 <bool, class, class>
 Specializations
 - < false, Then, Else >
- IfClass
 
 A conditional template that accepts a type name as the condition parameter.
 Template parameters
 <class Condition, class Then, class Else>
- Imag
 A unary function that returns the imaginary part of its argument.
 Template parameters
 <class T>
 Specializations
 - < std::complex< T > >
- IntIdentity
 
 Template parameters
 <int>
- Invert
 
 An adaptable unary function that returns the inverse of its argument (1/x).
 Template parameters
 <class T>
- IsArray
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is an array.
 Template parameters
 <class T>
 Specializations
 - < T[]>
- IsBaseOf
 
 A structure whose boolValue member evaluates statically to true if (and only if) Base is a base class of Derived.
 Template parameters
 <class Base, class Derived>
- IsColor
 A type trait for checking the colorness of a type.
 Template parameters
 <class T>
 Specializations
 - < PiiColor4< T > >
 - < PiiColor< T > >
- IsColor3
 Template parameters
 <class T>
 Specializations
 - < PiiColor< T > >
- IsColor4
 Template parameters
 <class T>
 Specializations
 - < PiiColor4< T > >
- IsComplex
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is a complex number (std::complex).
 Template parameters
 <class T>
 Specializations
 - < std::complex< T > >
- IsConst
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is a const type.
 Template parameters
 <class T>
 Specializations
 - < const T >
- IsFloatingPoint
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is a floating point number type.
 Template parameters
 <class T>
 Specializations
- IsInteger
 
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is an integer type (either signed or unsigned).
 Template parameters
 <class T>
- IsNumeric
 
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is a numeric primitive (non-bool) type.
 Template parameters
 <class T>
- IsNumericOrComplex
 
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is a numeric primitive (non-bool) type or a complex number (std::complex).
 Template parameters
 <class T>
- IsPointer
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is a pointer.
 Template parameters
 <class T>
 Specializations
 - < T * >
- IsPrimitive
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is a primitive type.
 Template parameters
 <class T>
 Specializations
 - < bool >
- IsReference
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is a reference.
 Template parameters
 <class T>
 Specializations
 - < T & >
- IsSame
 A tester struct whose boolValue member evaluates statically to true if the template parameters T and U are the same type.
 Template parameters
 <class T, class U>
 Specializations
 - < T, T >
- IsSigned
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is a signed integer type.
 Template parameters
 <class T>
 Specializations
- IsUnsigned
 A tester struct whose boolValue member evaluates statically to true if the template parameter T is an unsigned integer type.
 Template parameters
 <class T>
 Specializations
- Log
 
 An adaptable unary function for calculating the natural logarithm.
 Template parameters
 <class T>
- MatrixRowAdder
 
 A unary function that adds rows to a matrix.
 Template parameters
 <class T>
- Max
 
 An adaptable binary function that returns the maximum of its two arguments.
 Template parameters
 <class T>
- MaxInt
 
 Template parameters
 <int, int>
- Mean
 
 An adaptable unary function that calculates the sum of its arguments in successive calls and records the number of times the function has been called.
 Template parameters
 <class, class>
- Min
 
 An adaptable binary function that returns the minimum of its two arguments.
 Template parameters
 <class T>
- MinInt
 
 Template parameters
 <int, int>
- NoFunction
 
 A unary function (predicate) that always returns false.
 Template parameters
 <class T>
- Not
 
 Logical not operation.
 Template parameters
 <bool>
- NotClass
 
 Logical not operation.
 Template parameters
 <class T>
- Numeric
 
 Utility for miscellaneous numerical property definitions.
 Template parameters
 <class T>
- OnlyComplex
 
 A structure that has a nested type Type if and only if T is a numeric primitive type.
 Template parameters
 <class T>
- OnlyFloatingPoint
 
 A structure that has a nested type Type if and only if T is a floating-point type.
 Template parameters
 <class T>
- OnlyNumeric
 
 A structure that has a nested type Type if and only if T is a numeric primitive type.
 Template parameters
 <class T>
- OnlyNumericOrComplex
 
 A structure that has a nested type Type if and only if T is a numeric primitive type or a complex number.
 Template parameters
 <class T>
- OnlyPrimitive
 
 A structure that has a nested type Type if and only if T is a primitive type.
 Template parameters
 <class T>
- Or
 A template that performs a logical OR operation on its boolean template parameters.
 Template parameters
 <bool, bool, bool, bool, bool, bool, bool>
 Specializations
 - < false, false, false, false, false, false, false >
- Pow
 
 An adaptable binary function that raises its first argument to the power of the second argument.
 Template parameters
 <class T, class U>
- PtrToValue
 A static functor that converts pointers to values and keeps other types as such.
 Template parameters
 <class T>
 Specializations
 - < T * >
- Real
 A unary function that returns the real part of its argument.
 Template parameters
 <class T>
 Specializations
 - < std::complex< T > >
- RealReturnValue
 A trait structure that converts any input type to a real output type.
 Template parameters
 <class T>
 Specializations
 - < float >
- RefToValue
 A static functor that converts references to values and keeps other types as such.
 Template parameters
 <class T>
 Specializations
 - < T & >
- Round
 
 An adaptable unary function that rounds its argument to the closest integer.
 Template parameters
 <class From, class To>
- SelectFirst
 
 A binary function that returns its first argument: f(x,y) = x.
 Template parameters
 <class T, class U>
- SelectSecond
 
 A binary function that returns its second argument: f(x,y) = y.
 Template parameters
 <class T, class U>
- Sign
 
 A unary function that returns the sign (1, 0, or -1) of its argument.
 Template parameters
 <class T>
- Sin
 A unary function that returns sin(x).
 Template parameters
 <class T>
 Specializations
 - < float >
- Sqrt
 A unary function that returns the square root of its argument.
 Template parameters
 <class T>
 Specializations
 - < float >
- Square
 
 An adaptable unary function that returns the square of its argument.
 Template parameters
 <class T>
- SquaredDiff
 
 An adaptable binary function that calculates the squared difference of its arguments, .
 Template parameters
 <class T>
- Tan
 A unary function that returns tan(x).
 Template parameters
 <class T>
 Specializations
 - < float >
- TernaryFunction
 
 A model for an adaptable ternary function.
 Template parameters
 <class, class, class, class>
- ToFloatingPoint
 Converts a type to a corresponding floating-point type.
 Template parameters
 <class T>
 Specializations
- ToNonConst
 A structure whose member type Type is a non-const version of the template parameter T.
 Template parameters
 <class>
 Specializations
 - < const T >
- ToPointer
 A static functor that converts references to pointers and keeps pointers as such.
 Template parameters
 <class T>
 Specializations
 - < T * >
- ToReference
 A static functor that converts pointers to references and keeps references as such.
 Template parameters
 <class T>
 Specializations
 - < T * >
- True
 
 A structure whose constant boolValue member evaluates to true.
- UnaryCompose
 
 A unary function adaptor that makes the result of one unary function the argument of another.
 Template parameters
 <class AdaptableUnaryFunction1, class AdaptableUnaryFunction2>
- UnaryFunction
 
 An stl-compatible model for an adaptable unary function.
 Template parameters
 <class, class>
- VaArg
 Type for values passed through the va_arg mechanism ("..." in function parameters).
 Template parameters
 <class>
 Specializations
- ValueType
 The Type member typedef of this structure maps to the value_type member type of the type given as the template argument.
 Template parameters
 <class T>
 Specializations
 - < T * >
- YesFunction
 
 A unary function (predicate) that always returns true.
 Template parameters
 <class T>
- abs
 A generic template for absolute value.
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
 Overloads
- abs2
 Returns the absolute value ov value squared.
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
 Overloads
 - (const std::complex< T > & value)
- accumulate
 
 Loops through all values in the range [begin, end) and applies func to each element and the current value of initialValue.
 Parameters
 (InputIterator begin, InputIterator end, BinaryFunction func, T initialValue)
- accumulateIf
 
 Loops through all values in the range [begin, end) and applies func to each element and the current value of initialValue, if predicate returns a non-zero value for the element.
 Parameters
 (InputIterator begin, InputIterator end, UnaryPredicate predicate, BinaryFunction func, T initialValue)
- accumulateN
 
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This fuction works in the range [begin, begin + n).
 Parameters
 (InputIterator begin, int n, BinaryFunction func, T initialValue)
- acos
 Parameters
 (T value)
 Overloads
 - (float value)
- alignAddress
 
 Align a memory address.
 Parameters
 (T address, size_t bitMask)
- almostEqual
 Compares each element in the range [begin, end) to the corresponding element in the range starting at begin2.
 Parameters
 (InputIterator1 begin1, InputIterator1 end1, InputIterator2 begin2, typename std::iterator_traits< InputIterator1 >::value_type tolerance)
 Overloads
 - (const PiiConceptualMatrix< Matrix1 > & mat1, const PiiConceptualMatrix< Matrix2 > & mat2, typename Matrix1::value_type tolerance)
- angleDiff
 
 Returns the difference between two angles (in radians).
 Parameters
 (T angle1, T angle2, typename Pii::OnlyFloatingPoint< T >::Type )
- argsToList
 Converts args to to a QVariantList, assuming that each argument is a valid pointer of the type specified by types.
 Parameters
 (const QList< int > & types, void ** args)
 Overloads
 - (int argc, char * argv)
- arrayCopy
 
 Performs array copy of non-overlapping arrays.
 Parameters
 (T * to, const T * from, const size_type itemCount)
- asin
 Parameters
 (float value)
 Overloads
 - (T value)
- atan
 Parameters
 (float value)
 Overloads
 - (T value)
- atan2
 
 A fast (but slower than fastAtan2()) approximation to four-quadrant arctan.
 Parameters
 (float y, float x)
- bdDecompose
 
 Reduces a rectangular matrix to a bidiagonal form.
 Parameters
 (PiiMatrix< Real > & A, PiiMatrix< Real > & tauQ, PiiMatrix< Real > & tauP)
- bdUnpackB
 
 Unpacks the result of bidiagonal decomposition.
 Parameters
 (PiiMatrix< Real > & A)
- bdUnpackDiagonals
 
 Unpacks the result of bidiagonal decomposition.
 Parameters
 (const PiiMatrix< Real > & A, Real * d, Real * e)
- bdUnpackP
 Unpacks the result of bidiagonal decomposition.
 Parameters
 (PiiMatrix< Real > & V, const Real * tauP, const int diagonal, PiiMatrix< Real > & T)
 Overloads
 - (const PiiMatrix< Real > & A, const Real * tauP)
- bdUnpackQ
 Unpacks the result of bidiagonal decomposition.
 Parameters
 (PiiMatrix< Real > & V, const Real * tauQ, const int diagonal, PiiMatrix< Real > & T)
 Overloads
 - (const PiiMatrix< Real > & A, const Real * tauQ)
- calculateArea
 
 Calculates the area of a triangle, given the lenghts of its sides.
 Parameters
 (double a, double b, double c)
- calculateInterveningAngle
 
 Calculates the angle between sides a and b, given the known lengths of the sides and the angle opposite to side a.
 Parameters
 (double a, double b, double angle)
- calculateOppositeAngle
 
 Calculates the angle opposite to side a, given the known lengths of all sides of a triangle.
 Parameters
 (double a, double b, double c)
- calculateThirdSide
 
 Calculates the length of the third side of a triangle, given the lengths of two adjacent sides and the angle between them.
 Parameters
 (double a, double b, double angle)
- ceil
 Returns ceil(value).
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
 Overloads
 - (float value)
- centralDiff
 
 Calculates two-point central difference.
 Parameters
 (const PiiMatrix & mat, MatrixDirection direction)
- collectionToVariants
 
 Convert any collection to a QVariantList that contains the same values as QVariant objects.
 Parameters
 (const Collection & lst)
- columnToList
 
 Get a column from a matrix as a collection (QList, QVector)
 Parameters
 (const PiiMatrix< T > & matrix, int column)
- combinations
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 Parameters
 (int n, int k, UnaryFunction func, Storage storage)
 Overloads
 - (int n, int k, UnaryFunction func)
- concatenate
 
 Concatenate two matrices.
 Parameters
 (const PiiConceptualMatrix< Matrix1 > & mat1, const PiiConceptualMatrix< Matrix2 > & mat2, Pii::MatrixDirection direction)
- conj
 Calculates the complex conjugate of a real number.
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
 Overloads
 - (const std::complex< T > & value)
- convertToGray
 
 Converts any color image (rgb/indexed) to gray scale.
 Parameters
 (QImage & img)
- convertToRgba
 
 Converts any image to 32-bit rgb.
 Parameters
 (QImage & img)
- copy
 
 Copies all elements in the range [begin, end) to output.
 Parameters
 (InputIterator begin, InputIterator end, OutputIterator output)
- copyMetaType
 
 Copies the object pointed to by source to the memory location at target.
 Parameters
 (QVariant::Type type, const void * source, void * target)
- copyN
 
 Copies n elements starting at begin to output.
 Parameters
 (InputIterator begin, int n, OutputIterator output)
- copySign
 
 Parameters
 (T value, T sign)
- copyVaArgs
 
 Copies a variable number of arguments to a range of elements bounded by the iterators begin and end.
 Parameters
 (Iterator begin, Iterator end, typename Pii::VaArg< typename std::iterator_traits< Iterator >::value_type >::Type first, ... )
- copyVaList
 
 Copies a variable argument list to a range of elements.
 Parameters
 (Iterator begin, Iterator end, typename Pii::VaArg< typename std::iterator_traits< Iterator >::value_type >::Type first, va_list rest)
- cos
 Returns cos(value).
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
 Overloads
 - (float value)
- countOnes
 Get the number of ones in a binary number.
 Parameters
 (unsigned int c, const unsigned char bits)
 Overloads
 - (unsigned int c)
- countTransitions
 Get the number of 0-to-1 or 1-to-0 transitions in a binary number.
 Parameters
 (unsigned int c, const unsigned char bits)
 Overloads
 - (unsigned int c)
- covariance
 
 Calculates the covariance matrix for a set of measurements.
 Parameters
 (const PiiMatrix< T > & mat, PiiMatrix< double > * mean)
- createQImage
 Parameters
 (PiiMatrix< T > & matrix)
 Overloads
 - (const PiiMatrix< T > & matrix)
 - (const PiiMatrix< PiiColor< T > > & matrix)
- crossProduct
 
 Calculates the cross product of two vectors m1 and m2.
 Parameters
 (const PiiMatrix< T > & m1, const PiiMatrix< T > & m2)
- cumulativeSum
 Calculates two-dimensional cumulative sum of a matrix.
 Parameters
 (const PiiRandomAccessMatrix & matrix, UnaryFunction func, CumulativeSumMode mode)
 Overloads
 - (const PiiRandomAccessMatrix & mat, CumulativeSumMode mode)
 - (const PiiRandomAccessMatrix & mat, MatrixDirection direction)
- decodeProperties
 
 Decode string-encoded properties into a variant map.
 Parameters
 (const QString & encodedProperties, QChar propertySeparator, QChar valueSeparator, QChar escape, PropertyDecodingFlags flags)
- degToRad
 
 Convert an angle from degrees to radians.
 Parameters
 (double deg)
- deleteAll
 
 Delete all members of a collection.
 Parameters
 (Collection & c)
- determinant
 
 calculate the determinant of a matrix.
 Parameters
 (const PiiMatrix< T > & mat)
- determinant2x2
 
 Calculates determinant of 2x2 matrix with direct calculation.
 Parameters
 (const PiiMatrix< T > & m)
- determinant3x3
 
 Calculates determinant of 3x3 matrix with direct calculation.
 Parameters
 (const PiiMatrix< T > & m)
- diff
 
 Difference and approximate derivative.
 Parameters
 (const PiiMatrix< T > & mat, int step, int order, MatrixDirection direction)
- divide
 
 Divide the elements in m1 by the corresponding elements in m2.
 Parameters
 (PiiConceptualMatrix< Matrix1 > & m1, const PiiConceptualMatrix< Matrix2 > & m2)
- divided
 
 Divide the elements in m1 by the corresponding elements in m2.
 Parameters
 (const PiiConceptualMatrix< Matrix1 > & m1, const PiiConceptualMatrix< Matrix2 > & m2)
- epsilon
 
 Calculates the distance from abs(value) to the next real number larger in magnitude.
 Parameters
 (Real value)
- equals
 
 Compare two matrices.
 Parameters
 (const PiiConceptualMatrix< Matrix1 > & mat1, const PiiConceptualMatrix< Matrix2 > & mat2)
- erf
 
 Returns the value of the inverse normal cumulative distribution function (a.k.a the error function, erf) at p.
 Parameters
 (double p)
- exp
 Returns exp(value).
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
 Overloads
 - (float value)
- extend
 Extend a matrix by adding new rows/columns to its sides.
 Parameters
 (const PiiMatrix< T > & mat, int amount, ExtendMode mode, int sides)
 Overloads
 - (const PiiMatrix< T > & mat, int topRows, int bottomRows, int leftCols, int rightCols, ExtendMode mode)
- factorial
 
 Returns the factorial of n (n!).
 Parameters
 (T n)
- fastAtan2
 
 A very fast approximation to four-quadrant arctan.
 Parameters
 (float y, float x)
- fastMedian
 
 Returns the median of all elements in data.
 Parameters
 (Iterator data, int len)
- fastMovingAverage
 Fast 2-D moving average.
 Parameters
 (const PiiMatrix< T > & cumulativeSum, int windowRows, int windowColumns)
 Overloads
 - (InputIterator input, int n, OutputIterator output, int windowSize)
- fileList
 
 Fetch a list of files matching a wildcard.
 Parameters
 (const QString & pattern, QDir::Filters filters, QDir::SortFlags sort)
- fill
 
 Sets all values in the range [begin, end) to value.
 Parameters
 (Iterator begin, Iterator end, typename std::iterator_traits< Iterator >::value_type value)
- fillIf
 
 Sets all values in the range [begin, end) for which predicate returns a non-zero value to value.
 Parameters
 (Iterator begin, Iterator end, UnaryPredicate predicate, typename std::iterator_traits< Iterator >::value_type value)
- fillN
 
 Sets all values in the range [begin, begin + b) to value.
 Parameters
 (Iterator begin, int n, typename std::iterator_traits< Iterator >::value_type value)
- find
 Find the row and column coordinates of all elements in mat that match predicate.
 Parameters
 (const PiiMatrix< T > & mat, UnaryPredicate predicate, int cnt)
 Overloads
 - (const PiiMatrix< T > & mat, int cnt)
- findAllParents
 
 Find all parent objects of obj up to maxParents parent objects.
 Parameters
 (const QObject * obj, unsigned int maxParents)
- findCommonParent
 
 Find the object that is the closest common ancestor of obj1 and obj2 in the object hierarchy.
 Parameters
 (const QObject * obj1, const QObject * obj2, int * parentIndex)
- findFirst
 Find the first occurrence of an element that matches Rule.
 Parameters
 (const PiiMatrix< T > & matrix, T value, int & r, int & c)
 Overloads
 - (const PiiMatrix< T > & matrix, T value, int & r, int & c)
- findFirstParent
 
 Find the first parent of obj whose type matches T.
 Parameters
 (const QObject * obj)
- findLast
 Find the last occurrence (bottom to top, right to left) of value in matrix.
 Parameters
 (const PiiMatrix< T > & matrix, T value, int & r, int & c)
 Overloads
 - (const PiiMatrix< T > & matrix, T value, int & r, int & c)
- findMaxima
 
 Find cnt largest values in mat.
 Parameters
 (const PiiMatrix< T > & mat, int cnt)
- findMinima
 
 Find cnt smallest values in mat.
 Parameters
 (const PiiMatrix< T > & mat, int cnt)
- findNeighbors
 
 Recursively connects neighbors given as a list of pairs.
 Parameters
 (QLinkedList< QPair< int, int > > & pairs)
- findSeparator
 
 Returns the index of the first occurrence of separator in str, starting at startIndex.
 Parameters
 (const QString & str, QChar separator, int startIndex, QChar escape)
- findSpecialValue
 
 Find a special value such as maximum or minimum in the range specified by begin and end.
 Parameters
 (InputIterator begin, InputIterator end, BinaryPredicate op, UnaryFunction f)
- firstOneBit
 
 Find the index of the first bit set to one.
 Parameters
 (T c)
- fitPolynomial
 
 Fit a polynomial curve to data.
 Parameters
 (unsigned int order, const PiiMatrix< double > & x, const PiiMatrix< double > & y)
- flip
 
 Flip matrix in place either horizontally, vertically or both.
 Parameters
 (PiiMatrix< T > & matrix, Pii::MatrixDirections directions)
- flipped
 
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function doesn't modify the source matrix, but returns a copy.
 Parameters
 (const PiiMatrix< T > & mat, Pii::MatrixDirections directions)
- floatSignBit
 Returns the sign bit of value1 - value2.
 Parameters
 (double value1, float value2)
 Overloads
 - (T value1, float value2)
- floor
 Returns floor(value).
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
 Overloads
 - (float value)
- forEach
 
 Applies func to each element in the range [begin, end).
 Parameters
 (InputIterator begin, InputIterator end, UnaryFunction func)
- forEachIf
 
 Applies func to each element in the range [begin, end) for which predicate returns a non-zero value.
 Parameters
 (InputIterator begin, InputIterator end, UnaryPredicate predicate, UnaryFunction func)
- gaussian
 
 A Gaussian function.
 Parameters
 (T x, double mu, double sigma)
- gcd
 
 Find the greatest common divisor (gcd) for the given two numbers using Euclid's algorithm.
 Parameters
 (T number1, T number2)
- generate
 
 Sets all values in the range [begin, end) to the value returned by generator.
 Parameters
 (Iterator begin, Iterator end, Generator generator)
- generateN
 
 Sets all values in the range [begin, begin + n) to the value returned by generatore.
 Parameters
 (Iterator begin, int n, Generator generator)
- grayColorTable
 
 Returns a color table with shades of gray from zero to 255.
- hammingDistance
 Calculate the Hamming distance between two binary numbers.
 Parameters
 (unsigned int a, unsigned int b, const unsigned char bits)
 Overloads
 - (unsigned int a, unsigned int b)
- householderTransform
 
 Generates an elementary reflector (a.k.a the Householder transformation).
 Parameters
 (Iterator x, int n, typename std::iterator_traits< Iterator >::value_type * tau, typename std::iterator_traits< Iterator >::value_type * beta)
- hypotenuse
 
 Calculates the hypotenuse given two orthogonal sides of a triangle.
 Parameters
 (T a, T b)
- imag
 Returns the imaginary part of a real number, i.e.
 Parameters
 (T , typename OnlyNumeric< T >::Type )
 Overloads
 - (const std::complex< T > & value)
- innerProduct
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 Parameters
 (const PiiVector< T, D > & v1, const PiiVector< T, D > & v2)
 Overloads
- innerProductN
 
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Returns the inner product of two n-dimensional vectors.
 Parameters
 (InputIterator1 begin1, int n, InputIterator2 begin2, T initialValue)
- insertionSort
 
 Classical insertion sort.
 Parameters
 (T * data, int size)
- intersect
 
 Find the intersection of two lists.
 Parameters
 (const Collection & list1, const Collection & list2)
- inverse
 
 Invert a matrix.
 Parameters
 (const PiiMatrix< T > & mat)
- isAntiSymmetric
 
 Tests if a matrix is antisymmetric.
 Parameters
 (const PiiMatrix< T > & mat)
- isDiagonal
 
 Test if a matrix is diagonal.
 Parameters
 (const PiiMatrix< T > & mat)
- isInf
 
 Returns true if f equals Inf.
 Parameters
 (T f)
- isNan
 
 Returns true if f is NaN.
 Parameters
 (T f)
- isOrthogonalLike
 Tests whether the given real matrix is "orthogonal-like".
 Parameters
 (const PiiMatrix< T > & mat, const T & tolerance)
 Overloads
 - (const PiiMatrix< T > & mat)
- isParent
 
 Returns true if parent is a parent of child.
 Parameters
 (const QObject * parent, const QObject * child)
- isSingular
 
 Test if a matrix is singular.
 Parameters
 (const PiiMatrix< T > & mat)
- isSquare
 
 Tests whether the given matrix is square matrix.
 Parameters
 (const PiiMatrix< T > & mat)
- isSymmetric
 
 Test if a matrix is symmetric about the diagonal.
 Parameters
 (const PiiMatrix< T > & mat)
- join
 
 Find the union of two lists.
 Parameters
 (const Collection & list1, const Collection & list2)
- kthSmallest
 
 Returns the k:th smallest element from array.
 Parameters
 (T * data, int size, int k)
- lastOneBit
 
 Find the index of the last bit set to one.
 Parameters
 (T c)
- listToMatrix
 
 Converts a collection to a row matrix.
 Parameters
 (const Collection & lst, Pii::MatrixDirection direction)
- listToVariants
 
 Convert a QList to a QVariantList that contains the same values as QVariant objects.
 Parameters
 (const QList< T > & lst)
- log
 Returns log(value).
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
 Overloads
 - (float value)
- map
 Applies a unary function func to all elements in the range [begin, end), and stores the result in place.
 Parameters
 (Iterator begin, Iterator end, UnaryFunction func)
 Overloads
 - (Iterator1 begin1, Iterator1 end1, Iterator2 begin2, BinaryFunction func)
- mapIf
 
 Applies a unary function func to all elements in the range [begin, end) for which predicate returns a non-zero value.
 Parameters
 (Iterator begin, Iterator end, UnaryPredicate predicate, UnaryFunction func)
- mapMatrix
 
 Applies the unary function func to all elements of matrix.
 Parameters
 (PiiConceptualMatrix< Matrix > & matrix, UnaryFunction func)
- mapMatrixIf
 
 Applies the unary function func to all elements of matrix that match the given predicate.
 Parameters
 (PiiConceptualMatrix< Matrix > & matrix, UnaryPredicate predicate, UnaryFunction func)
- mapN
 Applies a binary function func to all elements in the range [begin1, begin1 + n), and stores the result in place.
 Parameters
 (Iterator1 begin1, int n, Iterator2 begin2, BinaryFunction func)
 Overloads
 - (Iterator begin, int n, UnaryFunction func)
- mappedMatrix
 
 Applies the unary function func to all elements of matrix.
 Parameters
 (PiiConceptualMatrix< Matrix > & matrix, UnaryFunction func)
- mappedMatrixIf
 
 Applies the unary function func to all elements of matrix that match the given predicate.
 Parameters
 (const PiiConceptualMatrix< Matrix > & matrix, UnaryPredicate predicate, UnaryFunction func)
- matchCrontab
 
 Match a list of crontab-like strings against the given time stamp.
 Parameters
 (QStringList list, QDateTime timeStamp)
- matlabParse
 
 Parse a string that describes a matrix in Matlab syntax.
 Parameters
 (const QString & str)
- matlabPrint
 
 Print out a matrix in a matlab-friendly format.
 Parameters
 (Stream & out, const PiiConceptualMatrix< Matrix, RandomAccessMatrix > & mat)
- matrix
 
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This specialization just returns mat.
 Parameters
 (const PiiMatrix< T > & mat)
- max
 Calculates the maximum among all elements in the specified direction.
 Parameters
 (const PiiMatrix< T > & mat, MatrixDirection direction)
 Overloads
- maxAbsAll
 
 Like maxAll(), but finds the maximum absolute value.
 Parameters
 (const PiiMatrix< T > & mat, int * r, int * c)
- maxAll
 Shorthand for maxAll(collection.begin(), collection.end()).
 Parameters
 (const Collection & collection)
 Overloads
 - (InputIterator begin, InputIterator end)
 - (const PiiMatrix< T > & mat, int * r, int * c)
- mean
 
 Calculates the mean of matrix elements in the specified direction.
 Parameters
 (const PiiRandomAccessMatrix & mat, MatrixDirection direction)
- meanAll
 
 Calculates the mean of all entries in a matrix.
 Parameters
 (const PiiConceptualMatrix< Matrix > & mat)
- median
 
 Returns the median of all elements in data.
 Parameters
 (Iterator data, int len)
- median25
 
 Median of 25 values optimized to the theoretical maximum efficiency.
 Parameters
 (Iterator data)
- median3
 
 Median of three values optimized to the theoretical maximum efficiency.
 Parameters
 (Iterator data)
- median5
 
 Median of five values optimized to the theoretical maximum efficiency.
 Parameters
 (Iterator data)
- median7
 
 Median of seven values optimized to the theoretical maximum efficiency.
 Parameters
 (Iterator data)
- median9
 
 Median of nine values optimized to the theoretical maximum efficiency.
 Parameters
 (Iterator data)
- medianAll
 
 Returns the median of all elements in mat.
 Parameters
 (const PiiMatrix< T > & mat)
- min
 Calculates the minimum among all elements in the specified direction.
 Parameters
 (const PiiMatrix< T > & mat, MatrixDirection direction)
 Overloads
- minAll
 Calculates the minimum of all elements in a matrix.
 Parameters
 (const PiiMatrix< T > & mat, int * r, int * c)
 Overloads
 - (InputIterator begin, InputIterator end)
 - (const Collection & collection)
- minMax
 
 Find the maximum and maximum of all elements in a matrix.
 Parameters
 (const PiiMatrix< T > & mat, T * minimum, T * maximum, int * minR, int * minC, int * maxR, int * maxC)
- mod
 
 Returns the "modulus" of a floating point number.
 Parameters
 (T d1, T d2, typename OnlyFloatingPoint< T >::Type )
- movingAverage
 Calculates the moving average of a sequence bounded by begin and end.
 Parameters
 (Iterator begin, Iterator end, int width)
 Overloads
 - (const PiiMatrix & mat, int width, MatrixDirection direction, EndPointHandling endPointHandling)
- multiplied
 
 Multiplies the elements in m1 and m2.
 Parameters
 (const PiiConceptualMatrix< Matrix1 > & m1, const PiiConceptualMatrix< Matrix2 > & m2)
- multiply
 Multiply the elements in m1 by the corresponding elements in m2.
 Parameters
 (PiiConceptualMatrix< Matrix1 > & m1, const PiiConceptualMatrix< Matrix2 > & m2)
 Overloads
 - (const PiiMatrix< T > & matrix, InputIterator input, OutputIterator output)
 - (InputIterator input, const PiiMatrix< T > & matrix, OutputIterator output)
- normalize
 
 Normalizes vectors in a matrix.
 Parameters
 (PiiRandomAccessMatrix & mat, MatrixDirection direction)
- normalized
 
 Normalizes vectors in a matrix.
 Parameters
 (const PiiRandomAccessMatrix & mat, MatrixDirection direction)
- normalRandom
 
 Returns a random number from a distribution that follows N(0,1) (zero mean, unit variance Gaussian distribution).
- normalRandomMatrix
 
 Returns a rows x columns matrix filled with normally distributed random numbers.
 Parameters
 (int rows, int columns)
- operator<<
 
 Write a QString to an std output stream.
 Parameters
 (std::ostream & out, const QString & str)
- parseTypes
 
 Converts comma-separated type names to a list of type IDs.
 Parameters
 (const QByteArray & types)
- partition
 
 Returns array which is arranged so that; there exist index k which value is restricted to 0 <= k < size.
 Parameters
 (T * data, int size, int pivot)
- pcaDecorrelate
 
 Decorrelates a possibly correlated set of data.
 Parameters
 (const PiiRandomAccessMatrix & X)
- permutations
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 Parameters
 (int n, UnaryFunction func, Storage storage)
 Overloads
 - (int n, UnaryFunction func)
- PII_DECLARE_EXPORTED_FUNCTION_TEMPLATE
 Parameters
 (void , setProperties< QSettings > , (QObject &obj, const QStringList &properties, const QSettings &valueMap, Qt::CaseSensitivity sensitivity, const QString &commentMark) , PII_BUILDING_CORE )
 Overloads
 - (void , setProperties< QVariantMap > , (QObject &obj, const QStringList &properties, const QVariantMap &valueMap, Qt::CaseSensitivity sensitivity, const QString &commentMark) , PII_BUILDING_CORE )
- PII_MATH_MATRIX_TRANSFORM
 Returns a matrix whose elements are absolute values of mat squared.
 Parameters
 (abs2 , Abs2 )
 Overloads
 - (abs , Abs )
- pow
 Raise value to an integer power (n).
 Parameters
 (T value, int n, typename OnlyNumeric< T >::Type )
 Overloads
 - (double value, double n)
 - (float value, float n)
- principalComponents
 
 Returns the PCA base vectors for a data set in X.
 Parameters
 (const PiiRandomAccessMatrix & X, PiiMatrix< typename Matrix::value_type > * S)
- printMatrix
 
 Print matrix in a user-defined format.
 Parameters
 (Stream & out, const PiiConceptualMatrix< Matrix, RandomAccessMatrix > & mat, const ColSeparator & columnSeparator, const RowSeparator & rowSeparator)
- properties
 
 Fetch the properties of a QObject as a map of name-value pairs.
 Parameters
 (const QObject & obj, int propertyOffset, PropertyFlags flags)
- propertyList
 
 Returns the properties of obj as a list.
 Parameters
 (const QObject & obj, int propertyOffset, PropertyFlags flags)
- propertyName
 
 Finds the name of a property in obj that matches name in a case-insensitive manner.
 Parameters
 (const QObject & obj, const QString & name)
- pseudoInverse
 
 Returns the Moore-Penrose pseudoinverse of an m-by-n matrix.
 Parameters
 (const PiiRandomAccessMatrix & A)
- Q_DECLARE_FLAGS
 Parameters
 (MatrixDirections , MatrixDirection )
 Overloads
 - (SvdOptions , SvdOption )
 - (PropertyFlags , PropertyFlag )
- Q_FLAGS
 
 Parameters
 (MatrixDirection MatrixDirections)
- qHash
 
 Hash function for null-terminated C strings.
 Parameters
 (const char * key)
- qrDecompose
 QR decomposition.
 Parameters
 (PiiRandomAccessMatrix & A, PiiMatrix< typename Matrix::value_type > & tau)
 Overloads
 - (PiiRandomAccessMatrix & A, typename Matrix::value_type * tau, typename Matrix::value_type * bfr)
 - (const PiiRandomAccessMatrix & A, PiiMatrix< typename Matrix::value_type > * R, QrUnpackStyle style)
- qrUnpack
 Unpacks the result of QR decomposition.
 Parameters
 (PiiMatrix< Real > & A, const Real * tau, PiiMatrix< Real > & T, PiiMatrix< Real > & gram)
 Overloads
 - (PiiMatrix< Real > & A, const PiiMatrix< Real > & tau, PiiMatrix< Real > * R, QrUnpackStyle style)
- radToDeg
 
 Convert an angle from radians to degrees.
 Parameters
 (double rad)
- randomizeMatrix
 
 Set random elements from range specified by parameters lowerBound and upperBound to matrix.
 Parameters
 (PiiMatrix< T > & mat, const T & lowerBound, const T & upperBound)
- rank
 
 Estimates the number of linearly independent rows or columns of a matrix.
 Parameters
 (const PiiRandomAccessMatrix & mat, typename Matrix::value_type tolerance)
- real
 Returns the real part of a complex number.
 Parameters
 (const std::complex< T > & value)
 Overloads
 - (T value, typename OnlyNumeric< T >::Type )
- reflectColumns
 Applies a reflection transform to a rectangular matrix from the left.
 Parameters
 (PiiConceptualMatrix< Matrix, Pii::RandomAccessMatrix > & A, InputIterator v, typename Matrix::value_type tau, typename Matrix::value_type * bfr)
 Overloads
 - (PiiConceptualMatrix< Matrix, Pii::RandomAccessMatrix > & A, InputIterator v, typename Matrix::value_type tau)
- reflectRows
 
 Applies a reflection transform to a rectangular matrix from the right.
 Parameters
 (PiiConceptualMatrix< Matrix, Pii::RandomAccessMatrix > & A, InputIterator v, typename Matrix::value_type tau)
- replaceVariables
 
 Replaces variables in string and returns a new string.
 Parameters
 (const QString & string, const VariableMap & variables)
- replicate
 
 Replicate a matrix vertical times vertically and horizontal times horizontally.
 Parameters
 (const PiiMatrix< T > & matrix, int vertical, int horizontal)
- rol
 Parameters
 (unsigned short c, const unsigned char n)
 Overloads
- rol< INTBITS >
 
 Parameters
 (unsigned int c, const unsigned char n)
- ror
 Rotate a binary code right by n positions.
 Parameters
 (unsigned int c, const unsigned char n, const unsigned char bits)
 Overloads
- ror< INTBITS >
 
 Parameters
 (unsigned int c, const unsigned char n)
- rotateColumns
 
 Parameters
 (mat , 0 , 1 )
- rotateToMinimum
 Rotate a binary number to its minimum value.
 Parameters
 (unsigned int n, const unsigned char bits)
 Overloads
 - (unsigned int n)
- round
 Rounds a double argument to the closest integer.
 Parameters
 (double value)
 Overloads
 - (T value, typename OnlyNumeric< T >::Type )
- rowToList
 
 Get a row from a matrix as a collection (QList, QVector)
 Parameters
 (const PiiMatrix< T > & matrix, int row)
- scoreOverload
 
 Returns a numerical score for the goodness of a parameter set given a list of expected types.
 Parameters
 (const QVariantList & params, const QList< int > & types)
- seedRandom
 Seeds the random number generator with your favourite value.
 Parameters
 (long value)
 Overloads
 - ()
- selectRandomly
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Randomly selects n distinct integers in [0, max-1] and stores them to indices.
 Parameters
 (QVector< int > & indices, int n, int max)
 Overloads
 - (Collection & target, const Collection & source, int n)
 - (int n, int max)
- sequence
 Assigns sequentially increasing values to the range [begin, end).
 Parameters
 (Iterator begin, Iterator end, typename std::iterator_traits< Iterator >::value_type initialValue)
 Overloads
 - (Iterator begin, Iterator end, typename std::iterator_traits< Iterator >::value_type initialValue, typename std::iterator_traits< Iterator >::value_type step)
- sequenceN
 Assigns sequentially increasing values to the range [begin, end + n).
 Parameters
 (Iterator begin, int n, typename std::iterator_traits< Iterator >::value_type initialValue)
 Overloads
 - (Iterator begin, int n, typename std::iterator_traits< Iterator >::value_type initialValue, typename std::iterator_traits< Iterator >::value_type step)
- setDiagonal
 
 Sets diagonal entries in matrix to the values read from vector.
 Parameters
 (PiiRandomAccessMatrix & matrix, Iterator vector)
- setIdentity
 
 Sets diagonal entries in matrix to ones and other entries to zero.
 Parameters
 (PiiRandomAccessMatrix & matrix)
- setProperties
 Sets many properties in a bunch.
 Parameters
 (QObject & obj, const QVariantMap & lstProperties)
 Overloads
 - (QObject & obj, const QStringList & properties, const Map & valueMap, Qt::CaseSensitivity sensitivity, const QString & commentMark)
- setPropertyList
 
 Parameters
 (QObject & obj, const QList< QPair< QString, QVariant > > & lstProperties)
- setValueAt
 
 Parameters
 (T value, PiiMatrix< T > & img, double dr, double dc)
- shuffle
 Randomize the order of elements in a collection.
 Parameters
 (Collection & lst)
 Overloads
 - (Iterator begin, Iterator end)
- shuffleN
 
 Randomize the order of elements in a sequence.
 Parameters
 (Iterator begin, PII_DIFF_TYPE n)
- sign
 
 Returns the sign of value.
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
- signBit
 Returns the sign bit of value1 - value2.
 Parameters
 (T value1, T value2)
 Overloads
 - (float value1, float value2)
 - (double value1, double value2)
- signMask
 Get a binary mask for the sign bit of any integer type.
 Overloads
 - ()
- sin
 Parameters
 (float value)
 Overloads
 - (T value, typename OnlyNumeric< T >::Type )
- sortedRows
 Sort matrix rows.
 Parameters
 (const PiiMatrix< T > & matrix, int column)
 Overloads
 - (const PiiMatrix< T > & matrix, LessThan lessThan, int column)
- sortRows
 
 Sort matrix rows into ascending order based on the value on the specified column.
 Parameters
 (PiiMatrix< T > & matrix, LessThan lessThan, int column)
- splitQuoted
 
 Splits a string in which each part may be quoted.
 Parameters
 (const QString & str, QChar separator, QChar quote, QString::SplitBehavior behavior)
- sqrt
 Returns the square root of value.
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
 Overloads
 - (float value)
- square
 
 Returns the value * value.
 Parameters
 (T value, typename OnlyNumericOrComplex< T >::Type )
- stdAll
 
 Calculates the standard deviation over all elements in a matrix.
 Parameters
 (const PiiMatrix< T > & mat, U * mean)
- stringTo
 
 Convert a string to any type.
 Parameters
 (const QString & number, bool * ok)
- stringTo< double >
 
 Parameters
 (const QString & number, bool * ok)
- stringTo< float >
 
 Parameters
 (const QString & number, bool * ok)
- stringTo< int >
 
 Parameters
 (const QString & number, bool * ok)
- stringTo< long >
 
 Parameters
 (const QString & number, bool * ok)
- stringTo< long long >
 
 Parameters
 (const QString & number, bool * ok)
- stringTo< short >
 
 Parameters
 (const QString & number, bool * ok)
- stringTo< unsigned int >
 
 Parameters
 (const QString & number, bool * ok)
- stringTo< unsigned long >
 
 Parameters
 (const QString & number, bool * ok)
- stringTo< unsigned long long >
 
 Parameters
 (const QString & number, bool * ok)
- stringTo< unsigned short >
 
 Parameters
 (const QString & number, bool * ok)
- subtract
 
 Create a list that consists of the elements of list1 that are not present in list2.
 Parameters
 (const Collection & list1, const Collection & list2)
- subtractMean
 
 Subtracts sample mean from a data set.
 Parameters
 (PiiRandomAccessMatrix & matrix, Pii::MatrixDirection direction)
- sum
 
 Calculates the sum of matrix elements in the specified direction.
 Parameters
 (const PiiRandomAccessMatrix & mat, MatrixDirection direction)
- sumAll
 
 Calculates the sum of all entries in a matrix.
 Parameters
 (const PiiConceptualMatrix< Matrix > & mat)
- swap
 
 Parameters
 (Iterator1 begin1, Iterator1 end1, Iterator2 begin2)
- swapN
 
 Parameters
 (Iterator1 begin1, int n, Iterator2 begin2)
- tan
 Returns tan(value).
 Parameters
 (T value, typename OnlyNumeric< T >::Type )
 Overloads
 - (float value)
- toDouble
 
 Converts a string into a number.
 Parameters
 (const QString & number, bool * ok)
- transform
 Applies a binary function func to all elements in the range [begin1, end1), using the corresponding element in the range starting at begin2 as the second argument to the function.
 Parameters
 (InputIterator1 begin1, InputIterator1 end1, InputIterator2 begin2, OutputIterator output, BinaryFunction func)
 Overloads
 - (InputIterator begin, InputIterator end, OutputIterator output, UnaryFunction func)
- transformColumns
 
 Performs func on each column of the given matrix.
 Parameters
 (PiiConceptualMatrix< Matrix, RandomAccessMatrix > & matrix, InputIterator input, BinaryFunction func)
- transformedColumns
 
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Returns a new matrix.
 Parameters
 (const PiiRandomAccessMatrix & matrix, InputIterator input, BinaryFunction func)
- transformedRows
 
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Returns a new matrix.
 Parameters
 (const PiiConceptualMatrix< Matrix, RandomAccessMatrix > & matrix, InputIterator input, BinaryFunction func)
- transformN
 Applies a unary function func to all elements in the range [begin, begin + n), and stores the returned value to output.
 Parameters
 (InputIterator begin, int n, OutputIterator output, UnaryFunction func)
 Overloads
 - (InputIterator1 begin1, int n, InputIterator2 begin2, OutputIterator output, BinaryFunction func)
- transformRows
 
 Performs func on each row of the given matrix.
 Parameters
 (PiiConceptualMatrix< Matrix, RandomAccessMatrix > & matrix, InputIterator input, BinaryFunction func)
- uniformRandom
 Returns a uniformly distributed random number in [0,1].
 Overloads
 - (double min, double max)
- uniformRandomMatrix
 Returns a rows x columns matrix filled with uniformly distributed random numbers in [0,1].
 Parameters
 (int rows, int columns)
 Overloads
 - (int rows, int columns, double min, double max)
- unpackReflectors
 
 Unpacks a matrix in which a series of elementary reflections are represented as row or column vectors.
 Parameters
 (MatrixDirection direction, const PiiConceptualMatrix< Matrix, RandomAccessMatrix > & V, const typename Matrix::value_type * tau, PiiMatrix< typename Matrix::value_type > & T, PiiMatrix< typename Matrix::value_type > & gram, int diagonal)
- valueAt
 Sample a matrix (typically an image) at continuous positions.
 Parameters
 (const PiiMatrix< T > & img, double dr, double dc)
 Overloads
 - (const PiiMatrix< T > & img, int r, int c)
- var
 
 Calculates the variance of matrix elements in the specified direction.
 Parameters
 (const PiiMatrix< T > & mat, MatrixDirection direction)
- varAll
 
 Calculates the variance over all elements in a matrix.
 Parameters
 (const PiiMatrix< T > & mat, U * mean)
- variantsToList
 
 Converts a list of QVariant objects into a QList of type T.
 Parameters
 (const QVariantList & variants)
- variantsToVector
 
 Convert a list of QVariant objects into a QVector of type T.
 Parameters
 (const QVariantList & variants)
- vectorToVariants
 
 Convert a QVector to a QVariantList that contains the same values as QVariant objects.
 Parameters
 (const QVector< T > & lst)
- windowSum
 
 Calculates the sum of neighbors in a sequence bounded by begin and end.
 Parameters
 (Iterator begin, Iterator end, int width, UnaryFunction function)
▶
Other classes
- PiiBinaryMatrixTransform
 A matrix that models the matrix concept by using a binary function that operates on two other matrices.
- PiiConceptualMatrix
 A superclass for classes that implement the matrix concept.
- PiiFilteredMatrix
 A model of the matrix concept that accesses selected elements of another matrix.
- PiiMatrix< T,-1,-1 >
 A two-dimensional array that models the matrix concept.
- PiiMatrixValue
 A structure that stores a value and its location in a matrix.
- PiiPlaneRotation
 Represents a rotation parallel to a plane spanned by two coordinates axes.
- PiiSubmatrix
 A matrix that provides a mutable reference to a PiiMatrix.
- PiiTransposedMatrix
 Transposed matrix.
- PiiTypelessMatrix
 A two-dimensional dynamic array of non-typed data.
- PiiUnaryMatrixTransform
 A matrix that models the matrix concept by applying a unary function to another matrix.

▶

Networking

▶

Base plug-in

▶
Operations
- PiiAbsoluteOperation
  An operation that calculates the absolute value of any numeric or complex type or a matrix containing such types.
- PiiArithmeticOperation
  An operation that performs simple arithmetic like adding and subtracting values.
- PiiAverageOperation
  Calculate the average of all values in a matrix.
- PiiClock
  An operation that emits current time whenever a trigger is received or whenever a timer times out.
- PiiComparisonOperation
  Compare two values and output a binary outcome.
- PiiDebugOperation
  An operation that prints all objects passing through it to the debug console.
- PiiDiffOperation
  Calculates the difference between two successive input objects.
- PiiFileSystemScanner
  Scans directory hierarchies finding files that match filters.
- PiiFileSystemWatcher
  An operation for monitoring directories for new files.
- PiiIdGenerator
  On operation for generating running IDs.
- PiiLogOperation
  An operation that calculates the logarithm of its input.
- PiiLookupTable
  An operation that maps integers into arbitrary data.
- PiiMathematicalFunction
  An operation that applies a mathematical function to its input.
- PiiMatrixCombiner
  An operation that puts multiple matrices into a grid that produces a larger matrix.
- PiiMatrixComposer
  Composes an output matrix from N inputs of primitive data types.
- PiiMatrixDecomposer
  Decomposes input matrix so that each row element corresponds one output.
- PiiMatrixFlipper
  Flip a matrix vertically or horizontally.
- PiiMatrixNormalizer
  Scale the values in a matrix so that its values are limited to a predefined range.
- PiiMinMaxOperation
  Calculates the minimum/maximum of two arguments, or the minimum/maximum value in a matrix.
- PiiMovingAverageOperation
  Calculate the moving average over a window of a predefined size.
- PiiObjectCapturer
  Emits a received objects as a Qt signal.
- PiiObjectCounter
  Counts received objects.
- PiiRegExpMatcher
  An operation that splits strings into pieces based on a regular expression.
- PiiSequenceGenerator
  An operation that generates sequences of numbers.
- PiiStringConverter
  Converts strings to numbers.
- PiiStringFormatter
  An operation that composes formatted strings out of data read from a configurable number of inputs.
- PiiStringizer
  Convert (almost) any type to a string.
- PiiTriggerSource
  A source operation that can be triggered with Qt's signals.
- PiiTypeCastingOperation
  An operation that converts the data type of a matrix.

▶

Calibration plug-in

▶
PiiCalibration namespace
- CameraParameters
 
 A structure that stores all intrinsic camera parameters estimated by the calibration functions.
- RelativePosition
 
 A structure that stores the extrinsic parameters related to a scene viewed.
- calculateCameraPosition
 
 Calculate the position of the camera reference frame with respect to the world coordinate system.
 Parameters
 (const PiiMatrix< double > & worldPoints, const PiiMatrix< double > & imagePoints, const CameraParameters & intrinsic)
- calculateRelativePosition
 
 Calculate the relative position of camera2 with respect to camera1.
 Parameters
 (const RelativePosition & camera1, const RelativePosition & camera2)
- calibrateCamera
 
 Calibrate a camera.
 Parameters
 (const QList< PiiMatrix< double > > & worldPoints, const QList< PiiMatrix< double > > & imagePoints, CameraParameters & intrinsic, QList< RelativePosition > * extrinsic, CalibrationOptions options)
- cameraToPixelCoordinates
 
 Transforms points from camera reference frame to pixel coordinates.
 Parameters
 (const PiiMatrix< double > & points, const CameraParameters & intrinsic)
- cameraToWorldCoordinates
 
 Transform points from camera reference frame to world coordinates.
 Parameters
 (const PiiMatrix< double > & points, const RelativePosition & extrinsic)
- normalizedToPixelCoordinates
 Transforms a point from normalized image coordinates to pixel coordinates.
 Parameters
 (const CameraParameters & intrinsic, double x, double y, double * newX, double * newY)
 Overloads
 - (const PiiMatrix< double > & points, const CameraParameters & intrinsic)
- perspectiveProjection
 
 Perform perspective projection on points.
 Parameters
 (const PiiMatrix< double > & points, double zValue)
- Q_DECLARE_FLAGS
 
 Parameters
 (CalibrationOptions , CalibrationOption )
- rotationMatrixToVector
 
 Convert a rotation matrix to a rotation vector.
 Parameters
 (const PiiMatrix< double > & matrix)
- rotationVectorToMatrix
 
 Convert a rotation vector rotation to a rotation matrix.
 Parameters
 (const PiiVector< double, 3 > & rotation)
- undistort
 Converts pixel coordinates to normalized image coordinates.
 Parameters
 (const CameraParameters & intrinsic, double x, double y, double * newX, double * newY)
 Overloads
 - (const PiiMatrix< double > & distorted, const CameraParameters & intrinsic, double zValue)
- undistortImage
 
 Removes lens distortions from sourceImage.
 Parameters
 (const PiiMatrix< T > & sourceImage, const CameraParameters & intrinsic)
- undistortMap
 
 Creates a coordinate map that converts distorted pixel coordinates to undistorted ones.
 Parameters
 (int rows, int columns, const CameraParameters & intrinsic)
- undistortMapInt
 
 Creates a coordinate map that converts distorted pixel coordinates to undistorted ones.
 Parameters
 (int rows, int columns, const CameraParameters & intrinsic)
- worldToCameraCoordinates
 
 Transform points from world coordinate system to the camera reference frame.
 Parameters
 (const PiiMatrix< double > & points, const RelativePosition & extrinsic)
- worldToPixelCoordinates
 
 Transform points from world coordinates to pixel coordinates.
 Parameters
 (const PiiMatrix< double > & points, const RelativePosition & extrinsic, const CameraParameters & intrinsic)
▶
Operations
- PiiUndistortOperation
  Corrects lens distortion.
▶
Other classes
- PiiCalibrationPointFinder
  A class that can be used to find calibration points in a set of unreliable detections.
- PiiStereoTriangulator
  A class that calculates 3D world coordinates for objects seen from 2 to N viewpoints.

▶

Camera plug-in

▶
PiiCamera namespace
- BayerDecoder
 
 A structure used for handling different Bayer encoding schemes with bayerToRgb().
 Template parameters
 <class, class, class, class, class, class, class, class, class, class, class, class>
- BggrDecoder
 
 Bayer decoding structure for BGGR color ordering.
 Template parameters
 <class T>
- BluePixel
 
 A Bayer decoding functor that extracts the blue channel only.
 Template parameters
 <class T>
- CenterInterpolator
 
 An interpolation functor that always returns the value of the center of a neighborhood without interpolation.
 Template parameters
 <class T>
- DiagonalInterpolator
 
 An interpolation functor that calculates the value of a color channel by averaging the four diagonal neighbors of a pixel.
 Template parameters
 <class T>
- GrayPixel
 
 A Bayer decoding functor that directly converts the image to gray levels by averaging RGB channels.
 Template parameters
 <class T>
- GrbgDecoder
 
 Bayer decoding structure for GRBG color ordering.
 Template parameters
 <class T>
- GreenPixel
 
 A Bayer decoding functor that extracts the green channel only.
 Template parameters
 <class T>
- HorizontalInterpolator
 
 An interpolation functor that calculates the value of a color channel by averaging the two horizontal neighbors of a pixel.
 Template parameters
 <class T>
- NoInterpolator
 
 An interpolation functor that does nothing.
- RedPixel
 
 A Bayer decoding functor that extracts the red channel only.
 Template parameters
 <class T>
- Rgb4Pixel
 
 Four-channel rgb color pixel type functor for Bayer decoding.
 Template parameters
 <class T>
- RgbPixel
 
 Rgb color pixel type functor for Bayer decoding.
 Template parameters
 <class T>
- RggbDecoder
 
 Bayer decoding structure for RGGB color ordering.
 Template parameters
 <class T>
- StraightInterpolator
 
 An interpolation functor that calculates the value of a color channel by averaging the four straight neighbors of a pixel.
 Template parameters
 <class T>
- VerticalInterpolator
 
 An interpolation functor that calculates the value of a color channel by averaging the two vertical neighbors of a pixel.
 Template parameters
 <class T>
- bayerToRgb
 
 Convert a Bayer-encoded color image to RGB colors.
 Parameters
 (const PiiMatrix< T > & encoded, Decoder decoder, Pixel pixel)
- grbgToRgb
 
 A convenience function that decodes a GRBG-encoded 8-bit image into a 32-bit RGB color image.
 Parameters
 (const PiiMatrix< unsigned char > & encoded)
- rggbToRgb
 
 A convenience function that decodes an RGGB-encoded 8-bit image into a 32-bit RGB color image.
 Parameters
 (const PiiMatrix< unsigned char > & encoded)
▶
Operations
- PiiCameraOperation
  PiiCameraOperation description.
- PiiFireWireOperation
  An operation for reading frames from IEEE1394 cameras.
- PiiNetworkCameraOperation
  A camera interface that reads images from a network camera.
▶
Other classes
- PiiCameraDriver
  A common interface for cameras that read images into a frame buffer.
- PiiFireWireInterface
  An interface to IEEE-1394 cameras.
- PiiMultiCamDriver
  An implementation of the PiiCameraDriver interface for EureSys grabber boards.
- PiiSequenceFile
  Stores and restores captured frames to/from a sequence file.
- PiiSequenceFileListener
  A listener for PiiCameraDriver that writes received frames into a sequence file.

▶

Classification plug-in

▶
PiiClassification namespace
- FeatureReader< PiiMatrix< T > >
 
 A function object that reads an input socket and converts the incoming object to a PiiMatrix<T>, if possible.
- adaptVector
 
 Adapt a code vector towards sample with the given strength alpha.
 Parameters
 (FeatureIterator code, ConstFeatureIterator sample, int length, double alpha)
- calculateDistanceMatrix
 
 Generate a distance matrix.
 Parameters
 (const SampleSet & samples, const DistanceMeasure & measure, bool symmetric, bool calculateDiagonal)
- calculateError
 
 Calculates classification error.
 Parameters
 (const QVector< double > & knownLabels, const QVector< double > & hypothesis, const QVector< double > & weights)
- countLabels
 
 Counts the number of distinct labels in labels.
 Parameters
 (const QVector< double > & labels)
- countLabelsInt
 
 Counts the number of distinct integer labels in labels.
 Parameters
 (const QVector< double > & labels)
- createConfusionMatrix
 
 Create a confusion matrix.
 Parameters
 (const QVector< double > & knownLabels, const QVector< double > & hypothesis)
- createDartBoard
 
 Creates a non-linearly separable binary sample set so that the samples in class one are surrounded by those in the other one.
 Parameters
 (int samples1, int samples2, PiiMatrix< double > & samples, QVector< double > & labels)
- createDoubleSpiral
 
 Creates a non-linearly separable sample set in which two classes spiral around each other on a plane.
 Parameters
 (int samplesPerSet, double rounds, PiiMatrix< double > & samples, QVector< double > & labels)
- createRandomSampleSet
 
 Create a random sample set.
 Parameters
 (int samples, int features, double minimum, double maximum)
- fillMissingLabels
 
 Go through the row matrix labels and replace each -1 with the label of the closest code vector in codeBook.
 Parameters
 (const PiiMatrix< int > & labels, const PiiMatrix< T > & codeBook, DistanceMeasure measure)
- findClosestMatch
 
 Find the closest match for sample in modelSet.
 Parameters
 (typename PiiSampleSet::Traits< SampleSet >::ConstFeatureIterator sample, const SampleSet & modelSet, const DistanceMeasure & measure, double * distance)
- findClosestMatches
 
 Find the n closest matches for sample in modelSet.
 Parameters
 (typename PiiSampleSet::Traits< SampleSet >::ConstFeatureIterator sample, const SampleSet & modelSet, const DistanceMeasure & measure, int n)
- kMeans
 
 K-means clustering algorithm.
 Parameters
 (const SampleSet & samples, unsigned int k, const DistanceMeasure & measure, unsigned int maxIterations)
- knnClassify
 
 Classify a sample using the k nearest neighbors rule.
 Parameters
 (typename PiiSampleSet::Traits< SampleSet >::ConstFeatureIterator sample, const SampleSet & modelSet, const QVector< double > & labels, const DistanceMeasure & measure, int k, double * distance, int * closestIndex)
- Q_DECLARE_FLAGS
 
 Parameters
 (LearnerCapabilities , LearnerCapability )
- Q_DECLARE_OPERATORS_FOR_FLAGS
 
 Parameters
 (LearnerCapabilities )
- somHexagonalDistance
 
 Calculate the squared distance between two nodes in a SOM with a hexagonal topology.
 Parameters
 (int bx, int by, int tx, int ty)
- somSquareDistance
 
 Calculate the squared distance between two nodes in a SOM with a square topology.
 Parameters
 (int bx, int by, int tx, int ty)
▶
PiiSampleSet namespace
- Traits< PiiMatrix< T > >
 
 Defines the traits of any PiiMatrix when used as a sample set.
- append
 
 Adds sample to the and of a sample set.
 Parameters
 (PiiMatrix< T > & samples, const T * sample)
- capacity
 
 Returns the number of samples a sample set can hold without reallocation.
 Parameters
 (const PiiMatrix< T > & samples)
- clear
 
 Clears a sample set.
 Parameters
 (PiiMatrix< T > & samples)
- create
 
 Creates a new sample set with sampleCount samples and featureCount features.
 Parameters
 (int sampleCount, int featureCount)
- equals
 
 Returns true if set1 is equal to set2, and false otherwise.
 Parameters
 (PiiMatrix< T > & set1, PiiMatrix< T > & set2)
- featureCount
 
 Returns the number of features in a sample set.
 Parameters
 (const PiiMatrix< T > & samples)
- remove
 
 Removes the sample at index.
 Parameters
 (PiiMatrix< T > & samples, int index)
- reserve
 
 Reserves space for sampleCount samples with featureCount features.
 Parameters
 (PiiMatrix< T > & samples, int sampleCount, int featureCount)
- resize
 
 Resizes a sample set to hold sampleCount samples with featureCount features.
 Parameters
 (PiiMatrix< T > & samples, int sampleCount, int featureCount)
- sampleAt
 Parameters
 (PiiMatrix< T > & samples, int index)
 Overloads
 - (const PiiMatrix< T > & samples, int index)
- sampleCount
 
 Returns the number of samples in a sample set.
 Parameters
 (const PiiMatrix< T > & samples)
- setSampleAt
 
 Replaces the feature vector at index in samples with features.
 Parameters
 (PiiMatrix< T > & samples, int index, const T * features)
▶
Operations
- PiiBoostClassifierOperation
  An operation that classifies samples using a boosted cascade of weak classifiers.
- PiiClassifierOperation
  A superclass for classifier operations.
- PiiClassIndexMapper
  An operation that maps indices into other indices.
- PiiClassInfoMapper
  An operation that maps class indices to arbitrary data.
- PiiConfusionMatrixBuilder
  An operation that builds a confusion matrix out of classification results.
- PiiDistributionNormalizer
  An operation that divides incoming feature vectors by their sum.
- PiiFeatureCombiner
  Feature combiner is an operation that combines feature vectors into a larger compound feature vector.
- PiiKnnClassifierOperation
  An operation that classifies samples according to the k nearest neighbors rule.
- PiiPerceptronOperation
  An Ydin-compatible Perceptron classifier operation.
- PiiSampleBalancer
  An operation that balances training sets by giving more weight to rare samples.
- PiiSampleRandomizer
  An operation that stores names of samples belonging to N different classes.
- PiiSomOperation
  An Ydin-compatible SOM classifier operation.
- PiiTableLabelerOperation
  PiiTableLabelerOperation can be used for classification where the classification rules are given in a table format.
- PiiVectorQuantizerOperation
  A superclass for classifier operations that use classifiers derived from PiiVectorQuantizer.
▶
Other classes
- PiiDistanceMeasure::Impl
  A template that implements the PiiDistanceMeasure interface by using Measure as the distance measure implementation.
- PiiBoostClassifier
  An generic implementation of a boosted classifier.
- PiiClassificationException
  PiiClassificationException is thrown when errors occur in classification.
- PiiClassifier
  An interface for classification and regression algorithms.
- PiiConfusionMatrix
  Confusion matrix is a handy tool for inspecting classification results.
- PiiDecisionStump
  A primitive learner that works by thresholding a single feature.
- PiiDefaultClassifierFactory
  Default implementation of PiiBoostClassifier::Factory.
- PiiGaussianKernel
  Gaussian kernel function.
- PiiKdTree
  K-dimensional tree.
- PiiKernelAdatron
  An implementation of the Kernel Adatron algorithm.
- PiiKernelPerceptron
  An implementation of the Kernel Perceptron algorithm.
- PiiKnnClassifier
  K nearest neighbors classifier.
- PiiLearningAlgorithm
  An interface for learning algorithms.
- PiiMultiFeatureDistance
  A distance measure that combines many distance measures into one.
- PiiPerceptron
  Implementation of the Perceptron algorithm.
- PiiSampleSetCollector
  A learning algorithm that just collects all incoming data into a sample set.
- PiiSom
  An implementation of the self-organizing map (Kohonen map).
- PiiVectorQuantizer
  A vector quantizer.

▶

Colors plug-in

▶
PiiColors namespace
- CorrectGamma
 
 An adaptable binary function that performs gamma correction.
 Template parameters
 <class T>
- CorrectGammaScaled
 
 An adaptable binary function that performs gamma correction on scaled image channels.
 Template parameters
 <class T>
- GenericConversion
 
 An adaptable binary function that multiplies a color with a 3-by-3 matrix.
 Template parameters
 <class Clr>
- HsvToRgb
 
 An adaptable unary function that converts an HSV color to an RGB color.
 Template parameters
 <class Clr>
- LabToXyz
 
 An adaptable binary function that converts an L*a*b* color to an XYZ color, given the white point of the imaging equipment in XYZ.
 Template parameters
 <class Clr>
- LikelihoodFunction
 
 A unary function for converting color distances to "likelihoods".
- ReverseColors
 
 An adaptable unary function that inverses the order of color channels.
 Template parameters
 <class Clr>
- RgbToHsv
 
 An adaptable unary function that converts an RGB color to an HSV color.
 Template parameters
 <class Clr>
- RgbToY709
 
 An adaptable binary function that converts a non-linear RGB color to Y709 luminance.
 Template parameters
 <class Clr>
- RgbToYcbcr
 
 An adaptable unary function for converting from non-linear RGB to Y'CbCr.
 Template parameters
 <class T>
- RgbToYpbpr
 
 An adaptable unary function for converting from non-linear RGB to Y'PbPr.
 Template parameters
 <class T>
- XyzToLab
 
 An adaptable binary function that converts an XYZ color to an L*a*b* color, given the white point of the imaging equipment in XYZ.
 Template parameters
 <class Clr>
- YcbcrToRgb
 
 An adaptable unary function for converting from Y'CbCr to non-linear RGB.
 Template parameters
 <class T>
- YpbprToRgb
 
 An adaptable unary function for converting from Y'PbPr to non-linear RGB.
 Template parameters
 <class T>
- autocorrelogram
 Calculate the autocorrelogram of an indexed color image.
 Parameters
 (const PiiMatrix< int > & image, int maxDistance, int levels)
 Overloads
 - (const PiiMatrix< int > & image, const QList< int > & distances, int levels)
- correctGamma
 Apply gamma correction to a color channel.
 Parameters
 (T value, double gamma, double maximum)
 Overloads
- genericConversion
 
 Convert all colors in an image with a generic conversion matrix.
 Parameters
 (const PiiMatrix< Clr > & colorImage, const PiiMatrix< float > & conversionMatrix)
- hsvToRgb
 Convert a color in an HSV color space into an RGB color space.
 Parameters
 (const Clr & hsvColor)
 Overloads
 - (const PiiMatrix< Clr > & hsvColorImage)
- labToXyz
 Convert a color in the CIE 1976 L*a*b* color space into the CIE XYZ color space.
 Parameters
 (const Clr & labColor, const Clr & whitePoint)
 Overloads
 - (const PiiMatrix< Clr > & labColorImage, const Clr & whitePoint)
- measureColorDistribution
 
 Measure the distribution of colors in an image.
 Parameters
 (const PiiMatrix< ColorType > & clrImage, PiiMatrix< double > & baseVectors, PiiMatrix< double > & center, int maxPixels)
- normalizeColorDistribution
 
 Project colors into a new base and translate to a new center.
 Parameters
 (const PiiMatrix< ColorType > & clrImage, const PiiMatrix< double > & baseVectors, const PiiMatrix< double > & center)
- normalizedRgb
 
 Convert an RGB color image to normalized RGB and separate two of the normalized color layers.
 Parameters
 (const PiiMatrix< T > & image, PiiMatrix< typename T::Type > & ch1, PiiMatrix< typename T::Type > & ch2, float multiplier, int ch1Index, int ch2Index)
- reverseColor
 
 Reverse the order of color channels.
 Parameters
 (const Clr & color)
- reverseColors
 
 Reverse the order of color channels in a color image.
 Parameters
 (const PiiMatrix< Clr > & clrImage)
- rgbToHsv
 Convert an RGB color image into an HSV color image.
 Parameters
 (const PiiMatrix< Clr > & rgbColorImage)
 Overloads
 - (const Clr & rgbColor)
- rgbToY709
 Convert a color image from a non-linear RGB color space to Y709 luminance.
 Parameters
 (const PiiMatrix< Clr > & clrImage)
 Overloads
 - (const Clr & clr)
- rgbToYcbcr
 Convert a non-linear (gamma-adjusted) RGB color into Y'CbCr.
 Parameters
 (const Clr & clr, double maximum)
 Overloads
 - (const PiiMatrix< T > & image, double maximum)
- rgbToYpbpr
 Convert a non-linear (gamma-adjusted) RGB color into Y'PbPr.
 Parameters
 (const Clr & clr)
 Overloads
 - (const PiiMatrix< T > & image)
- toIndexed
 
 Convert a color image into indexed colors.
 Parameters
 (const PiiMatrix< ColorType > & clrImage, int redLevels, int greenLevels, int blueLevels)
- xyzToLab
 Convert an XYZ color image into an L*a*b* color image.
 Parameters
 (const PiiMatrix< Clr > & xyzColorImage, const Clr & whitePoint)
 Overloads
 - (const Clr & xyzColor, const Clr & whitePoint)
- ycbcrToRgb
 Convert a color image in a Y'CbCr space to non-linear RGB.
 Parameters
 (const PiiMatrix< T > & image, double maximum)
 Overloads
 - (const Clr & clr, double maximum)
- ypbprToRgb
 Convert a color image in a Y'PbPr space to non-linear RGB.
 Parameters
 (const PiiMatrix< T > & image)
 Overloads
 - (const Clr & clr)
▶
Operations
- PiiColorChannelSetter
  Sets indidivual color channels in images.
- PiiColorChannelSplitter
  An operation that splits color images into channels.
- PiiColorConverter
  Convert color spaces.
- PiiColorCorrelogramOperation
  Calculate the color autocorrelogram of an image.
- PiiColorModelMatcher
  An operation that converts a color image into an intensity map.
- PiiColorPercentiles
  An operation that calculates percentiles from color histograms.
- PiiImageConversionSwitch
  PiiImageConversionSwitch is an operation which convert a receiving image from the color/gray to the gray/color type if necessary.
- PiiRgbNormalizer
  An operation that converts images to normalized RGB.

▶

Database plug-in

▶

Dsp plug-in

▶
PiiDsp namespace
- Peak
 
 A structure that stores information about a peak detected by findPeaks().
- convolution
 
 Two-dimensional convolution of two matrices.
 Parameters
 (const PiiMatrix< T > & a, const PiiMatrix & b, FilterMode mode)
- correlation
 
 Two-dimensional correlation of two matrices.
 Parameters
 (const PiiMatrix< T > & a, const PiiMatrix & b, FilterMode mode)
- createScalingWavelets
 
 Create an orthogonal wavelet filter set from the given scaling filter.
 Parameters
 (const PiiMatrix< T > & filter)
- daubechiesScalingFilter
 
 Get the indexth Daubechies scaling wavelet.
 Parameters
 (int index)
- downSample
 
 Perform a dyadic downsampling on the input matrix.
 Parameters
 (const PiiMatrix< T > & mat, Pii::MatrixDirections directions, int odd)
- dwt
 Performs a two-dimensional one-level discrete wavelet transform on the input matrix.
 Parameters
 (const PiiMatrix< T > & mat, const PiiMatrix< T > & lo, const PiiMatrix< T > & hi)
 Overloads
 - (const PiiMatrix< T > & mat, WaveletFamily wavelet, int familyMember)
- fftShift
 
 Swap opposing halves or quadrands of a matrix.
 Parameters
 (const PiiMatrix< T > & matrix, bool inverse)
- filter
 
 Two-dimensional filter of two matrices.
 Parameters
 (const PiiMatrix< T > & a, const PiiMatrix & b, FilterMode mode)
- findPeaks
 
 Find peaks in noisy one-dimensional data.
 Parameters
 (const PiiMatrix< double > & data, double levelThreshold, double sharpnessThreshold, int smoothWidth, int windowWidth)
- keep
 
 Take the central part of a matrix.
 Parameters
 (const PiiMatrix< T > & mat, int rows, int cols)
- normalizedCorrelation
 
 Normalized cross-correlation of two-dimensional signals.
 Parameters
 (const PiiMatrix< T > & a, const PiiMatrix & b, FilterMode mode)
- quadratureMirror
 
 Compute a quadrature mirror filter for a filter.
 Parameters
 (const PiiMatrix< T > & filter, int odd)
- scalingFilter
 
 Get the wavelet scaling filter for a certain mother wavelet.
 Parameters
 (WaveletFamily wavelet, int member)
▶
Operations
- PiiFourierTransform
  An operation that calculates the fast fourier transform for any matrix.
- PiiPeakDetector
  Detect peaks in noisy data.
- PiiWaveletTransform
  Discrete wavelet decomposition in two dimensions.
▶
Other classes
- PiiFft
  A class for performing forward and inverse FFT for 1D and 2D signals.

▶

▶

▶

▶

▶
PiiImage namespace
- AdaptiveThresholdFunction
 
 Template parameters
 <class ThresholdFunc>
- AlphaRoi
 A region-of-interest function object that returns true if the alpha channel has a non-zero value at (r,c) and false otherwise.
 Template parameters
 <class T>
 Specializations
 - < PiiColor4< T > >
- ColorToGray
 
 Template parameters
 <class Clr>
- CutFunction
 
 CutFunction compares value to a threshold and outputs either value or threshold based on the comparison result.
 Template parameters
 <class T, class U>
- DefaultLabelingLimiter
 
 A class that collects object labels as the labelImage() function processes the input image.
- DefaultRoi
 
 Default region-of-interest function object for feature extraction and image analysis methods that support ROI processing.
- DefaultSweepFunction
 
 A Default struct which is used in line sweeper.
 Template parameters
 <class ResultType, class ImageType>
- DropFunction
 
 DropFunction compares value to a threshold and outputs either value - threshold or 0 based on the comparison result.
 Template parameters
 <class T, class U>
- FloatTraits
 
 Traits for floating-point images.
 Template parameters
 <class T>
- GrayToGray
 
 Template parameters
 <class T>
- IntegerTraits
 
 Traits for integer-valued images.
 Template parameters
 <class T>
- InverseCutFunction
 
 InverseCutFunction compares value to a threshold and outputs either value or threshold based on the comparison result.
 Template parameters
 <class T, class U>
- InverseThresholdFunction
 
 InverseThresholdFunction compares two values and outputs either 0 or 1 based on the comparison result.
 Template parameters
 <class T, class U>
- InverseTwoLevelThresholdFunction
 
 InverseTwoLevelThresholdFunction works analogously to TwoLevelThresholdFunction, but inverses the result.
 Template parameters
 <class T, class U>
- MeanStdThresholdFunction
 
 A function that calculates a local threshold t as , where r stands for relativeThreshold.
 Template parameters
 <class BinaryFunction, class UnaryFunction>
- ObjectSizeLimiter
 
 An object size limiter for labelImage().
- RadiansToPoints
 
 A unary function that converts radians to points of the compass.
 Template parameters
 <class T>
- SauvolaThresholdFunction
 
 A function that calculates a local threshold t as , where r stands for relativeThreshold and for the maximum possible standard deviation.
 Template parameters
 <class BinaryFunction, class UnaryFunction>
- SweepCollectorFunction
 
 A Functional that collects points which intensity is higher then given threshold.
 Template parameters
 <class ResultType, class ImageType>
- ThresholdFunction
 
 ThresholdFunction compares two values and outputs either 0 or 1 based on the comparison result.
 Template parameters
 <class, class>
- ToGray
 
 Template parameters
 <class T>
- Traits
 The Traits structure specifies default properties of different image types.
 Template parameters
 <class T>
 Specializations
 - < PiiColor4< T > >
 - < PiiColor< T > >
- TwoLevelThresholdFunction
 
 TwoLevelThresholdFunction compares its input argument to two thresholds and returns one if the argument is in between them (inclusive).
 Template parameters
 <class T, class U>
- ZeroAboveFunction
 
 ZeroAboveFunction works analogously to ZeroBelowFunction, but outputs zero for values that are above or equal to the threshold.
 Template parameters
 <class T, class U>
- ZeroBelowFunction
 
 ZeroBelowFunction compares value to a threshold and outputs either value or 0 based on the comparison result.
 Template parameters
 <class T, class U>
- adaptiveThreshold
 Threshold an image adaptively.
 Parameters
 (const PiiRandomAccessMatrix & image, BinaryFunction func, float relativeThreshold, float absoluteThreshold, int windowRows, int windowColumns)
 Overloads
 - (const PiiRandomAccessMatrix & image, BinaryFunction func, int windowRows, int windowColumns)
 - (const PiiRandomAccessMatrix & image, const PiiMatrix< bool > & roiMask, BinaryFunction func, int windowRows, int windowColumns)
- adaptiveThresholdFunction
 
 Parameters
 (const ThresholdFunc & func, float relativeThreshold, float absoluteThreshold)
- alphaToMask
 
 Returns the alpha channel of image as a boolean mask.
 Parameters
 (const PiiMatrix< PiiColor4< T > > & image)
- backProject
 Two-dimensional histogram backprojection.
 Parameters
 (const PiiMatrix< T > & ch1, const PiiMatrix< T > & ch2, const PiiMatrix & histogram)
 Overloads
 - (const PiiMatrix< T > & img, const PiiMatrix & histogram)
- border
 
 Extract the border of binary objects.
 Parameters
 (const PiiMatrix< T > & image)
- bottomHat
 
 Bottom-hat transform.
 Parameters
 (const PiiMatrix< T > & image, const PiiMatrix & mask)
- calculateDirection
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function takes a decision function as a parameter.
 Parameters
 (const PiiMatrix< T > & mat, UnaryFunction decisionRule, double * length, double * width, int * pixels)
 Overloads
 - (const PiiMatrix< T > & mat, T label, double * length, double * width, int * pixels, typename Pii::OnlyNumeric< T >::Type )
- calculateProperties
 
 Calculate areas, centroids and bounding boxes for labeled objects.
 Parameters
 (const PiiMatrix< T > & mat, int labels, PiiMatrix< int > & areas, PiiMatrix< int > & centroids, PiiMatrix< int > & bbox)
- close
 
 Morphological closing.
 Parameters
 (const PiiMatrix< T > & image, const PiiMatrix & mask)
- collectCoordinates
 
 Parameters
 (const PiiRandomAccessMatrix & image, UnaryFunction decisionRule)
- colorChannel
 
 Extract a channel from a color image.
 Parameters
 (const PiiMatrix< ColorType > & image, int channel)
- createMask
 Create a morphological mask.
 Parameters
 (MaskType type, int rows, int columns)
 Overloads
 - (MaskType type, PiiMatrix< T > & mask)
- createRoiMask
 
 Creates a binary ROI mask out of a set of rectangular regions.
 Parameters
 (int rows, int columns, const PiiMatrix< int > & rectangles)
- createRotationTransform
 Creates a transform that rotates a coordinate system theta radians around its origin.
 Parameters
 (float theta)
 Overloads
 - (float theta, float centerX, float centerY)
- createScalingTransform
 
 Creates a transform that scales a coordinate system by scaleX horizontally and by scaleY vertically.
 Parameters
 (float scaleX, float scaleY)
- createShearingTransform
 
 Creates a transform that shears a coordinate system by shearX horizontally and by shearY vertically.
 Parameters
 (float shearX, float shearY)
- createTranslationTransform
 
 Creates a transform that translates a coordinate system by x horizontally and by y vertically.
 Parameters
 (float x, float y)
- crop
 
 Crop a rectangular area out of a transformed image, in which the target may not appear as a rectangular object.
 Parameters
 (const PiiMatrix< T > & image, int x, int y, int width, int height, const PiiMatrix< float > & transform)
- cumulative
 
 Calculate the cumulative frequency distribution of the given frequency distribution (histogram).
 Parameters
 (const PiiMatrix< T > & histogram)
- cut
 
 Cut gray levels.
 Parameters
 (const PiiMatrix< T > & image, T threshold)
- detectEdges
 
 Detect edges in a gray-level image.
 Parameters
 (const PiiMatrix< T > & image, int smoothWidth, T lowThreshold, T highThreshold)
- detectFastCorners
 
 Detects corners in image using the FAST corner detector.
 Parameters
 (const PiiMatrix< T > & image, T threshold)
- dilate
 
 Dilation.
 Parameters
 (const PiiMatrix< T > & image, const PiiMatrix & mask)
- equalize
 
 Histogram equalization.
 Parameters
 (const PiiMatrix< T > & img, unsigned int levels)
- erode
 
 Perform a morphological erosion operation on a image.
 Parameters
 (const PiiMatrix< T > & image, const PiiMatrix & mask, bool handleBorders)
- filter
 Filter an image with the given filter.
 Parameters
 (const PiiMatrix< T > & image, const PiiMatrix & filter, Pii::ExtendMode mode)
 Overloads
 - (const PiiMatrix< T > & image, const PiiMatrix & horizontalFilter, const PiiMatrix & verticalFilter, Pii::ExtendMode mode)
 - (const PiiMatrix< ImageType > & image, PrebuiltFilterType type, Pii::ExtendMode mode, int filterSize)
- gradientDirection
 
 Calculate gradient angle from gradient magnitude components.
 Parameters
 (const PiiMatrix< T > & gradX, const PiiMatrix< T > & gradY)
- gradientMagnitude
 
 Calculate total gradient magnitude from gradient magnitude components.
 Parameters
 (const PiiMatrix< T > & gradX, const PiiMatrix< T > & gradY, bool fast)
- handleRoiInput
 
 Parameters
 (PiiInputSocket * input, RoiType roiType, const PiiMatrix< T > & image, Processor & process)
- histogram
 Calculate the histogram of a one-channel image.
 Parameters
 (const PiiMatrix & image, const Roi & roi, const PiiQuantizer & quantizer)
 Overloads
- hitAndMiss
 
 Hit-and-miss transform.
 Parameters
 (const PiiMatrix< T > & image, const PiiMatrix & mask, const PiiMatrix & significance)
- hysteresisThreshold
 
 Perform hysteresis thresholding on image.
 Parameters
 (const PiiMatrix< T > & image, T lowThreshold, T highThreshold, Connectivity connectivity)
- intFilter
 Filters an integer image by a double-valued filter.
 Parameters
 (const PiiMatrix< int > & image, const PiiMatrix< double > & doubleFilter, Pii::ExtendMode mode, double scale)
 Overloads
 - (const PiiMatrix< int > & image, const PiiMatrix< double > & horizontalFilter, const PiiMatrix< double > & verticalFilter, Pii::ExtendMode mode, double scale)
- inverseCut
 
 Inversely cut gray levels.
 Parameters
 (const PiiMatrix< T > & image, T threshold)
- inverseHysteresisThreshold
 
 Inverse hysteresis thresholding.
 Parameters
 (const PiiMatrix< T > & image, T lowThreshold, T highThreshold, Connectivity connectivity)
- inverseThreshold
 
 Threshold and invert an image.
 Parameters
 (const PiiMatrix< T > & image, T threshold)
- labelImage
 Label image using 4-connectivity.
 Parameters
 (const PiiConceptualMatrix< Matrix, Pii::RandomAccessMatrix > & mat, UnaryOp rule, Limiter limiter, int * labelCount)
 Overloads
 - (const PiiConceptualMatrix< Matrix, Pii::RandomAccessMatrix > & mat, int * labelCount)
 - (const PiiConceptualMatrix< Matrix, Pii::RandomAccessMatrix > & mat, UnaryOp1 rule1, UnaryOp2 rule2, Connectivity connectivity, int labelIncrement, int * labelCount)
- labelLargerThan
 
 Label all 4-connected objects whose size (in pixels) is larger than sizeLimit.
 Parameters
 (const PiiConceptualMatrix< Matrix, Pii::RandomAccessMatrix > & mat, int sizeLimit, int * labelCount)
- makeFilter
 
 Create an image filter.
 Parameters
 (PrebuiltFilterType type, unsigned int size)
- makeGaussian
 
 Create a size-by-size Gaussian low-pass filter.
 Parameters
 (unsigned int size)
- makeLoGaussian
 
 Create a size-by-size Laplacian-of-Gaussian filter.
 Parameters
 (unsigned int size)
- medianFilter
 
 Filters an image with a median filter.
 Parameters
 (const PiiMatrix< T > & image, int filterRows, int filterColumns, Pii::ExtendMode mode)
- morphology
 
 Perform a morphological operation on an image.
 Parameters
 (const PiiMatrix< T > & image, const PiiMatrix & mask, MorphologyOperation type, bool handleBorders)
- normalize
 
 Normalize the given histogram so that its elements sum up to one.
 Parameters
 (const PiiMatrix & histogram)
- open
 
 Morphological opening.
 Parameters
 (const PiiMatrix< T > & image, const PiiMatrix & mask)
- otsuThreshold
 
 The Otsu method is used in automatically selecting an optimal threshold.
 Parameters
 (const PiiMatrix< T > & histogram)
- overlapping
 
 Returns true if any two of the given rectangles overlap each other and false otherwise.
 Parameters
 (const PiiMatrix< int > & rectangles)
- percentile
 
 Find the index of the first entry in a cumulative frequency distribution that exceeds or equals to the given value.
 Parameters
 (const PiiMatrix< T > & cumulative, T value)
- PII_DECLARE_EXPORTED_FUNCTION_TEMPLATE
 
 Create a morphological mask.
 Parameters
 (PiiMatrix< unsigned char > , createMask< unsigned char > , (MaskType type, int rows, int columns) , PII_BUILDING_IMAGE )
- remap
 
 Transforms image according to the given coordinate map.
 Parameters
 (const PiiMatrix< T > & image, const PiiMatrix< PiiPoint > & map)
- rotate
 
 Rotates image theta radians around its center.
 Parameters
 (const PiiMatrix< T > & image, double theta, TransformedSize handling, T backgroundColor)
- scale
 Scales image to a specified size.
 Parameters
 (const PiiMatrix< T > & image, int rows, int columns, Pii::Interpolation interpolation)
 Overloads
 - (const PiiMatrix< T > & image, double scaleRatio, Pii::Interpolation interpolation)
- separateChannels
 
 Split a color image into channels.
 Parameters
 (const PiiMatrix< ColorType > & image, PiiMatrix< typename ColorType::Type > * channelImages, int channels)
- separateFilter
 
 Decompose a two-dimensional filter into two one-dimensional filters.
 Parameters
 (const PiiMatrix< T > & filter, PiiMatrix< T > & horizontalFilter, PiiMatrix< T > & verticalFilter)
- setColorChannel
 Set a color channel.
 Parameters
 (PiiMatrix< ColorType > & image, int channel, const PiiMatrix< typename ColorType::Type > & values)
 Overloads
 - (PiiMatrix< ColorType > & image, int channel, typename ColorType::Type value)
- shrink
 
 Remove object borders.
 Parameters
 (const PiiMatrix< T > & image, int amount)
- sweepLine
 
 A Line sweeper.
 Parameters
 (const PiiMatrix< ImageType > & image, const PiiMatrix< double > & coordinates, SweepFunction function, int radius)
- thin
 
 Thin binary objects towards a skeleton.
 Parameters
 (const PiiMatrix< T > & image, int amount)
- threshold
 
 Threshold an image.
 Parameters
 (const PiiMatrix< T > & image, T threshold)
- to8Bit
 Parameters
 (const PiiMatrix< unsigned char > & image)
 Overloads
 - (const PiiMatrix< T > & image)
 - (const PiiMatrix< float > & image)
- toFloat
 An explicit specialization of the toFloat() function.
 Parameters
 (const PiiMatrix< float > & image)
 Overloads
 - (const PiiMatrix< T > & image)
- toGray
 Parameters
 (const PiiMatrix< PiiColor4< T > > & image)
 Overloads
 - (const PiiMatrix< PiiColor< T > > & image)
 - (const PiiMatrix< T > & image)
- topHat
 
 Top-hat transform.
 Parameters
 (const PiiMatrix< T > & image, const PiiMatrix & mask)
- toRoiMask
 
 Converts any integer matrix to a boolean matrix.
 Parameters
 (const PiiVariant & obj)
- transform
 
 Applies an arbitrary geometric transform to image.
 Parameters
 (const PiiMatrix< T > & image, const PiiMatrix< float > & transform, TransformedSize handling, T backgroundColor)
- transformHomogeneousPoint
 
 Transforms a 2D point using transform.
 Parameters
 (const PiiMatrix< T > & transform, T sourceX, T sourceY, T * transformedX, T * transformedY)
- transformHomogeneousPoints
 
 Transforms 2D point coordinates using transform.
 Parameters
 (const PiiMatrix< T > & transform, const PiiMatrix & points)
- unwarpCylinder
 
 Straighten an image that is wrapped around a cylinder.
 Parameters
 (const PiiMatrix< T > & warpedImage, double focalLength, double center, double * cameraDistance, double * radius, double * sectorAngle, double * startAngle)
- zeroAbove
 
 Zero values above or equal to threshold.
 Parameters
 (const PiiMatrix< T > & image, T threshold)
- zeroBelow
 
 Zero values below threshold.
 Parameters
 (const PiiMatrix< T > & image, T threshold)
▶
Operations
- PiiBackgroundExtractor
  An operation that models static background of a scene with moving objects.
- PiiBoundaryFinderOperation
  Extracts boundaries of connected objects in images.
- PiiCornerDetector
  Detects corners in gray-level images using the FAST corner detector.
- PiiEdgeDetector
  Detect edges on images.
- PiiFeatureRangeLimiter
  Operation cuts features from feature-vectors by using the first one as a reference.
- PiiHistogramBackProjector
  Perform histogram back-projection.
- PiiHistogramEqualizer
  Histogram equalizer.
- PiiHistogramOperation
  An operation that calculates the histogram of a gray-scale or a color image.
- PiiImageAnnotator
  An operation that draws graphics primitives on an image.
- PiiImageCropper
  An operation that takes a piece of an image or any other matrix.
- PiiImageFileReader
  An operation for reading images from files.
- PiiImageFileWriter
  An operation that writes images into files in standard image formats.
- PiiImageFilterOperation
  An operation that implements basic image filtering operations.
- PiiImagePieceJoiner
  An operation that combines adjacent sub-images to larger compounds.
- PiiImageReaderOperation
  A base class for image sources.
- PiiImageRotationOperation
  Rotate images to arbitrary angles in two dimension.
- PiiImageScaleOperation
  Scale images to arbitrary sizes.
- PiiImageSplitter
  An operation for splitting images into pieces.
- PiiImageUnwarpOperation
  An operation that straightens cylindrically warped images.
- PiiLabelingOperation
  Basic labeling operations.
- PiiMaskGenerator
  An operation that creates binary mask images.
- PiiMorphologyOperation
  Basic binary morphology operations.
- PiiObjectPropertyExtractor
  Calculates geometric properties for labeled objects.
- PiiQuantizerOperation
  Quantizes any numeric matrix to discrete levels.
- PiiThresholdingOperation
  A threshold operation with one threshold value.
▶
Other classes
- PiiBoundaryFinder
  An algorithm that traverses object boundaries.
- PiiCloudFractalGenerator
  A class that generates two-dimensional cloud-like fractal pictures.
- PiiQuantizer
  A class that quantizes (floating point) values to integers.

▶

Io plug-in

▶

Matching plug-in

MultiCamDriver plug-in

MultiCamIoDriver plug-in

▶

▶

▶

▶

▶

▶

▶

▶

▶

Serialization library

▶
PiiSerialization namespace
- Accessor
  
  A proxy through which calls to serialization member functions are passed.
- Void
- isDynamicType
  
  This function is used to check if the real type of the class is known at compile time or not.
  Parameters
  (const void * )
- serialize
  
  Default implementation of a serialization function.
  Parameters
  (Archive & archive, T & value, const unsigned int version)
▶
PiiSerializationTraits namespace
- ClassInfo
 Class information trait.
 Template parameters
 <class T>
 Specializations
 - < const T >
- ClassName
 Class name trait.
 Template parameters
 <class T>
 Specializations
 - < const T >
- IsAbstract
 A type trait for checking the abstractness of a type.
 Template parameters
 <class T>
 Specializations
 - < const T >
- IsPrimitive
 A type trait for checking the primitiveness of a type.
 Template parameters
 <class T>
 Specializations
 - < QString >
- Tracking
 Pointer tracking trait.
 Template parameters
 <class T>
 Specializations
 - < const T >
- Version
 Class version trait.
 Template parameters
 <class T>
 Specializations
 - < const T >
- PII_NAME_TYPE
 Parameters
 (char )
 Overloads
▶
Other classes
- PiiGenericInputArchive::Impl
  Default implementation of the generic input archive interface.
- PiiArchive
  Common base class for all archive types.
- PiiBaseClass
  A wrapper for serializing a base class.
- PiiBinaryInputArchive
  PiiBinaryInputArchive reads raw binary data.
- PiiBinaryObject
  A serialization wrapper for binary data.
- PiiBinaryOutputArchive
  Binary output archive stores data in a raw binary format.
- PiiGenericInputArchive
  A polymorphic implementation of the archive interface.
- PiiGenericOutputArchive
  A polymorphic implementation of the archive interface.
- PiiInputArchive
  A base class for input archive implementations.
- PiiMetaObject
  Meta objects store information specific to a certain data type.
- PiiNameValuePair
  A template that wraps a name and a value into a pair.
- PiiOutputArchive
  A base class for output archive implementations.
- PiiQVariantWrapper
  A serialization wrapper for user types in QVariants.
- PiiSerializationException
  Thrown when an error occurs in (de)serializing data.
- PiiSerializer
  Serializer is an object that takes care of serializing objects.
- PiiSerializerTemplate
  A template class that is statically instantiated to add serializable classes to an archive's serializer registry.
- PiiTextInputArchive
  TextInputArchive reads space-separated textual data.
- PiiTextOutputArchive
  Text output archive stores data in a space-separated textual format.
- PiiTrackedPointerHolder
  A class that is used by PiiOutputArchive to store tracked pointers while serializing them.
- PiiQVariantWrapper::Template
  A template that is instantiated for all user types intended to be serialized as QVariants.

▶

Ydin execution engine

▶
Operations
- PiiBasicOperation
  A bare bones implementation of the PiiOperation interface.
- PiiDefaultOperation
  A functional implementation of the PiiOperation interface.
- PiiEngine
  An execution engine.
- PiiOperation
  A superclass for operations that can be run by Ydin.
- PiiOperationCompound
  PiiOperationCompound is a class that controls a set of operations.
▶
Other classes
- PiiAbstractInputSocket
  An abstract superclass for input sockets.
- PiiAbstractOutputSocket
  An abstract superclass for output sockets.
- PiiAbstractSocket
  A superclass for socket interfaces.
- PiiConfigurationWidget
  An interface that provides different UI components a way of communicating with the controlling program.
- PiiDefaultFlowController
  The default flow controller handles inter-operation synchronization by grouping synchronous sockets and injecting special synchronization tags into the sockets.
- PiiExecutionException
  Thrown when an operation cannot be started, or an error is detected during execution.
- PiiFlowController
  An interface for algorithms that synchronize object flow in sockets.
- PiiInputController
  An interface for classes that receive objects from input sockets.
- PiiInputSocket
  Default implementation of an input socket.
- PiiLayerParser
  This class provides an interface for handling a data structure called a .
- PiiLoadException
  Thrown when the loading of a plug-in fails.
- PiiOneGroupFlowController
  A flow controller that synchronizes a group of sockets with the same group ID.
- PiiOneInputFlowController
  A flow controller that does not handle synchronization between sibling sockets.
- PiiOperationTest
  A class that makes it easier to write unit tests for operations.
- PiiOutputSocket
  An output socket.
- PiiProbeInput
  An input socket that works without a controlling operation.
- PiiProxySocket
  An input-output socket.
- PiiResourceConnector
  An interface for classes that connect resource instances together.
- PiiSocket
  Socket is a connection point between operations.
- PiiSocketState
  A structure that stores information about a socket's state at run time.
- PiiWaitCondition
  Provides waiting/waking conditions between two threads.

Documentation

namespace referencePiiColors

Functions for transforming colors.

Unless stated otherwise, color transform functions assume linear RGB. Almost all digitally stored image data are however gamma-adjusted and therefore non-linear. For example, JPEG and MPEG store colors in a non-linear form, and almost all consumer digital cameras apply gamma adjustment to the colors. Therefore, gamma correction needs to be applied to the input images. Otherwise, color transformation results will not be theoretically correct. It is up to the user if this matters in practice, but you have been warned. It can be assumed that digital cameras typically apply a gamma of 1/2.2. To linearize the colors, one needs to invert the gamma compression:

 using namespace PiiColors;
 PiiColor<> nonlinearRgbColor;
 PiiColor<> linearRgbColor = correctGamma(nonlinearRgbColor, 2.2);

Classes

class	PiiColors::CorrectGamma An adaptable binary function that performs gamma correction.
class	PiiColors::CorrectGammaScaled An adaptable binary function that performs gamma correction on scaled image channels.
struct	PiiColors::GenericConversion An adaptable binary function that multiplies a color with a 3-by-3 matrix.
struct	PiiColors::HsvToRgb An adaptable unary function that converts an HSV color to an RGB color.
struct	PiiColors::LabToXyz An adaptable binary function that converts an Lab* color to an XYZ color, given the white point of the imaging equipment in XYZ.
struct	PiiColors::LikelihoodFunction A unary function for converting color distances to "likelihoods".
struct	PiiColors::ReverseColors An adaptable unary function that inverses the order of color channels.
struct	PiiColors::RgbToHsv An adaptable unary function that converts an RGB color to an HSV color.
struct	PiiColors::RgbToY709 An adaptable binary function that converts a non-linear RGB color to Y709 luminance.
class	PiiColors::RgbToYcbcr An adaptable unary function for converting from non-linear RGB to Y'CbCr.
struct	PiiColors::RgbToYpbpr An adaptable unary function for converting from non-linear RGB to Y'PbPr.
struct	PiiColors::XyzToLab An adaptable binary function that converts an XYZ color to an Lab* color, given the white point of the imaging equipment in XYZ.
struct	PiiColors::YcbcrToRgb An adaptable unary function for converting from Y'CbCr to non-linear RGB.
struct	PiiColors::YpbprToRgb An adaptable unary function for converting from Y'PbPr to non-linear RGB.

Functions

PII_COLORS_EXPORT PiiMatrix< float >	autocorrelogram ( const PiiMatrix< int > & image int maxDistance = 5 int levels = 0 ) Calculate the autocorrelogram of an indexed color image.
PII_COLORS_EXPORT PiiMatrix< float >	autocorrelogram ( const PiiMatrix< int > & image const QList< int > & distances int levels = 0 ) Calculate the autocorrelogram of an indexed olor image.
template<class T> T	correctGamma ( T value double gamma double maximum ) Apply gamma correction to a color channel.
template<class T> PiiColor< T >	correctGamma ( const PiiColor< T > & clr double gamma ) Apply gamma correction to all color channels of `clr`.
template<class T> PiiColor4< T >	correctGamma ( const PiiColor4< T > & clr double gamma ) Apply gamma correction to the first three color channels of `clr`.
template<class T> PiiColor< T >	correctGamma ( const PiiColor< T > & clr double gamma double maximum ) Apply gamma correction to all channels of `clr`.
template<class T> PiiColor4< T >	correctGamma ( const PiiColor4< T > & clr double gamma double maximum ) Apply gamma correction to the first three color channels of `clr`.
template<class T> PiiMatrix< T >	correctGamma ( const PiiMatrix< T > & image double gamma ) Apply gamma correction to all pixels in `image`.
template<class T> T	correctGamma ( T value double gamma typename Pii::OnlyFloatingPoint< T >::Type dummy = 0 ) Apply gamma correction to a color channel.
template<class T> PiiMatrix< T >	correctGamma ( const PiiMatrix< T > & image double gamma double maximum ) Apply gamma correction to all pixels in `image`.
template<class Clr> PiiMatrix< PiiColor< float > >	genericConversion ( const PiiMatrix< Clr > & colorImage const PiiMatrix< float > & conversionMatrix ) Convert all colors in an image with a generic conversion matrix.
template<class Clr> Clr	hsvToRgb ( const Clr & hsvColor ) Convert a color in an HSV color space into an RGB color space.
template<class Clr> PiiMatrix< Clr >	hsvToRgb ( const PiiMatrix< Clr > & hsvColorImage ) Convert an HSV color image into an RGB color image.
template<class Clr> Clr	labToXyz ( const Clr & labColor const Clr & whitePoint ) Convert a color in the CIE 1976 Lab* color space into the CIE XYZ color space.
template<class Clr> PiiMatrix< Clr >	labToXyz ( const PiiMatrix< Clr > & labColorImage const Clr & whitePoint ) Convert an Lab* color image into an XYZ color image.
template<class ColorType> void	measureColorDistribution ( const PiiMatrix< ColorType > & clrImage PiiMatrix< double > & baseVectors PiiMatrix< double > & center int maxPixels = -1 ) Measure the distribution of colors in an image.
template<class ColorType> PiiMatrix< PiiColor< float > >	normalizeColorDistribution ( const PiiMatrix< ColorType > & clrImage const PiiMatrix< double > & baseVectors const PiiMatrix< double > & center ) Project colors into a new base and translate to a new center.
template<class T> void	normalizedRgb ( const PiiMatrix< T > & image PiiMatrix< typename T::Type > & ch1 PiiMatrix< typename T::Type > & ch2 float multiplier = 255 int ch1Index = 0 int ch2Index = 1 ) Convert an RGB color image to normalized RGB and separate two of the normalized color layers.
template<class Clr> Clr	reverseColor ( const Clr & color ) Reverse the order of color channels.
template<class Clr> PiiMatrix< Clr >	reverseColors ( const PiiMatrix< Clr > & clrImage ) Reverse the order of color channels in a color image.
template<class Clr> PiiMatrix< Clr >	rgbToHsv ( const PiiMatrix< Clr > & rgbColorImage ) Convert an RGB color image into an HSV color image.
template<class Clr> Clr	rgbToHsv ( const Clr & rgbColor ) Convert a color in an RGB color space into the HSV color space.
template<class Clr> PiiMatrix< float >	rgbToY709 ( const PiiMatrix< Clr > & clrImage ) Convert a color image from a non-linear RGB color space to Y709 luminance.
template<class Clr> float	rgbToY709 ( const Clr & clr ) Convert a color in a non-linear RGB color space to luminance as defined in ITU-R BT.709: .
template<class Clr> Clr	rgbToYcbcr ( const Clr & clr double maximum = < Clr >::max() ) Convert a non-linear (gamma-adjusted) RGB color into Y'CbCr.
template<class T> PiiMatrix< T >	rgbToYcbcr ( const PiiMatrix< T > & image double maximum = < T >::max() ) Convert a color image in a non-linear RGB space into Y'CbCr.
template<class Clr> Clr	rgbToYpbpr ( const Clr & clr ) Convert a non-linear (gamma-adjusted) RGB color into Y'PbPr.
template<class T> PiiMatrix< T >	rgbToYpbpr ( const PiiMatrix< T > & image ) Convert a color image in a non-linear RGB space into Y'PbPr.
template<class ColorType> PiiMatrix< int >	toIndexed ( const PiiMatrix< ColorType > & clrImage int redLevels int greenLevels = 0 int blueLevels = 0 ) Convert a color image into indexed colors.
template<class Clr> PiiMatrix< Clr >	xyzToLab ( const PiiMatrix< Clr > & xyzColorImage const Clr & whitePoint ) Convert an XYZ color image into an Lab* color image.
template<class Clr> Clr	xyzToLab ( const Clr & xyzColor const Clr & whitePoint ) Convert a color in the CIE XYZ color space into the CIE 1976 Lab* color space.
template<class T> PiiMatrix< T >	ycbcrToRgb ( const PiiMatrix< T > & image double maximum = < T >::max() ) Convert a color image in a Y'CbCr space to non-linear RGB.
template<class Clr> Clr	ycbcrToRgb ( const Clr & clr double maximum = < Clr >::max() ) Convert a Y'CbCr color into non-linear RGB.
template<class T> PiiMatrix< T >	ypbprToRgb ( const PiiMatrix< T > & image ) Convert a color image in a Y'PbPr space to non-linear RGB.
template<class Clr> Clr	ypbprToRgb ( const Clr & clr ) Convert a Y'PbPr color into non-linear RGB.

Variables

PII_COLORS_EXPORT PiiMatrix< float >	d65_709_XyzMatrix A conversion matrix from RGB to XYZ, assuming that the RGB is CIE RGB, and that the scene is illuminated with a D65 light source.
PII_COLORS_EXPORT PiiMatrix< float >	ohtaKanadeMatrix A conversion matrix from RGB to the maximally independent color space of Ohta and Kanade.

Function details

PII_COLORS_EXPORT PiiMatrix< float > autocorrelogram
(
- const PiiMatrix< int > & image
- int maxDistance = 5
- int levels = 0
)
#include <PiiColors.h>

Calculate the autocorrelogram of an indexed color image.

Autocorrelogram describes the spatial distribution of colors in image. Each entry (d,c) in the autocorrelogram represents the probability that a pair of pixels, whose distance is d, both have color c. In practice, the correlogram is built as a histogram and must be normalized to obtain propabilities. The technique is described in detail in Jing Huang; Kumar, S.R.; Mitra, M.; Wei-Jing Zhu; Zabih, R.: "Image indexing using color correlograms", Computer Vision and Pattern Recognition, 1997. Proceedings., 1997 IEEE Computer Society Conference on, 1997, Pages: 762 -768. This implementation does not use the bogus "optimization" technique reported in the paper.

Parameters

image

an indexed color image
maxDistance

measure correlation between colors separated up to this many pixels. The autocorrelogram will be calculated for distances {1, ..., maxDistance}.
levels

the number of indexed colors in image. A non-positive number means auto-detect.

Returns

a 1 by levels * maxDistance matrix representing the autocorrelogram (folded into a row matrix). Note that if the number of quantization levels is auto-detected, the size of the output may change in successive calls.
PII_COLORS_EXPORT PiiMatrix< float > autocorrelogram
(
- const PiiMatrix< int > & image
- const QList< int > & distances
- int levels = 0
)
#include <PiiColors.h>

Calculate the autocorrelogram of an indexed olor image.

This version of the function makes it possible to manually specify the distances for which the autocorrelogram will be calculated.

Parameters

image

an indexed color image
distances

a list of distances for which the autocorrelogram will be calculated.
levels

the number of indexed colors in image. A non-positive number means auto-detect.

Returns

a 1 by levels * maxDistance matrix representing the autocorrelogram (folded into a row matrix). Note that if the number of quantization levels is auto-detected, the size of the output may change in successive calls.
template<class T>

T correctGamma
(
- T value
- double gamma
- double maximum
)
[inline]
#include <PiiColors.h>

Apply gamma correction to a color channel.

This version of the function compresses the color channel to [0, 1] before applying the correction and then expands it back to original scale.

Parameters

value

the value of a color channel, in [0, maximum].
gamma

the value of gamma, must be positive
maximum

the maximum value of a color channel

Returns

gamma-adjusted value of the color channel, rescaled to original range. If T is an integer type, the result will be rounded to closest integer.
template<class T>

PiiColor< T > correctGamma
(
- const PiiColor< T > & clr
- double gamma
)
[inline]
#include <PiiColors.h>

Apply gamma correction to all color channels of clr.

Color channels are assumed to be in [0, 1].
template<class T>

PiiColor4< T > correctGamma
(
- const PiiColor4< T > & clr
- double gamma
)
[inline]
#include <PiiColors.h>

Apply gamma correction to the first three color channels of clr.

Note that the fourth color channel (e.g. alpha) will not be touched. Color channels are assumed to be in [0, 1].
template<class T>

PiiColor< T > correctGamma
(
- const PiiColor< T > & clr
- double gamma
- double maximum
)
[inline]
#include <PiiColors.h>

Apply gamma correction to all channels of clr.

Color channels are assumed to be in [0, maximum].
template<class T>

PiiColor4< T > correctGamma
(
- const PiiColor4< T > & clr
- double gamma
- double maximum
)
#include <PiiColors.h>

Apply gamma correction to the first three color channels of clr.

Note that the fourth color channel (e.g. alpha) will not be touched. Color channels are assumed to be in [0, maximum].
template<class T>

PiiMatrix< T > correctGamma
(
- const PiiMatrix< T > & image
- double gamma
)
[inline]
#include <PiiColors.h>

Apply gamma correction to all pixels in image.

The function works with both gray-level and color images. Color channels are assumed to be in [0, 1].

See also
- correctGamma(T, double)
template<class T>

T correctGamma
(
- T value
- double gamma
- typename Pii::OnlyFloatingPoint< T >::Type dummy = 0
)
[inline]
#include <PiiColors.h>

Apply gamma correction to a color channel.

Gamma correction is defined as , where o and i stand for output and input. Contemporary display devices are usually assumed to have a gamma of about 2.2. (This is in fact a rough approximation: LG flat panels, for example, measure closer to 1.97.) Linear colors must thus be compressed with a gamma of to get linear intensity response on screen. Linear intensity response does not however mean linear lightness (perceptual luminance) response; the human vision is more sensitive to lower luminance.
This function can be used only with floating-point color channels.

Parameters

value

the value of a color channel, in [0, 1]. Usually, only positive values are used.
gamma

the value of gamma, must be positive
dummy

Returns

gamma-adjusted value of the color channel
template<class T>

PiiMatrix< T > correctGamma
(
- const PiiMatrix< T > & image
- double gamma
- double maximum
)
[inline]
#include <PiiColors.h>

Apply gamma correction to all pixels in image.

The function works with both gray-level and color images. Color channels are assumed to be in [0, maximum].

See also
- correctGamma(T, double, double)
template<class Clr>

PiiMatrix< PiiColor< float > > genericConversion
(
- const PiiMatrix< Clr > & colorImage
- const PiiMatrix< float > & conversionMatrix
)
[inline]
#include <PiiColors.h>

Convert all colors in an image with a generic conversion matrix.
This function multiplies the three color channels by a 3-by-3 conversion matrix from left. The result type will always be PiiColor<float>. The function makes no checks. The caller must ensure the size of the conversion matrix.
```
 using namespace PiiColors;
 PiiMatrix<PiiColor4<> > clrImage;
 PiiMatrix<PiiColor<float> > converted = genericConversion(clrImage, ohtaKanadeMatrix);
```
template<class Clr>

Clr hsvToRgb
(
- const Clr & hsvColor
)
#include <PiiColors.h>

Convert a color in an HSV color space into an RGB color space.

This function works inversely to rgbToHsv() and assumes the same conventions on scaling color channels. The output color channels will be in [0,1] with floating-point types and in [0,255] with integer types.

Parameters

hsvColor

a color in an HSV color space.

Returns

the color in an RGB color space. The type of the returned color matches that of the input color.
template<class Clr>

PiiMatrix< Clr > hsvToRgb
(
- const PiiMatrix< Clr > & hsvColorImage
)
[inline]
#include <PiiColors.h>

Convert an HSV color image into an RGB color image.

See also
- hsvToRgb(Clr)
template<class Clr>

Clr labToXyz
(
- const Clr & labColor
- const Clr & whitePoint
)
#include <PiiColors.h>

Convert a color in the CIE 1976 L*a*b* color space into the CIE XYZ color space.

The conversion only works with floating-point color values.

Parameters

labColor

the L*a*b* color to be converted to XYZ
whitePoint

the XYZ coordinates of the white point of the imaging equipment. Make sure the white point has no zero color channels.
template<class Clr>

PiiMatrix< Clr > labToXyz
(
- const PiiMatrix< Clr > & labColorImage
- const Clr & whitePoint
)
[inline]
#include <PiiColors.h>

Convert an L*a*b* color image into an XYZ color image.

See also
- labToXyz(Clr, Clr)
template<class ColorType>

void measureColorDistribution
(
- const PiiMatrix< ColorType > & clrImage
- PiiMatrix< double > & baseVectors
- PiiMatrix< double > & center
- int maxPixels = -1
)
#include <PiiColors.h>

Measure the distribution of colors in an image.

This function uses PCA to find the main axes of a three-dimensional color distribution. As a result, it gives the centroid of the distribution and three orthogonal vectors forming a new base. The first of these vectors points to the direction of the largest variance in the color distribution. The length of each vector is inversely proportional to the variance of the color distribution in that direction.
Information about the color distribution can be used to normalize colors and to measure the likelihood that a color belongs to a model distribution. Once you have measured the distribution of colors you can project the colors to the new base and achieve an approximately zero-mean and unit variance color distribution. The second norm of any color coordinates in the normalized coordinate system is inversely proportional to the likelihood of the color belongin to the model distribution.

This function is temporarily broken.

Parameters

clrImage

baseVectors

a 3-by-3 matrix return-value matrix in which columns represent the three main axes of the color distribution. If the three vectors are used as a new base for the color distribution, it'll have a unit variance in x, y, and z directions in the new base.
center

the 1-by-3 return-value matrix that will store the center of mass of the color distribution.
maxPixels

the maximum number of pixels to consider. If the input image is large, a subset of its pixels is usually enough to derive a reliable estimate of distribution. Use this paramater to limit the number of pixels used for estimation. -1 means that all pixels will be used.

See also
- normalizeColorDistribution()
 matchColors()
template<class ColorType>

PiiMatrix< PiiColor< float > > normalizeColorDistribution
(
- const PiiMatrix< ColorType > & clrImage
- const PiiMatrix< double > & baseVectors
- const PiiMatrix< double > & center
)
#include <PiiColors.h>

Project colors into a new base and translate to a new center.

In the result image, the color distribution will have approximately zero mean and unit variance. Each color c in the input image will be treated as a row vector. The normalized color is given by , where t is the translation vector (center) A is the matrix representing the new base (baseVectors).

Parameters

clrImage

the input image
baseVectors

a 3-by-3 matrix in which rows represent a new base for the color system.
center

a 1-by-3 translation vector

Returns

a new normalized color image

See also
- measureColorDistribution()
template<class T>

void normalizedRgb
(
- const PiiMatrix< T > & image
- PiiMatrix< typename T::Type > & ch1
- PiiMatrix< typename T::Type > & ch2
- float multiplier = 255
- int ch1Index = 0
- int ch2Index = 1
)
#include <PiiColors.h>

Convert an RGB color image to normalized RGB and separate two of the normalized color layers.
Normalized RGB is obtained by dividing each channel by the sum of all channels. ( etc.) Note that only two channels are extracted because the third one is reduntant ( ).
```
 PiiMatrix<PiiColor<> > img(100,100);
 PiiMatrix<unsigned char> red, green, blue;
 // Extract normalized RG with 8 bit resolution
 PiiColors::normalizedRgb(img, red, green);

 // Extract normalized RB with 5 bit resolution
 PiiColors::normalizedRgb(img, red, blue, 32, 0, 2);
```
Parameters

image

The input image. Any color will do as the content type (PiiColor or PiiColor4).
ch1

store the first extracted channel to this matrix
ch2

store the second extracted channel to this matrix
multiplier

multiply each normalized channel by this value before storing to the output matrix. This is useful as the result often needs to be quantized.
ch1Index

the BGR index of the first color channel to extract. 0 = r, 1 = g, 2 = b. With PiiColor4, channel index may, in principle, be 3, but the fourth channel is never normalized.
ch2Index

same for the second channel
template<class Clr>

Clr reverseColor
(
- const Clr & color
)
[inline]
#include <PiiColors.h>

Reverse the order of color channels.

This function can be used to convert RGB to BGR or RGBA to BGRA and vice versa. It just swaps the first and third color channels.
template<class Clr>

PiiMatrix< Clr > reverseColors
(
- const PiiMatrix< Clr > & clrImage
)
[inline]
#include <PiiColors.h>

Reverse the order of color channels in a color image.
template<class Clr>

PiiMatrix< Clr > rgbToHsv
(
- const PiiMatrix< Clr > & rgbColorImage
)
[inline]
#include <PiiColors.h>

Convert an RGB color image into an HSV color image.

See also
- rgbToHsv(Clr)
template<class Clr>

Clr rgbToHsv
(
- const Clr & rgbColor
)
#include <PiiColors.h>

Convert a color in an RGB color space into the HSV color space.
HSV (hue, saturation, value) is a color space in which a piecewise linear function is used as an approximation to the (non-linear) hue channel value. See QColor for a detailed description of the HSV space.
This implementation deviates from the conventional way of scaling color channels. Typically, hue is represented with values in [0,359] as it is an angular variable. Furthermore, the value channel is often scaled into [0,100]. This convention has a couple of problems:
- unsigned char can only store values up to 255.
- Scaling value down from 255 to 100 degrades accuracy.
- With floating-point types, angles are conventionally represented as radians, not degrees.
For these reasons, this function scales the color channels depending on the input type as follows:
- unsigned char - H, S, and V are all in [0,255]
- Other integer types - H is [0,359], S and V in [0,255]
- Floating-point types - H is in [0,2*pi), S and V in [0,1].
Due to numerical inaccuracies, converting from RGB to HSV and back doesn't necessarily result into the color you started with. The back-and-forth conversion of floating-point types is accurate to at least 1e-6. The conversion error with unsigned char is at most three levels on any color channel. The conversion error with other integer types it at most two levels.
```
 PiiColor<> rgb(1,2,3);
 PiiColor<> hsv = PiiColors::rgbToHsv(rgb);
```
Parameters

rgbColor

a color in an RGB color space. Floating-point color channels are assumed to be in [0,1]. Integer types are assumed to be in [0,255].

Returns

the color in an HSV color space. The type of the returned color matches that of the input color.
template<class Clr>

PiiMatrix< float > rgbToY709
(
- const PiiMatrix< Clr > & clrImage
)
[inline]
#include <PiiColors.h>

Convert a color image from a non-linear RGB color space to Y709 luminance.
template<class Clr>

float rgbToY709
(
- const Clr & clr
)
[inline]
#include <PiiColors.h>

Convert a color in a non-linear RGB color space to luminance as defined in ITU-R BT.709: .
template<class Clr>

Clr rgbToYcbcr
(
- const Clr & clr
- double maximum = < Clr >::max()
)
[inline]
#include <PiiColors.h>

Convert a non-linear (gamma-adjusted) RGB color into Y'CbCr.

Y'CbCr is the same as Y'PbPr, but the chroma components are offset to non-negative values.
This function does not use the conventional BT.601 primaries. Instead, the more contemporary BT.709 (HDTV) primaries are used.

Parameters

clr

a gamma-adjusted RGB color, channels in [0, maximum]
maximum

maximum value of a color channel

Returns

a Y'CbCr color. Y' (luma), Cb (difference between blue and luma) and Cr (difference between red and luma) are all in [0, maximum]. All color channels will be rounded to nearest integers.
template<class T>

PiiMatrix< T > rgbToYcbcr
(
- const PiiMatrix< T > & image
- double maximum = < T >::max()
)
[inline]
#include <PiiColors.h>

Convert a color image in a non-linear RGB space into Y'CbCr.
template<class Clr>

Clr rgbToYpbpr
(
- const Clr & clr
)
[inline]
#include <PiiColors.h>

Convert a non-linear (gamma-adjusted) RGB color into Y'PbPr.

Y'PbPr is the analog counterpart of Y'CbCr. The color channels in Y'PbPr are not quantized and thus not suitable for digital representation. Different encodings use different offsets and scaling factors for the color channels.
This function does not use the conventional BT.601 primaries. Instead, the more contemporary BT.709 (HDTV) primaries are used.

Parameters

clr

a gamma-adjusted RGB color, channels in [0, X]

Returns

a Y'PbPr color. Y' (luma) is in [0, X], Pb (difference between blue and luma) and Pr (difference between red and luma) in [-0.5X, 0.5X]
template<class T>

PiiMatrix< T > rgbToYpbpr
(
- const PiiMatrix< T > & image
)
[inline]
#include <PiiColors.h>

Convert a color image in a non-linear RGB space into Y'PbPr.
template<class ColorType>

PiiMatrix< int > toIndexed
(
- const PiiMatrix< ColorType > & clrImage
- int redLevels
- int greenLevels = 0
- int blueLevels = 0
)
#include <PiiColors.h>

Convert a color image into indexed colors.

This function quantizes each color channel to the specified number of levels. The color index is calculated as , where R, G, and B represent the quantized color channel values, and is the number of quantization levels for channel X.

Despite the color channel names used here, the function also works with color spaces other than RGB.

Parameters

clrImage

the input image. ColorType must be either PiiColor or PiiColor4. If color channels are floats, the maximum value is assumed to be 1.0. Otherwise, 255 will be used as max.
redLevels

the number of quantization levels for the red color channel.
greenLevels

the number of quantization levels for the red color channel. 0 means same as redLevels.
blueLevels

the number of quantization levels for the blue color channel. 0 means same as redLevels.
template<class Clr>

PiiMatrix< Clr > xyzToLab
(
- const PiiMatrix< Clr > & xyzColorImage
- const Clr & whitePoint
)
[inline]
#include <PiiColors.h>

Convert an XYZ color image into an L*a*b* color image.

See also
- xyzToLab(Clr, Clr)
template<class Clr>

Clr xyzToLab
(
- const Clr & xyzColor
- const Clr & whitePoint
)
#include <PiiColors.h>

Convert a color in the CIE XYZ color space into the CIE 1976 L*a*b* color space.

The conversion only works with floating-point color values.

Parameters

xyzColor

the XYZ color to be converted to L*a*b*
whitePoint

the XYZ coordinates of the white point of the imaging equipment. Make sure the white point has no zero color channels.
template<class T>

PiiMatrix< T > ycbcrToRgb
(
- const PiiMatrix< T > & image
- double maximum = < T >::max()
)
[inline]
#include <PiiColors.h>

Convert a color image in a Y'CbCr space to non-linear RGB.
template<class Clr>

Clr ycbcrToRgb
(
- const Clr & clr
- double maximum = < Clr >::max()
)
[inline]
#include <PiiColors.h>

Convert a Y'CbCr color into non-linear RGB.

This function does not use the conventional BT.601 primaries. Instead, the more contemporary BT.709 (HDTV) primaries are used.

Parameters

clr

a color in a Y'CbCr color space.
maximum

the maximum value of a color channel

Returns

a color in a non-linear RGB space. All color channels are in [0, maximum] and rounded to nearest integers. To obtain linear RGB, use the correctGamma() function.
template<class T>

PiiMatrix< T > ypbprToRgb
(
- const PiiMatrix< T > & image
)
[inline]
#include <PiiColors.h>

Convert a color image in a Y'PbPr space to non-linear RGB.
template<class Clr>

Clr ypbprToRgb
(
- const Clr & clr
)
[inline]
#include <PiiColors.h>

Convert a Y'PbPr color into non-linear RGB.

This function does not use the conventional BT.601 primaries. Instead, the more contemporary BT.709 (HDTV) primaries are used.

Parameters

clr

a color in a Y'PbPr color space.

Returns

a color in a non-linear RGB space.

Variable details

PII_COLORS_EXPORT PiiMatrix< float > d65_709_XyzMatrix

A conversion matrix from RGB to XYZ, assuming that the RGB is CIE RGB, and that the scene is illuminated with a D65 light source.

If either of these assumptions does not hold, please do not pretend that you have XYZ.
genericConversion()
PII_COLORS_EXPORT PiiMatrix< float > ohtaKanadeMatrix

A conversion matrix from RGB to the maximally independent color space of Ohta and Kanade.

genericConversion()

Notes (0)

Add a note

Not a single note added yet. Be the first, add yours.

Into

Modules

Template parameters

Specializations

Template parameters

Specializations

Template parameters

Template parameters

Template parameters

Template parameters

Specializations

Template parameters

Specializations

Template parameters

Specializations

Template parameters

Specializations

Template parameters

Specializations

Template parameters

Template parameters

Template parameters

Template parameters

Template parameters

Template parameters

Template parameters

Template parameters

Template parameters

Template parameters

Template parameters

Template parameters

Template parameters

Specializations

Template parameters

Template parameters

Template parameters

Template parameters

Template parameters

Template parameters

Template parameters

Template parameters

Template parameters

Specializations

Template parameters

Template parameters

Template parameters

Specializations

Template parameters

Specializations

Template parameters

Template parameters

Specializations

Template parameters

Template parameters

Template parameters

Specializations

Template parameters

Template parameters

Specializations

Template parameters

Specializations

Template parameters

Specializations

Template parameters

Specializations

Template parameters

Specializations

Template parameters

Specializations

Template parameters

Template parameters

Template parameters

Template parameters

Specializations

Template parameters

Specializations

Template parameters

Specializations

Template parameters

Specializations