Camera control#

class hsi.HSCamera(addr, device)#
__new__(**kwargs)#
get_bands()#

Get the current band selection.

Returns:

List of band selections.

Return type:

list[BandSelection]

get_config()#

Get the hyperspectral camera configuration.

Returns:

The configuration object.

Return type:

HSCameraConfig

get_crop()#

Get the current crop settings.

Returns:

The current crop information.

Return type:

CropInfo

get_exposure()#

Get the exposure time in microseconds.

Returns:

Exposure time in microseconds.

Return type:

int

get_framerate()#

Get the current framerate.

Returns:

The framerate.

Return type:

float

get_framerate_list()#

Get the possible framerates.

Returns:

Either a min/max framerate range or a list of possible discrete values.

Return type:

dict | list

get_settings()#

Get the camera settings.

Returns:

The current camera settings.

Return type:

HSCameraSettings

get_wavelengths()#

Get the wavelengths of the camera’s spectral bands.

Returns:

List of wavelengths in nanometers.

Return type:

list[float]

set_bands(value)#

Set the bands configuration.

Parameters:

value (list[BandSelection]) – The new band selections.

Returns:

The actual set band selections.

Return type:

list[BandSelection]

set_config(value)#

Set the hyperspectral camera configuration.

Parameters:

value (HSCameraConfig) – The new configuration.

Returns:

The actual set configuration.

Return type:

HSCameraConfig

set_exposure(value)#

Set the exposure time.

Parameters:

value (int) – The new exposure time in microseconds.

Returns:

The actual set value.

Return type:

int

set_framerate(value)#

Set the current framerate.

Parameters:

value (float) – The desired framerate.

Returns:

The framerate that was set on the camera.

Return type:

float

set_horizontal_crop(value)#

Set the horizontal crop boundaries.

Parameters:

value (tuple) – A tuple containing (start, end) positions for horizontal cropping.

Returns:

The actual set horizontal crop.

Return type:

HorizontalCrop

set_settings(value)#

Set the camera settings.

Parameters:

value (HSCameraSettings) – The new camera settings.

Returns:

The actual set camera settings.

Return type:

HSCameraSettings

to_hs_image()#

Convert to HSImage.

Returns:

Hyperspectral image.

Return type:

HSImage

__module__ = 'builtins'#