Basics¶

IO¶

int32_t hv_hs_image_write(hv_hs_image_t const *dynimg, char const *path)¶

Writes a hv_hs_image to the specified path.

Parameters:

dynimg – Image to write.
path – Path to write the image to.

Return values:

0 – Ok
nonzero – Error

int32_t hv_hsi_file_open(char const *path, hv_hsi_file_t **file)¶

Opens a hyperspectral image file at the given path and returns an HSIFile handle.

Parameters:

path – Path to the file to open.
file – Output parameter for the resulting HSIFile.

Return values:

0 – Ok
nonzero – Error

hv_hs_image_t *hv_hsi_file_to_image(hv_hsi_file_t **file)¶

Converts an HSIFile to a DynamicHSImage for flexible data access.

Parameters:: file – Output parameter for the HSIFile to convert. NOTE: it can’t be NULL
Returns:: Boxed DynamicHSImage.

Useful global definitions¶

doxygentypedef:: hv_shape_t

autoclass:: hsi.Shape autoclass:: hsi.ButeoPamType

Axes¶

To make operations independent of memory ordering, the library uses the a type to specify axes:

autoclass:: hsi.Axis

For convenience, the following shorthands are included:

Data types¶

The library currently uses its own internal types that are analogous to NumPy’s datatypes (no complex numbers for now). This might change in the future. The types are marked with the following tag type:

autoclass:: hsi.DType

For convenience, the following shorthands are included: