Mean3dC - Mean in 3D space

Developer Documentation

Centre for Vision, Speech & Signal Processing

Parent Classes:

Point3dC

Derived Classes:

MeanCovariance3dC

Variables:

LongIntT number;: number of points represented by mean object

Methods:

Mean3dC(): Creates a structure and init to be 0.
Mean3dC(const Point3dC & point): Creates a structure and add the first point.
Mean3dC(LongIntT n,const Point3dC & mean): Creates a structure add n points 'mean'.
Mean3dC(const RealRGBImageC & image): Computes the mean of RGB image.
Mean3dC(const RealRGBImageC & image,const ByteImageC & mask): Computes the mean of RGB image from the pixels which value is different from BLACK in the image 'mask'.
Mean3dC(const Mean3dC & mean): Copies constructor.
const Mean3dC & Mean3d() const: Access into the const object.
Mean3dC & Mean3d(): Access into the object.
Mean3dC & SetZero(): Inits the object.
Mean3dC & Set(LongIntT n,const Point3dC & point): Sets the new value of mean object.
LongIntT Number() const: Returns number of points which were added into the object.
const Point3dC & Mean() const: Returns the current value of mean.
const Mean3dC & operator=(const Mean3dC & mean): Assigment.
Mean3dC & operator+=(const Point3dC & point): Adds a point.
Mean3dC & operator-=(const Point3dC & point): Removes a point.
Mean3dC & operator+=(const Mean3dC & mean): Joins another mean object.
Mean3dC & operator-=(const Mean3dC & mean): Removes a part of object.
istream & operator>>(istream & s,Mean3dC & mean)

#include "amma/Point3d.hh"

explicit Point3dC(SizeT dim): Creates the point (0.0, 0.0, 0.0).
For compability with N-D points.
const Point3dC & operator=(const Point3dC & p): Assigment. Access to the object --------------------
const CoordT & operator[](IndexT i) const: Access to the i-th constant coordinate.
CoordT & operator[](IndexT i): Access to the i-th coordinate.
CoordT & X(): Access to the first coordinate.
CoordT & Y(): Access to the second coordinate.
CoordT & Z(): Access to the third coordinate.
const CoordT & X() const: Access to the first constant coordinate.
const CoordT & Y() const: Access to the second constant coordinate.
const CoordT & Z() const: Access to the third constant coordinate.
const Point3dC & Point() const: Access to the constant point.
Point3dC & Point(): Access to the point. Logical operators with points -----------------------------
BooleanT operator==(const Point3dC & point) const: Returns TRUE if 2 points are the same point. Two points are claimed to be same iff their relative distance error is small (under 'relZero' threshold). If both points are close to the origin of the coordinate system, their absolute distance error is compared to 'zeroDistance'.
BooleanT operator!=(const Point3dC & point) const: Returns TRUE if 2 points are different. 2 points are different iff they are not equal in the sense of the operator '=='.
BooleanT operator>(const Point3dC & point) const: Returns TRUE if all coordinates are bigger then the coordinates of the point.
BooleanT OneBigger(const Point3dC & point) const: Returns TRUE if one coordinate is bigger then the related one of the point. Setting of the point --------------------
Point3dC & SetZero(): Sets all coordinates to be 0.0.
void Set(const Point3dC & point): Sets coordinates according to the values of 'point'.
void Set(const CoordT xCoor,const CoordT yCoor,const CoordT zCoor): Sets the point to the new coordinates.
Point3dC & SetMinimum(const Point3dC & point): Sets the point coordinates to minimal value from both points.
Point3dC & SetMaximum(const Point3dC & point): Sets the point coordinates to maximal value from both points. Information about extrems -------------------------
IndexT MinIndex() const: Returns the index of the minimum value.
IndexT MaxIndex() const: Returns the index of the maximum value.
IndexT AbsMinIndex() const: Returns the index of the minimum coordinate in absolute value.
IndexT AbsMaxIndex() const: Returns the index of the maximum coordinate in absolute value.
CoordT Min() const: Returns the minimum coordinate.
CoordT Max() const: Returns the maximum coordinate. Arithmetical operations -----------------------
const Point3dC & operator+=(const Point3dC & point): Adds the point.
const Point3dC & operator-=(const Point3dC & point): Subtracts the point.
const Point3dC & operator*=(const Point3dC & point): Multiplies items by point items.
const Point3dC & operator/=(const Point3dC & point): Divides items by point items.
const Point3dC & operator*=(const RealT alpha): Multiplies items by 'alpha'.
const Point3dC & operator/=(const RealT alpha): Divides items by 'alpha'.
Point3dC operator+(const Point3dC & v) const: Adds 2 points.
Vector3dC operator-(const Point3dC & v) const: Returns the difference between 2 points.
Point3dC operator*(const Point3dC & v) const: Returns the points which coordinates are results of multiplication of this point and 'v' points item by item.
Point3dC operator/(const Point3dC & v) const: Returns the points which coordinates are results of division of this point and 'v' points item by item.
Point3dC operator*(const RealT alpha) const: Returns the points which coordinates are these coordinates multiplied by 'alpha'.
Point3dC operator/(const RealT alpha) const: Returns the points which coordinates are these coordinates divided by 'alpha'.
Point3dC operator+(const Vector3dC & v) const: Returns the point = 'this point' + v;
RealT operator&(const Point3dC & p) const: Returns the sum X()*p.X() + Y()*p.Y() + Z()*p.Z(). In 3 dimensional Euclidian vector space the result is equivalent to dot product of 2 vectors. Euclidian geometry ------------------
Point3dC Translation(const Point3dC & newOrigin) const: Returns the point with coordinates related to the new origin 'newOrigin'.
RealT SqrEuclidDistance(const Point3dC & point) const: Returns the square of Euclid distance between this point and 'point'.
RealT EuclidDistance(const Point3dC & point) const: Returns the Euclid distance between this point and point.
RealT EDistanceFromOrigin() const: Returns the Euclid distance of this point from the coordinate origin.
CosAngleT CosAngle(const Point3dC & m,const Point3dC & b) const: Returns the cosinus of the angle (this point, m, b).
AngleT Angle(const Point3dC & m,const Point3dC & b) const: Returns the angle (this point, m, b).
AngleT AngleOrigin(const Point3dC & p) const: Returns the angle in rad between points 'this point', (0,0,0), and the point 'p'.
Point3dC MidPoint(const Point3dC & p) const: Returns the point which is in the middle of this point and the point 'p'.
Point3dC Center(const Point3dC & point) const: Returns the point which is in the middle of both points. Useful functions with points ----------------------------
SizeT N() const: Returns the number of coordinates of this point.
RealT AbsDistance(const Point3dC & point) const: Returns the block distance between this point and 'point'.
RealT MahalanobisDistance(const Point3dC & mean,const Matrix3d3C & invCov): Returns the Mahalanobis distance from the 'mean'. The 'invCov' is the inversion of the covariance matrix.
CoordT Sum() const: Returns the sum of coordinates.
CoordT SumAbs() const: Returns the sum of absolute value of coordinates.
Point3dC & Sqrt(): Changes all coordinates into their square root values.
Point3dC & Abs(): Changes all coordinates into their absolute values.
Point3dC & Normalize(): Scales the coordinates of the point to have the distance from the origin equal to 1. The point is supposed to be different from the origin.
Point3dC & NormalizeSum(): Scales the coordinates of the point to have unit sum. The point is supposed to be different from the origin.
Point3dC & MakeUnit(const IndexT i): Scales the coordinates of the point that the i-th coordinate will be equal to 1. The range of the index i is not checked. Relationship with a line ------------------------
Point3dC OrthoProjectionInto(const Line3dPVC & l) const: Returns the orthogonal projection of the point into the line 'l'. Relationship with a plane -------------------------
Point3dC OrthoProjectionTo(const PlanePVV3dC & plane) const: Orthogonal projection of the point into the plane
BooleanT IsOutside(const PlaneABCD3dC & plane) const: Returns TRUE if the point is on the side of the plane where the normal of the plane points to.
BooleanT IsInside(const PlaneABCD3dC & plane) const: Returns TRUE if the point is on the side of the plane where the normal of the plane does not point to. Computational precision -----------------------
void FixAlmostZero(): If the absolute value of a coordinate is smaller than zoroDistance the function sets the coordinate to be zero.
RealT SetZeroDistance(RealT zero): Sets the precision of test of zero distance of points. The function returns the previous value.
BooleanT IsAlmostZero(RealT a): Returns TRUE if 'a' is smaller or equal to zeroDistance.
RealT SetRelZero(RealT zero): Sets the precision of the relative error test. The function returns the previous value.
BooleanT IsRelZero(RealT a): Returns TRUE if 'a' is smaller than or equal to 'relZero'.
RealT RAbs(RealT t): Returns the absolute value of the parameter t.
Point3dC operator*(RealT alpha,const Point3dC & point)
Point3dC operator/(RealT alpha,const Point3dC & point)
ostream & operator<<(ostream & outS,const Point3dC & point)
istream & operator>>(istream & inS,Point3dC & point)
void Set(const Point3dC::CoordT xCoor,const Point3dC::CoordT yCoor,const Point3dC::CoordT zCoor)

Programmer:Radek Marik, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001

Mean3dC

Mean in 3D space

include	"amma/Mean3d.hh"
User Level:	Default
Library:	MeanCov
Example:	exMat2d.cc
Section:	Statistics.3-D
In Scope:	std