https://github.com/thomasp85/ambient

A Generator of Multidimensional Noise
https://github.com/thomasp85/ambient

Last synced: about 2 months ago
JSON representation

A Generator of Multidimensional Noise

• Host: GitHub
• URL: https://github.com/thomasp85/ambient
• Owner: thomasp85
• License: other
• Created: 2018-08-23T21:04:07.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2022-09-09T07:07:24.000Z (about 2 years ago)
• Last Synced: 2024-07-20T13:24:51.475Z (2 months ago)
• Language: R
• Homepage: https://ambient.data-imaginist.com
• Size: 273 MB
• Stars: 93
• Watchers: 7
• Forks: 8
• Open Issues: 4
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, echo = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  dev.args = list(bg = NA)

)

set.seed(1)

```

# ambient 

[![R-CMD-check](https://github.com/thomasp85/ambient/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/thomasp85/ambient/actions/workflows/R-CMD-check.yaml)

[![CRAN_Release_Badge](http://www.r-pkg.org/badges/version-ago/ambient)](https://CRAN.R-project.org/package=ambient)

[![CRAN_Download_Badge](http://cranlogs.r-pkg.org/badges/ambient)](https://CRAN.R-project.org/package=ambient)

[![Codecov test coverage](https://codecov.io/gh/thomasp85/ambient/branch/main/graph/badge.svg)](https://app.codecov.io/gh/thomasp85/ambient?branch=main)

`ambient` is a an R package that provides access to the 

[FastNoise](https://github.com/Auburn/FastNoiseLite) C++ library for generating

noise. As such it provides fast generation of perlin, value, cubic, and worley

noise in 2 and 3 dimensions, as well as simplex and white noise in 2, 3, and 4

dimensions. Further, it provides pattern generators and other utilities that can

be used for modifying and working with noise.

Most of the noise patterns can be generated as fractals as well with support for

fbm, billow and rigid-multifractal, and can optionally be pertubed.

There's not much more to it. If you are in need of a noise generator `ambient`

is your friend, if not you probably shouldn't care.

## Installation

ambient can be installed from CRAN using `install.packages('ambient')`, or you

may get the development version from github using devtools:

```{r, eval=FALSE}

# install.packages('devtools')

devtools::install_github('thomasp85/ambient')

```

## Examples

ambient provides a direct interface to the FastNoise functions by requesting a

matrix/array of noise values, with a range of settings for pertubation and 

fractals:

```{r, fig.asp=1}

library(ambient)

simplex <- noise_simplex(c(500, 500), pertubation = 'normal', 

                         pertubation_amplitude = 40)

plot(as.raster(normalise(simplex)))

```

much more powerful, however, is the tidy interface that allows full control of

how the values should be calculated and combined:

```{r, fig.asp=1, message=FALSE, warning=FALSE}

library(dplyr)

long_grid(x = seq(0, 10, length.out = 1000), 

          y = seq(0, 10, length.out = 1000)) %>% 

  mutate(

    x1 = x + gen_simplex(x, y) / 2, 

    y1 = y + gen_simplex(x, y) / 2,

    worley = gen_worley(x, y, value = 'distance', seed = 5),

    worley_frac = fracture(gen_worley, ridged, octaves = 8, x = x, y = y, 

                           value = 'distance', seed = 5),

    full = blend(normalise(worley), normalise(worley_frac), gen_spheres(x1, y1))

  ) %>% 

  plot(full)

```

## Code of Conduct

Please note that the 'ambient' project is released with a

[Contributor Code of Conduct](https://ambient.data-imaginist.com/CODE_OF_CONDUCT.html).

By contributing to this project, you agree to abide by its terms.