All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

Mathematics Class CATMathTransformation1D

CATMathTransformation1D
 

Usage: you must use this class as is. You should never derive it.


public class CATMathTransformation1D

Class defining a transformation in a 1D space.

t(x) = a*x + b.


Constructor and Destructor Index


o CATMathTransformation1D()
Constructs the identity 1D transformation.
o CATMathTransformation1D(CATMathTransformation1D&)
Copy constructor.
o CATMathTransformation1D(double*)
Constructs a 1D transformation.
o CATMathTransformation1D(double,double)
Constructs a 1D transformation.
o CATMathTransformation1D(double,double,double,double)
o ~CATMathTransformation1D()

Method Index


o Apply(double)
Transforms a double.
o GetCoef(double[])
Retrieves the coefficients.
o GetMatrix1D()
Returns the scale coefficient.
o GetVector1D()
Returns the shift coefficient.
o Set(double,double,double,double)
Creates the linear transformation that transforms iX0 into iFx0 and iX1 into iFx1.
o SetCoef(double[])
Modifies the coefficients.

Constructor and Destructor


o CATMathTransformation1D
public CATMathTransformation1D()
Constructs the identity 1D transformation.
t(x) = x .
o CATMathTransformation1D
public CATMathTransformation1D( const CATMathTransformation1D& iTransfo1DToCopy)
Copy constructor.
o CATMathTransformation1D
public CATMathTransformation1D(double* iArray)
Constructs a 1D transformation.
t(x) = iArray[0]*x + iArray[1].
Parameters:
iArray
The array of the scale and shift coefficient.
o CATMathTransformation1D
public CATMathTransformation1D(double iA,
double iB)
Constructs a 1D transformation.
t(x) = iA*x + iB.
Parameters:
iA
The scale coefficient.
iB
The shift coefficient.
o CATMathTransformation1D
public CATMathTransformation1D( const double iX0,
const double iFx0,
const double iX1,
const double iFx1)
Deprecated:
V5R20 Set Creates the linear transformation that transforms ix0 into ifx0 and ix1 into ifx1.
ix0 must be different from ix1, but this is not checked.
o ~CATMathTransformation1D
public ~CATMathTransformation1D()

Methods


o Apply
public double Apply(double iParamToTransform) const
Transforms a double.
Parameters:
iParamToTransform
The double to transform.
Returns:
The result of the transformation.
o GetCoef
public void GetCoef(double[] ioCoef) const
Retrieves the coefficients.
Parameters:
ioCoef
The array (that must be already allocated).
t(x) = ioCoef[0]*x + ioCoef[1].
o GetMatrix1D
public double GetMatrix1D()const
Returns the scale coefficient.
Returns:
The scale coefficient.
o GetVector1D
public double GetVector1D()const
Returns the shift coefficient.
Returns:
The shift coefficient.
o Set
public HRESULT Set( const double iX0,
const double iFx0,
const double iX1,
const double iFx1)
Creates the linear transformation that transforms iX0 into iFx0 and iX1 into iFx1.
Parameters:
iX0
Double.
iFx0
Image of iX0 by the requested transformation.
iX1
Double.
iFx1
Image of iX1 by the requested transformation.
Returns:
E_FAIL if iX0 is equal to iX1 but not iFx0 and iFx1, otherwise S_OK In case of failure, the computed transformation is the identity.
o SetCoef
public void SetCoef( const double[] iNewCoef)
Modifies the coefficients.
Parameters:
iNewCoef
The array of the new coefficients.

This object is included in the file: CATMathTransformation1D.h
If needed, your Imakefile.mk should include the module: CATMathematics

Copyright © 2003, Dassault Systèmes. All rights reserved.