README 模板分享

Name

---

• 项目和所有子模块和库的名称（对于新用户，有时不同命名会导致混乱）

• 对所有项目，和所有子模块和库的描述

• 如何使用 5-line code（如果是一个库）

• 版权和许可信息（或阅读许可证）

• 抓取文档指令

• 安装、配置和运行程序的指导

• 抓取最新代码和构建它们的说明（或快速概述和「阅读 Install」）

• 作者列表或「Read AUTHORS」

• 提交bug，功能要求，提交补丁，加入邮件列表，得到通知，或加入用户或开发开发区群的介绍

• 其他联系信息（电子邮件地址，网站，公司名称，地址等）

• 一个简短的历史记录（更改，替换或者其他）

• 法律声明

Apache HTTP Server 的 README 和 GNU 的README 都很简洁清晰。

email: 1287527243qq.com

Name

---

[Badges]

Introduction - 介绍

---

Summary - 概要

Features - 特性

Requirements - 必要条件（环境，对所有项目，和所有子模块和库的描述。）

---

Matlab

Configuration - 配置（配置信息。）

---

Installation - 安装（如何安装。）

---

Usage - 用法（用法。）

---

在文件目录下运行main.cpp

Development - 开发（关于怎样开发的文档信息。（API 等。））

---

Changelog - 更新日志（一个简短的历史记录（更改，替换或者其他）。）

---

FAQ - 常见问题（常见问题。）

---

Support - 支持

---

Dos - 文档（更多文档。）

Contact - 联系（其他联系信息（电子邮件地址，网站，公司名称，地址等）。提交bug，功能要求，提交补丁，加入邮件列表，得到通知，或加入用户或开发开发区群的介绍。）

email: 1287527243@qq.com

Authors and acknowledgment - 贡献者和感谢（作者列表和鸣谢。）

---

Cao Jupeng

License - 版权信息（版权和许可信息（或阅读许可证）、法律声明。）

---

Scut Srp

模板2

Scattered Points Interpolation with Globally Smooth B-Spline Surface using Iterative Knot Insertion

---

The implementation of the paper "Scattered Points Interpolation with Globally Smooth B-Spline Surface using Iterative Knot Insertion".

Introduction

---

Our algorithm generates a single B-spline surface patch which interpolates the given scattered 3d data points. The inputs are the scattered 3d data points and their parametrization (in domain [0, 1] x [0, 1]). The output is the generated B-spline surface.

The advantage of our algorithm is that the input data points do not need to be distributed in rows or in grid points (like tranditional interpolation methods always do), but can be scattered, non-uniformly distributed. The generated surfaces, as they are interpolation surfaces, can often maintain a high precision in shape reconstruction, and, often use less control points, thanks to the Proposition we proposed and proved in our paper.

The code is implemented in C++, containing functions for B-spline basis calculation, knot vector generation, thin-plate energy calculation, control points solving, and, some polynomial operators(+, -, x, /, differential, integration, etc.). We also have some other interpolation/ approximation algorithms implemented in our code. We hope the code can help the users feel convient and comfortable to use B-splines.

This code is tested on Windows and Linux, and it probably works on Mac.

Build

---

Before build the code, you need to have CMake installed on your machine. To build the library and executable benchmark on Linux or macOS run:

mkdir build

cd build

cmake .. -DCMAKE_BUILD_TYPE=Release

make

Usage

---

To interpolate scattered data points, just do:

#include <sparse_interp/Types.hpp>

Then, you can access the classes Bcurve and Bsurface. We have a tutorial example in app/example.cpp telling you how to initialize the classes, how to solve the interpolation surface, how to convert the B-spline surface into a triangular mesh, etc. You can read our paper for more details:

@article{Jiang:2022:Scattered,
     title        = {Scattered Points Interpolation with Globally Smooth B-Spline Surface using Iterative Knot Insertion},
     author       = {Xin Jiang and Bolun Wang and Guanying Huo and Cheng Su and Dong-Ming Yan and Zhiming Zheng},
     year         = 2022,
     journal      = {Computer-Aided Design},
     volume       = {148},
     pages        = {103244},
     issn         = {0010-4485}
 }

In app/test.h we also provide you some functions for some other classical methods we implemented, including Lofting method [Wen-Ke Wang et al, 2008, CAD], Multilevel B-spline [Seungyong Lee, et al., 1997, TVCG], Averaging method, [Piegl et al. 1996, The NURBS book] and IGA [Kineri et al. 2012, CAD]. We will continue to maintain the library, adding more methods for the users to choose (Actually, by assembling the existing functions, you can have many more trianditional methods. But we will provide you the interface, so that you do not need to look deep into the low-level functions).

Examples in our paper

---

We provide some functions to run the results shown in our paper.

1. Benchmark models

./Sparse_Interp_bin benchmarks delta per nbr outpath

where delta and per are two input parameters, ranging from 0 to 1, we recommand that delta = 0.9 and per = 0.5. nbr is the number of sampled points, we suggest to choose a number no more than 500. outpath is the output path. For example, on Windows, you can run ./Sparse_Interp_bin benchmarks 0.9 0.5 100 C:\\.

2. Mesh models Similarly, you can get the 2 mesh model interpolation results in the paper by running

./Sparse_Interp_bin meshes modelname outpath

where modelname choose between mask3kf.obj and tiger.obj. For example, run ./Sparse_Interp_bin meshes mask3kf.obj C:\\.

3. Reproduction of local non-smoothnessYou can run the results of Figure 7 in the paper, by

./Sparse_Interp_bin reproduce outpath

It will reproduce the non-smoothness problem by inserting a lot of redundant knots into a fine surface, and reduce local energy by inserting knots to regions with large energy.

4. Fixing local non-smoothness caused by too few data pointsYou can run the results of Figure 7 in the paper, by

./Sparse_Interp_bin local_energy outpath

It will produce the results in Figure 9.

5. The Outputs of the examples

After running the code, in outpath there will be a interpolation surface in .obj format, and for each interpolation surface, there is a corresponding .csv file recording its runtime, maximal interpolation error, and the number of control points. After running the benchmarks, the 6 benchmark models: Peak, Drop, Hyperbolic, Sinus, Bilinear and Snail will be output into outpath. After running the results in Figure 7 and Figure 9, the maximal energy for each iteration will also be written into the .csv files.

Contact

---

The code is far from being perfect, e.g. solving stability problem for large amount of data points. If you have problem using our code, or you have a bug to report, please contact us by wangbolun@buaa.edu.cn, or post an issue on GitHub. We'd appreciate to have your contribution. If you are using our code in your projects, please contact us and briefly tell us what you use it for. That will all become the motivation we maintaining the code.

TODO

---

1. replace the current sparse linear system solver since it is unefficient and momery-consuming.

2. provide interface for classical least-square method for surface and curve interpolation.