# Documentation

```{include} ../../README.md
```

## Main API

### Stippling

```{eval-rst}
.. autosummary::
   :toctree: generated/

   blue_sampler.im2points
```

### Sampling

```{eval-rst}
.. autosummary::
   :toctree: generated/

   blue_sampler.sample_points
   blue_sampler.sample_tessels
   blue_sampler.sample_clusters
   blue_sampler.tile
   blue_sampler.from_geometry
```

### Analysis

```{eval-rst}
.. autosummary::
   :toctree: generated/

   blue_sampler.structure_factor
```

### Visualization

```{eval-rst}
.. autosummary::
   :toctree: generated/

   blue_sampler.plot
   blue_sampler.plot_structure_factor
   blue_sampler.plot_tessels
   blue_sampler.plot_clusters
```

### Datasets

```{eval-rst}
.. autosummary::
   :toctree: generated/

   blue_sampler.generate_dataset
```

```{toctree}
:hidden:

modules
```