Package index • rOmniDriver

Package overview

rOmniDriver rOmniDriver-package: rOmniDriver: Omni Driver R wrapper

wrapper functions

R functions for accessing the OmniDriver SDP Java API. Help pages are concise. Details available in the Java API documentation and a manual at (http://oceaninsight.com/).

init_api() init_srs() is_api_enabled() init_extended_api() is_extended_api_enabled() init_highres_time_api() is_highres_time_api_enabled(): Initialize the connection to the driver

open_all_spectrometers() number_srs(): Opens connections to all spectrometers

close_all_spectrometers() srs_close(): close all open connections to spectrometers

get_api_version(): Get OmniDriver API version

get_bench(): Get optical properties of optical bench

get_boxcar_width(): Get current setting of boxcar width

get_calibration_coefficients_from_buffer(): Get calibration coefficients from buffer

get_calibration_coefficients_from_eeprom(): Get calibration coefficients from EEPROM

get_correct_for_detector_nonlineary(): Get current setting of linearity correction (enabled or not)

get_correct_for_electrical_dark(): Get current setting for electrical dark correction

get_correct_for_stray_light(): Get current setting of stray light correction

get_detector(): Get description of detector

get_feature_controller_saturation_threshold(): Get feature "saturation threshold"

get_feature_I2C_bus(): Get feature controller "I2C Bus"

get_feature_pixel_binning(): Get feature "pixel binning"

get_feature_spectrum_type(): Get feature "spectrum type"

get_feature_SPI_bus(): Get feature controller "SPI Bus"

get_firmware_model(): Get name of spectrometer

get_firmware_version(): Get spectrometer firmware version

get_I2C_bus() set_I2C_bus(): Talk to "I2C bus"

get_integration_time(): Get integration time

get_last_exception(): Get OmniDriver last exception

get_maximum_integration_time(): Get maximum integration time

get_maximum_intensity(): Get maximum intensity

get_minimum_integration_time(): Get minimum integration time

get_name(): Get name of spectrometer

get_number_of_channels(): Get number of channels

get_number_of_dark_pixels(): Get number of dark pixels

get_number_of_enabled_channels(): Get number of enabled channels

get_number_of_pixels(): Get total number of pixels in CCD array

get_scans_to_average() get_scans_to_avg(): Get "number of scans to average"

get_seconds_time_delta() get_nano_time_delta() get_micro_time_delta() get_milli_time_delta(): Get time difference between time stamps

get_seconds_time_delta_since() get_nano_time_delta_since() get_micro_time_delta_since() get_milli_time_delta_since(): Get time difference since a time stamp

get_serial_number(): Get serial number of spectrometer

get_spectrum(): Get a spectrum from the spectrometer

get_SPI_bytes(): Talk to "SPI bus"

get_wavelengths(): Get wavelengths from spectrometer

get_wrapper_extensions(): Get OmniDriver wrapper extensions

is_feature_supported_board_temperature() get_feature_controller_board_temperature() get_board_temperature(): Feature "Board temperature"

is_feature_supported_detector_temperature() get_feature_detector_temperature() get_detector_temperature(): Feature "detector temperature"

is_feature_supported_internal_trigger() get_feature_controller_internal_trigger() get_trigger_period_valid_range() get_trigger_period() set_trigger_period() set_trigger_source() get_trigger_source(): Feature "ìnternal trigger"

is_feature_supported_irradiance_calibration_factor() get_feature_irradiance_calibration_factor() get_irradiance_calibration_factors(): Feature "Irradiance Calibration Factor"

set_boxcar_width(): Set "boxcar width"

set_correct_for_detector_nonlinearity(): Set "correct for detector nonlinearity"

set_correct_for_electrical_dark(): Set "correct for electrical dark signal"

set_integration_time(): Set "integration time"

set_scans_to_average() set_scans_to_avg(): Set "number of scans to average"

set_spectrum_type(): Set "spectrum type"

set_timeout(): Set (trigger) "timeout"

set_USB_timeout(): Set USB "timeout"

is_channel_enabled(): Informs whether a channel is enbled or not

is_feature_supported_I2C_bus(): Is feature "I2C Bus" supported?

is_feature_supported_pixel_binning(): Is feature "pixel binning" supported?

is_feature_supported_saturation_threshold(): Is feature "saturation threshold" supported?

is_feature_supported_spectrum_type(): Is feature "spectrum type" supported?

is_feature_supported_SPI_bus(): Is feature "SPI Bus" supported?

is_saturated(): Is the most recent spectrum acquired saturated?

is_spectrum_valid(): Is the most recent spectrum acquired valid?

is_timeout(): Did the last operation time out?

is_USB_timeout(): Did the last USB operation time out?

spectrum_flush(): Flush the most recent spectrum

stop_averaging(): Stop averaging of scans

highSpdAcq_allocate_buffer(): Allocate memory buffer for high speed acquisition

highSpdAcq_get_number_of_spectra_acquired(): Get the number of spectra acquired at high speed

highSpdAcq_get_spectrum(): Get one spectrum acquired at high speed

highSpdAcq_get_time_stamp(): Get the time stamp of one spectrum acquired at high speed

highSpdAcq_start_acquisition(): Start high speed acquisition

oo_timestamp_to_string(): Convert time stamp to string