Skip to content

Commit 45fce51

Browse files
committed
docs: add API documentation links for Pixels, Signals, Signatures, Shape, SpectralImage, and SpectralImageSet classes
1 parent 602494b commit 45fce51

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

docs/concepts/entities.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ The class structure is depicted in the following diagram:
2626

2727
## Pixels
2828

29+
??? api "API Documentation"
30+
[`siapy.entities.Pixels`][siapy.entities.Pixels]<br>
31+
2932
The `Pixels` class represents spatial coordinates within spectral image, providing a container for *(x, y)* coordinate pairs. It uses pandas DataFrame internally for storage, enabling high-performance operations. The class provides multiple initialization methods and conversion functions to work with different data representations (i.e. DataFrames, list, arrays)
3033

3134
```python
@@ -34,6 +37,9 @@ The `Pixels` class represents spatial coordinates within spectral image, providi
3437

3538
## Signals
3639

40+
??? api "API Documentation"
41+
[`siapy.entities.signatures.Signals`][siapy.entities.signatures.Signals]<br>
42+
3743
The `Signals` class stores spectral data for each pixel in a pandas DataFrame, allowing you to use any column names you choose (e.g. "band_1", "nir", "red_edge"). You can initialize it from a DataFrame, lists, dicts or NumPy arrays.
3844

3945
```python
@@ -44,6 +50,9 @@ However, direct initialization of `Signals` is typically not necessary in practi
4450

4551
## Signatures
4652

53+
??? api "API Documentation"
54+
[`siapy.entities.Signatures`][siapy.entities.Signatures]<br>
55+
4756
The `Signatures` class represents spectral data collections by combining spatial coordinates (`Pixels`) with their corresponding spectral values (`Signals`). It provides a unified container that maintains the spatial-spectral relationship, allowing for analysis of spectral information at specific image locations. Internally, the data is stored as pandas DataFrames for efficient operations and indexing.
4857

4958
`Signatures` can be initialized in multiple ways. The explicit approach creates each component separately before combining them, providing clarity about the composition:
@@ -66,6 +75,9 @@ Both approaches yield equivalent results when initialized with the same data. Yo
6675

6776
## Shape
6877

78+
??? api "API Documentation"
79+
[`siapy.entities.Shape`][siapy.entities.Shape]<br>
80+
6981
The `Shape` class represents geometric shapes that can be associated with images, such as points, lines, and polygons.
7082

7183
```python
@@ -74,6 +86,9 @@ The `Shape` class represents geometric shapes that can be associated with images
7486

7587
## Spectral Image
7688

89+
??? api "API Documentation"
90+
[`siapy.entities.SpectralImage`][siapy.entities.SpectralImage]<br>
91+
7792
A `SpectralImage` is the primary container for spectral image data. It's a generic class that can wrap different image backends, allowing you to work with various file formats through a unified interface.
7893

7994
### Image Initialization Options
@@ -112,6 +127,9 @@ For specialized file formats or custom processing needs, you can extend the Imag
112127

113128
## Spectral Image Set
114129

130+
??? api "API Documentation"
131+
[`siapy.entities.SpectralImageSet`][siapy.entities.SpectralImageSet]<br>
132+
115133
The `SpectralImageSet` class manages a collection of spectral images.
116134

117135
```python

0 commit comments

Comments
 (0)