API Reference

The public api of ONE-PIX allows to acquire hyperspectral datacubes using single pixel imaging. The basic features to acquire a datacube are provided, for several spectrometer brands or patterns bases.

Hyperspectral SPI acquisition

Imaging methods

Class allowing to use a specific pattern method.

class ImagingMethodBridge.ImagingMethodBridge(imaging_method=None, spatial_res=0, height=0, width=0)[source]

Acquisition

This class allows to set acquisition parameters to perform ONE-PIX acqusitions.

Hyperspectral SPI reconstruction and analysis

Reconstruction

This class contains the set of methods to reconstruct datacubes according to the chosen acquisition method.

class Reconstruction.Reconstruction(acquisition_dict=None)[source]

Class OPReconstruction to reconstruct datacubes according to a ONE-PIX method

data_reconstruction()[source]

image_reconstruction allows to reconstruct an image data cube from an actualised spatial spectra data cube. Both are stored in the HSPIReconstruction class object.

Returns:: None.

load_raw_data()[source]

This function allows to load saved spectra with timers of the displays and spectrometers. at runtime, a window appears to select the folder path in which the data are located.

Returns:: acq_data (dict) – Dictionary containing data extracted from files saved after acquisition to reconstruct data cubes.

nan_corr()[source]

nan_corr allows to filter nan from acquired spectra

Returns:: None.

Reconstruction.get_header_data(path)[source]

This function allows to generate a dictionnary containing acquisition data useful for the data cube reconstruction.

Parameters:: path (str) – Header file path
Returns:: acq_data (dict) – Dictionnary containing acquisition data.

Analysis

Library containing several methods to analyse datacube