Skip to content

add media type recommendations #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

- Add HSI extension initial description [#1](https://github.com/pomadchin/hsi/pull/1)
- Add media type recommendations
- Add HSI extension initial description
Comment on lines +12 to +13
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we wanna keep track of the PRs in the changelog? I can't readjust it later as well.


### Changed

Expand Down
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,28 @@ Properties or `Item Asset` Fields to simplify items search. It may be extended w

## Item Properties or Asset Fields

| Field Name | Type | Description |
| -------------------- | ------------------------- | ----------- |
| hsi:wavelength_min | \[number] | **REQUIRED**. Min center wavelength of the item, in micrometers (μm) |
| hsi:wavelength_max | \[number] | **REQUIRED**. Max center wavelength of the item, in micrometers (μm) |
| Field Name | Type | Description |
| ------------------ | --------- | -------------------------------------------------------------------- |
| hsi:wavelength_min | \[number] | **REQUIRED**. Min center wavelength of the item, in micrometers (μm) |
| hsi:wavelength_max | \[number] | **REQUIRED**. Max center wavelength of the item, in micrometers (μm) |

## Media Types

This section describes the recommended media types to use for various hyperspectral
image formats.

| Name | Media Type | Notes |
| ----------------------------- | -------------------------------------------------------- | ------------------ |
| GeoTIFF | image/tiff; application=geotiff | |
| Cloud-optimized GeoTIFF (COG) | image/tiff; application=geotiff; profile=cloud-optimized | |
| HDF | application/x-hdf | |
| HDF5 | application/x-hdf5 | |
| NetCDF | application/netcdf | |
| Zarr | application/vnd.zarr | |
| ENVI Data | application/vnd.nv5.envi-data | New recommendation |
| ENVI Header | application/vnd.nv5.envi-header | New recommendation |

Many of these media types are defined in the [PySTAC](https://pystac.readthedocs.io/) module [pystac.media_type](https://pystac.readthedocs.io/en/stable/api/media_type.html).

## Contributing

Expand Down