Simbody  3.5
BicubicSurface.h
Go to the documentation of this file.
1 #ifndef SimTK_BICUBIC_SURFACE_H_
2 #define SimTK_BICUBIC_SURFACE_H_
3 
4 /* -------------------------------------------------------------------------- *
5  * Simbody(tm): SimTKmath *
6  * -------------------------------------------------------------------------- *
7  * This is part of the SimTK biosimulation toolkit originating from *
8  * Simbios, the NIH National Center for Physics-Based Simulation of *
9  * Biological Structures at Stanford, funded under the NIH Roadmap for *
10  * Medical Research, grant U54 GM072970. See https://simtk.org/home/simbody. *
11  * *
12  * Portions copyright (c) 2011-12 Stanford University and the Authors. *
13  * Authors: Matthew Millard, Michael Sherman *
14  * Contributors: *
15  * *
16  * Licensed under the Apache License, Version 2.0 (the "License"); you may *
17  * not use this file except in compliance with the License. You may obtain a *
18  * copy of the License at http://www.apache.org/licenses/LICENSE-2.0. *
19  * *
20  * Unless required by applicable law or agreed to in writing, software *
21  * distributed under the License is distributed on an "AS IS" BASIS, *
22  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
23  * See the License for the specific language governing permissions and *
24  * limitations under the License. *
25  * -------------------------------------------------------------------------- */
26 
31 #include "SimTKcommon.h"
33 #include "simmath/internal/Geo.h"
36 
37 #include <limits>
38 
39 namespace SimTK {
40 
41 //==============================================================================
42 // CLASS BICUBIC SURFACE
43 //==============================================================================
159 public:
160  class PatchHint; // See below for definition of PatchHint.
161 
164  BicubicSurface() : guts(0) {}
167  ~BicubicSurface();
170  BicubicSurface(const BicubicSurface& source);
175  BicubicSurface& operator=(const BicubicSurface& source);
176 
177 
201  BicubicSurface(const Vector& x, const Vector& y, const Matrix& f,
202  Real smoothness=0);
203 
231  BicubicSurface(const Vec2& XY, const Vec2& spacing,
232  const Matrix& f, Real smoothness=0);
233 
247  Real calcValue(const Vec2& XY, PatchHint& hint) const;
248 
252  Real calcValue(const Vec2& XY) const;
253 
266  UnitVec3 calcUnitNormal(const Vec2& XY, PatchHint& hint) const;
267 
271  UnitVec3 calcUnitNormal(const Vec2& XY) const;
272 
298  Real calcDerivative(const Array_<int>& derivComponents,
299  const Vec2& XY, PatchHint& hint) const;
300 
304  Real calcDerivative(const Array_<int>& derivComponents,
305  const Vec2& XY) const;
306 
318  bool isSurfaceDefined(const Vec2& XY) const;
319 
322  Vec2 getMinXY() const;
325  Vec2 getMaxXY() const;
326 
335  PolygonalMesh createPolygonalMesh(Real resolution=1) const;
336 
337  //--------------------------------------------------------------------------
347  int getNumAccesses() const;
353  int getNumAccessesSamePoint() const;
359  int getNumAccessesSamePatch() const;
366  int getNumAccessesNearbyPatch() const;
371  void resetStatistics() const;
375  //--------------------------------------------------------------------------
393  BicubicSurface(const Vector& x, const Vector& y, const Matrix& f,
394  const Matrix& fx, const Matrix& fy, const Matrix& fxy);
396  BicubicSurface(const Vec2& XY, const Vec2& spacing, const Matrix& f,
397  const Matrix& fx, const Matrix& fy, const Matrix& fxy);
398 
423  void calcParaboloid(const Vec2& XY, PatchHint& hint,
424  Transform& X_SP, Vec2& k) const;
428  void calcParaboloid(const Vec2& XY, Transform& X_SP, Vec2& k) const;
429 
433  void getNumPatches(int& nx, int& ny) const;
434 
438  Geo::BicubicHermitePatch calcHermitePatch(int x, int y) const;
439 
443  Geo::BicubicBezierPatch calcBezierPatch(int x, int y) const;
446  //--------------------------------------------------------------------------
455  bool isEmpty() const {return guts==0;}
456 
462  void clear(); // Hide from Doxygen.
466  class Guts; // Opaque implementation class.
467  const BicubicSurface::Guts& getGuts() const
468  { assert(guts); return *guts; }
470 private:
471  BicubicSurface::Guts* guts;
472 }; // END class BicubicSurface
473 
474 
475 
476 //==============================================================================
477 // CLASS BICUBIC FUNCTION :: PATCH HINT
478 //==============================================================================
483 public:
486  PatchHint();
489  PatchHint(const PatchHint& source);
493  PatchHint& operator=(const PatchHint& source);
495  ~PatchHint();
496 
499  bool isEmpty() const;
502  void clear();
503  // Hide from Doxygen
505  class Guts; // Hidden implementation of PatchHint.
506  const Guts& getGuts() const {return *guts;}
507  Guts& updGuts() {return *guts;}
509 private:
510  Guts* guts;
511 };
512 
513 
514 
515 //==============================================================================
516 // CLASS BICUBIC FUNCTION
517 //==============================================================================
518 
533 public:
536  BicubicFunction(const BicubicSurface& surface) : surface(surface) {}
537 
540  const BicubicSurface& getBicubicSurface() const {return surface;}
541 
549  virtual Real calcValue(const Vector& XY) const {
550  SimTK_ERRCHK1(XY.size()==2, "BicubicFunction::calcValue()",
551  "The argument Vector XY must have exactly 2 elements but had %d.",
552  XY.size());
553  return surface.calcValue(Vec2(XY[0],XY[1]), hint);
554  }
555 
575  virtual Real calcDerivative(const Array_<int>& derivComponents,
576  const Vector& XY) const {
577  SimTK_ERRCHK1(XY.size()==2, "BicubicFunction::calcDerivative()",
578  "The argument Vector XY must have exactly 2 elements but had %d.",
579  XY.size());
580  return surface.calcDerivative(derivComponents, Vec2(XY[0],XY[1]), hint);
581  }
582 
585  virtual int getArgumentSize() const {return 2;}
586 
592  virtual int getMaxDerivativeOrder() const
593  { return std::numeric_limits<int>::max(); }
594 private:
595  BicubicSurface surface;
596  mutable BicubicSurface::PatchHint hint;
597 };
598 
599 
600 
601 }; //namespace
602 //=============================================================================
603 //=============================================================================
604 
605 #endif // SimTK_BICUBIC_SURFACE_H_
This class will create a smooth surface that approximates a two-argument function F(X...
Definition: BicubicSurface.h:158
BicubicFunction(const BicubicSurface &surface)
Create a BicubicFunction referencing the given BicubicSurface, which is shared not copied...
Definition: BicubicSurface.h:536
bool isEmpty() const
Return true if this is an empty handle meaning that it does not currently refer to any surface...
Definition: BicubicSurface.h:455
BicubicSurface()
Construct an uninitialized BicubicSurface handle.
Definition: BicubicSurface.h:164
This is the top-level SimTK namespace into which all SimTK names are placed to avoid collision with o...
Definition: Assembler.h:37
Provides primitive operations for a single bicubic Bezier patch using either single or double precisi...
int size() const
Definition: VectorBase.h:396
const BicubicSurface & getBicubicSurface() const
Return a reference to the BicubicSurface object being used by this BicubicFunction.
Definition: BicubicSurface.h:540
SimTK_Real Real
This is the default compiled-in floating point type for SimTK, either float or double.
Definition: SimTKcommon/include/SimTKcommon/internal/common.h:593
virtual int getArgumentSize() const
This implements the Function base class pure virtual; here it always returns 2 (X and Y)...
Definition: BicubicSurface.h:585
virtual Real calcDerivative(const Array_< int > &derivComponents, const Vector &XY) const
Calculate a partial derivative of this function at a particular point.
Definition: BicubicSurface.h:575
Includes internal headers providing declarations for the basic SimTK Core classes, including Simmatrix.
#define SimTK_ERRCHK1(cond, whereChecked, fmt, a1)
Definition: ExceptionMacros.h:326
ELEM max(const VectorBase< ELEM > &v)
Definition: VectorMath.h:251
Defines geometric primitive shapes and algorthms.
virtual int getMaxDerivativeOrder() const
This implements the Function base class pure virtual specifying how many derivatives can be taken of ...
Definition: BicubicSurface.h:592
This is a two-argument Function built using a shared BicubicSurface and managing current state to opt...
Definition: BicubicSurface.h:532
This abstract class represents a mathematical function that calculates a value of arbitrary type base...
Definition: Function.h:51
This class provides a description of a mesh made of polygonal faces (not limited to triangles)...
Definition: PolygonalMesh.h:70
This is the header file that every Simmath compilation unit should include first. ...
Provides primitive operations for a single bicubic Hermite patch using either single or double precis...
A primitive useful for computations involving a single bicubic Hermite patch.
Definition: Geo.h:66
virtual Real calcValue(const Vector &XY) const
Calculate the value of the function at a particular XY coordinate.
Definition: BicubicSurface.h:549
A primitive useful for computations involving a single bicubic Bezier patch.
Definition: Geo.h:68
#define SimTK_SIMMATH_EXPORT
Definition: SimTKmath/include/simmath/internal/common.h:64
This object is used to hold precalculated data about the most recently accessed patch to accelerate t...
Definition: BicubicSurface.h:482
Vec< 2 > Vec2
This is the most common 2D vector type: a column of 2 Real values stored consecutively in memory (pac...
Definition: SmallMatrix.h:126