]> Creatis software - CreaPhase.git/blobdiff - octave_packages/geometry-1.5.0/shape2d/doc-cache
Add a useful package (from Source forge) for octave
[CreaPhase.git] / octave_packages / geometry-1.5.0 / shape2d / doc-cache
diff --git a/octave_packages/geometry-1.5.0/shape2d/doc-cache b/octave_packages/geometry-1.5.0/shape2d/doc-cache
new file mode 100644 (file)
index 0000000..f94ad03
--- /dev/null
@@ -0,0 +1,266 @@
+# Created by Octave 3.6.2, Sun Jun 10 09:53:43 2012 UTC <root@brouzouf>
+# name: cache
+# type: cell
+# rows: 3
+# columns: 7
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 14
+curve2polyline
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 828
+ -- Function File: POLYLINE =  curve2polyline (CURVE)
+ -- Function File: POLYLINE =  curve2polyline (...,PROPERTY,VALUE,...)
+     Adaptive sampling of a parametric curve.
+
+     The CURVE is described as a 2-by-N matrix. Rows correspond to the
+     polynomial (compatible with `polyval') describing the respective
+     component of the curve. The curve must be parametrized in the
+     interval [0,1].  The vertices of the polyline are accumulated in
+     regions of the curve where the curvature is higher.
+
+     *Parameters*
+    `'Nmax''
+          Maximum number of vertices. Not used.
+
+    `'Tol''
+          Tolerance for the error criteria. Default value `1e-4'.
+
+    `'MaxIter''
+          Maximum number of iterations. Default value `10'.
+
+    `'Method''
+          Not implemented.
+
+     See also: shape2polygon, curveval
+
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 40
+Adaptive sampling of a parametric curve.
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 8
+curveval
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 84
+ -- Function File: P =  curveval (CURVE, T)
+     Evaluates parametric CURVE at T.
+
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 32
+Evaluates parametric CURVE at T.
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 13
+shape2polygon
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 494
+ -- Function File: POLYGON =  shape2polygon (SHAPE)
+ -- Function File: POLYGON =  shape2polygon (...,PROPERTY,VALUE,...)
+     Transforms a 2D shape described by piecewise smooth polynomials
+     into a polygon.
+
+     SHAPE is a n-by-1 cell where each element is a pair of polynomials
+     compatible with polyval.  POLYGON is a k-by-2 matrix, where each
+     row represents a vertex.  The property-value pairs are passed to
+     `curve2polyline'.
+
+     See also: polygon2shape, curve2poyline
+
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 79
+Transforms a 2D shape described by piecewise smooth polynomials into a
+polygon.
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 9
+shapearea
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 407
+ -- Function File:  A = shapearea (PP)
+     Calculate the area of a 2D shape defined with piecewise smooth
+     polynomials.
+
+     Shape is defined with piecewise smooth polynomials. PP is a cell
+     where each elements is a 2-by-(poly_degree+1) array containing a
+     pair of polynomials.
+
+     `px(i,:) = pp{i}(1,:)' and `py(i,:) = pp{i}(2,:)'.
+
+     See also: shapecentroid, shape2polygon, shapeplot
+
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 75
+Calculate the area of a 2D shape defined with piecewise smooth
+polynomials.
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 13
+shapecentroid
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 521
+ -- Function File:  CM = shapecentroid (PP)
+     Centroid of a simple plane shape defined with piecewise smooth
+     polynomials.
+
+     The shape is defined with piecewise smooth polynomials. PP is a
+     cell where each elements is a 2-by-(poly_degree+1) matrix
+     containing a pair of polynomials.  `px(i,:) = pp{i}(1,:)' and
+     `py(i,:) = pp{i}(2,:)'.
+
+     The edges of the shape should not self-intersect. This function
+     does not check for the sanity of the shape.
+
+     See also: shapearea, shape2polygon
+
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 75
+Centroid of a simple plane shape defined with piecewise smooth
+polynomials.
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 9
+shapeplot
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 518
+ -- Function File: H =  shapeplot (SHAPE)
+ -- Function File: H =  shapeplot (SHAPE, N)
+ -- Function File: H =  shapeplot (..., PARAM, VALUE)
+     Pots a 2D shape defined by piecewise smooth polynomials in the
+     current axis.
+
+     PP is a cell where each elements is a 2-by-(poly_degree+1) matrix
+     containing a pair of polynomials.  N is the number of points to be
+     used in non-straight edges.  Additional parameter value pairs are
+     passed to `drawPolygon'.
+
+     See also: drawPolygon, shape2polygon
+
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 76
+Pots a 2D shape defined by piecewise smooth polynomials in the current
+axis.
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 14
+shapetransform
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 463
+ -- Function File: NSHAPE =  shapetransform (SHAPE, T)
+     Applies transformation to a shape defined by piecewise smooth
+     polynomials.
+
+     SHAPE is a cell where each elements is a 2-by-(poly_degree+1)
+     matrix containing a pair of polynomials.
+
+     Format of T can be one of :
+           [c] , [a b] , [a b c] or [a b c]
+           [f]   [d e]   [d e f]    [d e f]
+                                    [0 0 1]
+
+     See also: shape2polygon, shapeplot
+
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 74
+Applies transformation to a shape defined by piecewise smooth
+polynomials.
+
+
+
+
+