
<!-- README.md is generated from README.Rmd. Please edit that file -->

# `SparseVFC`: Sparse Vector Field Consensus for Vector Field Learning

<!-- badges: start -->

[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/SparseVFC)](https://cran.r-project.org/package=SparseVFC)
[![](https://cranlogs.r-pkg.org/badges/SparseVFC)](https://cran.r-project.org/package=SparseVFC)
<!-- badges: end -->

The `SparseVFC` package is an R implementation of the sparse vector
field consensus (SparseVFC) algorithm (Ma et al., 2013
<https://doi.org/10.1016/j.patcog.2013.05.017>) for robust vector field
learning. Largely translated from the Matlab functions in
<https://github.com/jiayi-ma/VFC>.

See the vignette of the package for a demonstration.

## Installation

You can install the released version of `SparseVFC` from
[CRAN](https://cran.r-project.org/) with:

``` r
install.packages("SparseVFC")
```

You can install the development version of SparseVFC from
[GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("Sciurus365/SparseVFC")
```
