include/opencascade/BRepApprox_MyBSplGradientOfTheComputeLineOfApprox.hxx

0001 // Created on: 1995-06-06
0002 // Created by: Jean Yves LEBEY
0003 // Copyright (c) 1995-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _BRepApprox_MyBSplGradientOfTheComputeLineOfApprox_HeaderFile
0018 #define _BRepApprox_MyBSplGradientOfTheComputeLineOfApprox_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <AppParCurves_MultiBSpCurve.hxx>
0025 #include <math_Vector.hxx>
0026 #include <Standard_Real.hxx>
0027 #include <Standard_Integer.hxx>
0028 #include <AppParCurves_HArray1OfConstraintCouple.hxx>
0029 #include <TColStd_Array1OfReal.hxx>
0030 #include <TColStd_Array1OfInteger.hxx>
0031 class Standard_OutOfRange;
0032 class StdFail_NotDone;
0033 class BRepApprox_TheMultiLineOfApprox;
0034 class BRepApprox_TheMultiLineToolOfApprox;
0035 class BRepApprox_BSpParLeastSquareOfMyBSplGradientOfTheComputeLineOfApprox;
0036 class BRepApprox_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfApprox;
0037 class BRepApprox_BSpGradient_BFGSOfMyBSplGradientOfTheComputeLineOfApprox;
0038 class AppParCurves_MultiBSpCurve;
0039
0040 class BRepApprox_MyBSplGradientOfTheComputeLineOfApprox
0041 {
0042 public:
0043   DEFINE_STANDARD_ALLOC
0044
0045   //! Tries to minimize the sum (square(||Qui - Bi*Pi||))
0046   //! where Pui describe the approximating BSpline curves'Poles
0047   //! and Qi the MultiLine points with a parameter ui.
0048   //! In this algorithm, the parameters ui are the unknowns.
0049   //! The tolerance required on this sum is given by Tol.
0050   //! The desired degree of the resulting curve is Deg.
0051   Standard_EXPORT BRepApprox_MyBSplGradientOfTheComputeLineOfApprox(
0052     const BRepApprox_TheMultiLineOfApprox&                SSP,
0053     const Standard_Integer                                FirstPoint,
0054     const Standard_Integer                                LastPoint,
0055     const Handle(AppParCurves_HArray1OfConstraintCouple)& TheConstraints,
0056     math_Vector&                                          Parameters,
0057     const TColStd_Array1OfReal&                           Knots,
0058     const TColStd_Array1OfInteger&                        Mults,
0059     const Standard_Integer                                Deg,
0060     const Standard_Real                                   Tol3d,
0061     const Standard_Real                                   Tol2d,
0062     const Standard_Integer                                NbIterations = 1);
0063
0064   //! Tries to minimize the sum (square(||Qui - Bi*Pi||))
0065   //! where Pui describe the approximating BSpline curves'Poles
0066   //! and Qi the MultiLine points with a parameter ui.
0067   //! In this algorithm, the parameters ui are the unknowns.
0068   //! The tolerance required on this sum is given by Tol.
0069   //! The desired degree of the resulting curve is Deg.
0070   Standard_EXPORT BRepApprox_MyBSplGradientOfTheComputeLineOfApprox(
0071     const BRepApprox_TheMultiLineOfApprox&                SSP,
0072     const Standard_Integer                                FirstPoint,
0073     const Standard_Integer                                LastPoint,
0074     const Handle(AppParCurves_HArray1OfConstraintCouple)& TheConstraints,
0075     math_Vector&                                          Parameters,
0076     const TColStd_Array1OfReal&                           Knots,
0077     const TColStd_Array1OfInteger&                        Mults,
0078     const Standard_Integer                                Deg,
0079     const Standard_Real                                   Tol3d,
0080     const Standard_Real                                   Tol2d,
0081     const Standard_Integer                                NbIterations,
0082     const Standard_Real                                   lambda1,
0083     const Standard_Real                                   lambda2);
0084
0085   //! returns True if all has been correctly done.
0086   Standard_EXPORT Standard_Boolean IsDone() const;
0087
0088   //! returns all the BSpline curves approximating the
0089   //! MultiLine SSP after minimization of the parameter.
0090   Standard_EXPORT AppParCurves_MultiBSpCurve Value() const;
0091
0092   //! returns the difference between the old and the new
0093   //! approximation.
0094   //! An exception is raised if NotDone.
0095   //! An exception is raised if Index<1 or Index>NbParameters.
0096   Standard_EXPORT Standard_Real Error(const Standard_Integer Index) const;
0097
0098   //! returns the maximum difference between the old and the
0099   //! new approximation.
0100   Standard_EXPORT Standard_Real MaxError3d() const;
0101
0102   //! returns the maximum difference between the old and the
0103   //! new approximation.
0104   Standard_EXPORT Standard_Real MaxError2d() const;
0105
0106   //! returns the average error between the old and the
0107   //! new approximation.
0108   Standard_EXPORT Standard_Real AverageError() const;
0109
0110 protected:
0111   Standard_EXPORT void Perform(const BRepApprox_TheMultiLineOfApprox&                SSP,
0112                                const Standard_Integer                                FirstPoint,
0113                                const Standard_Integer                                LastPoint,
0114                                const Handle(AppParCurves_HArray1OfConstraintCouple)& TheConstraints,
0115                                math_Vector&                                          Parameters,
0116                                const TColStd_Array1OfReal&                           Knots,
0117                                const TColStd_Array1OfInteger&                        Mults,
0118                                const Standard_Integer                                Deg,
0119                                const Standard_Real                                   Tol3d,
0120                                const Standard_Real                                   Tol2d,
0121                                const Standard_Integer NbIterations = 200);
0122
0123 private:
0124   AppParCurves_MultiBSpCurve SCU;
0125   math_Vector                ParError;
0126   Standard_Real              AvError;
0127   Standard_Real              MError3d;
0128   Standard_Real              MError2d;
0129   Standard_Real              mylambda1;
0130   Standard_Real              mylambda2;
0131   Standard_Boolean           myIsLambdaDefined;
0132   Standard_Boolean           Done;
0133 };
0134
0135 #endif // _BRepApprox_MyBSplGradientOfTheComputeLineOfApprox_HeaderFile