Functions
function	getBorder (in gramian, in center, in npnt)
	Return a matrix of MATLAB doubles of shape `[npnt, 2]` containing the coordinates of a set of points on the boundary of a 2D ellipsoid whose Gramian matrix is specified as input and whose center is also optionally specified. More...

Function Documentation

◆ getBorder()

function getBorder	(	in	gramian,
		in	center,
		in	npnt
	)

Return a matrix of MATLAB doubles of shape [npnt, 2] containing the coordinates of a set of points on the boundary of a 2D ellipsoid whose Gramian matrix is specified as input and whose center is also optionally specified.

Parameters

[in]	gramian	: The input square matrix of MATLAB doubles of shape `[2, 2]` containing the Gramian of the target 2D ellipsoid whose boundary points are to be returned. (optional. If not present or empty, the default is `eye(2, 2)`.)
[in]	center	: The input vector of MATLAB doubles of size `2` containing the 2D coordinates of the center of the target 2D ellipsoid whose boundary points are to be returned. (optional. If not present or empty, the default is `zeros(2, 1)`.)
[in]	npnt	: The input scalar MATLAB whole number containing the number of points to return on the boundary of the target 2D ellipsoid. (optional, default = `50`.)

Returns: bcrd : The output matrix of MATLAB doubles of shape [npnt, 2] containing the coordinates of a set of npnt points on the boundary of the target 2D ellipsoid.

Possible calling interfaces ⛓

: bcrd = pm.geom.ell2.getBorder();

bcrd = pm.geom.ell2.getBorder(gramian);

bcrd = pm.geom.ell2.getBorder(gramian, center);

bcrd = pm.geom.ell2.getBorder(gramian, center, npnt);

bcrd = pm.geom.ell2.getBorder([], [], []);

See also: pm.geom.ell2.getBorders
pm.vis.CascadeEllipse
pm.vis.SubplotEllipse
pm.vis.PlotEllipse
pm.vis.TileEllipse

Example usage ⛓

: 1cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.

2addpath('../../../../'); % Add the ParaMonte library root directory to the search path.

3

4bcrd = pm.geom.ell2.getBorder();

5p = pm.vis.PlotLine(bcrd);

6p.make("colx", 1, "coly", 2);

7p.savefig("getBorder.2d.png", "-m3");

8

9bcrd = pm.geom.ell2.getBorder([], []);

10bcrd = [bcrd, zeros(size(bcrd, 1), 1)];

11p = pm.vis.PlotLine3(bcrd);

12p.make("colx", 1, "coly", 2, "colz", 3);

13p.savefig("getBorder.3d.png", "-m3");

14

15npnt = 500;

16range = 10 * pi * [-1 : 2 / (npnt - 1) : 1]';

17bcrd = [pm.geom.ell2.getBorder([], [], npnt), sin(range / 5) + sin(range) / 5];

18p = pm.vis.PlotLine3(bcrd);

19p.make("colx", 1, "coly", 2, "colz", 3);

20p.savefig("getBorder.wavy.png", "-m3");

root
function root()
Return a scalar MATLAB string containing the root directory of the ParaMonte library package.

Visualization of the example output ⛓

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Amir Shahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin

Functions

Function Documentation

◆ getBorder()