C Reference Documentation
Contents
- Version Information
- Utilities
- Error Handling
- Library Setup
- Processing Plugins
- Processing Queue Sets
- File I/O for Measurements (HSI Cubes, etc.)
- MeasurementList
- MeasurementHSICubeInput
- MeasurementHSICubeBufferInput
- MeasurementList_load
- MeasurementList_load_w
- Measurement_create_hsi_cube
- Measurement_create_hsi_cube_pqs
- Measurement_create_hsi_cube_from_buffers
- MeasurementList_save
- MeasurementList_save_w
- MeasurementList_count
- MeasurementList_get_value_type
- MeasurementList_get_name
- MeasurementList_get_description
- MeasurementList_get_structure
- MeasurementList_get_data
- MeasurementList_copy_data
- MeasurementList_has_reference
- MeasurementList_get_reference_structure
- MeasurementList_get_reference_data
- MeasurementList_copy_reference_data
- MeasurementList_is_hsi_cube
- MeasurementList_get_is_illumination_corrected
- MeasurementList_get_wavelengths
- MeasurementList_get_calibration_info
- MeasurementList_free
- Models
- Calibration Information
- CalibrationInfo
- CalibrationSettingType
- CalibrationInfo_create
- CalibrationInfo_copy
- CalibrationInfo_set_setting
- CalibrationInfo_clear_setting
- CalibrationInfo_is_setting_present
- CalibrationInfo_get_setting_unit
- CalibrationInfo_get_setting_value
- CalibrationInfo_set_white_reference_reflectivity
- CalibrationInfo_clear_white_reference_reflectivity
- CalibrationInfo_is_white_reference_reflectivity_present
- CalibrationInfo_get_white_reference_reflectivity
- CalibrationInfo_compare
- CalibrationInfo_free
- Data Processing
- ProcessingContext
- DataType
- DataType_size
- DataType_is_integer
- DataType_is_unsigned
- DataType_is_signed
- DataType_is_floating_point
- ValueType
- ReferenceInfo
- HSICube_StorageOrder
- ExtendedReferenceInfo
- ContextInputDataInfo
- ProcessingContext_create_hsi_cube
- ProcessingContext_create_hsi_cube_pqs
- ProcessingContext_create_hsi_cube_calib
- ProcessingContext_create_hsi_cube_ext
- PushBroomFrame_StorageOrder
- ProcessingContext_create_pushbroom_frame
- ProcessingContext_create_pushbroom_frame_pqs
- ProcessingContext_create_pushbroom_frame_calib
- ProcessingContext_create_pushbroom_frame_ext
- ProcessingContext_set_use_extended_objects
- ProcessingContext_num_output_sinks
- ProcessingContext_find_output_sink
- OutputStorageType
- ProcessingContext_get_output_sink_meta_info
- ProcessingContext_get_output_sink_tensor_structure
- ProcessingContext_get_output_sink_object_list_structure
- ProcessingContext_get_output_sink_object_list_statistics_structure_count
- ProcessingContext_get_output_sink_object_list_statistics_structure
- ProcessingContext_get_output_sink_object_list_statistics_structure_ex
- ProcessingContext_get_output_sink_object_list_region_count
- ProcessingContext_get_output_sink_object_list_region_structure
- ProcessingContext_get_output_sink_object_list_region_channel_labels
- ProcessingContext_get_output_sink_object_list_quality_structure
- ProcessingContext_set_source_data_hsi_cube
- ProcessingContext_set_source_data_hsi_cube_ex
- ProcessingContext_set_source_data_pushbroom_frame
- ProcessingContext_set_source_data_pushbroom_frame_seqid
- ProcessingContext_set_source_data_pushbroom_frame_ex
- ProcessingContext_set_source_data_pushbroom_frame_ex_seqid
- ProcessingContext_set_source_data_tensor
- ProcessingContext_set_source_data_tensor_seqid
- ProcessingContext_process_next
- ProcessingContext_reset_state
- ProcessingContext_clear_source_data
- ProcessingContext_abort
- ProcessingContext_wait
- OutputObject
- Tensor
- OutputExtendedObjectStatistics
- ObjectRegionShape
- OutputExtendedObjectRegion
- OutputExtendedObject
- ProcessingContext_get_output_sink_data
- ProcessingContext_get_output_sink_data_s
- ProcessingContext_destroy
- Driver Paths
- Parameter Information
- ParameterInfo
- ParameterType
- ParameterAccessMode
- ParameterInfo_dup
- ParameterInfo_free
- ParameterInfo_num_parameters
- ParameterInfo_get_parameter_name
- ParameterInfo_get_parameter_type
- ParameterInfo_get_parameter_access_mode
- ParameterInfo_get_parameter_display_name
- ParameterInfo_get_parameter_effective_display_name
- ParameterInfo_get_parameter_short_description
- ParameterInfo_get_parameter_long_description
- ParameterInfo_get_parameter_num_affected_parameters
- ParameterInfo_get_parameter_affected_parameter_name
- ParameterInfo_get_parameter_default_string
- ParameterInfo_get_parameter_default_integer
- ParameterInfo_get_parameter_default_float
- ParameterInfo_get_parameter_default_boolean
- ParameterInfo_get_parameter_unit
- ParameterInfo_get_parameter_num_enumeration_entries
- ParameterInfo_get_parameter_enumeration_entry_name
- ParameterInfo_get_parameter_enumeration_entry_value
- ParameterInfo_get_parameter_enumeration_entry_display_name
- ParameterInfo_get_parameter_enumeration_entry_effective_display_name
- ParameterInfo_get_parameter_enumeration_entry_bn_value
- ParameterInfo_get_parameter_enumeration_entry_bn_display_name
- ParameterInfo_get_parameter_enumeration_entry_bn_effective_display_name
- ParameterInfo_get_parameter_integer_min
- ParameterInfo_get_parameter_integer_max
- ParameterInfo_get_parameter_integer_increment
- ParameterInfo_get_parameter_float_min
- ParameterInfo_get_parameter_float_max
- ParameterInfo_get_parameter_float_increment
- ParameterInfo_get_parameter_bn_type
- ParameterInfo_get_parameter_bn_access_mode
- ParameterInfo_get_parameter_bn_display_name
- ParameterInfo_get_parameter_bn_effective_display_name
- ParameterInfo_get_parameter_bn_short_description
- ParameterInfo_get_parameter_bn_long_description
- ParameterInfo_get_parameter_bn_num_affected_parameters
- ParameterInfo_get_parameter_bn_affected_parameter_name
- ParameterInfo_get_parameter_bn_default_string
- ParameterInfo_get_parameter_bn_default_integer
- ParameterInfo_get_parameter_bn_default_float
- ParameterInfo_get_parameter_bn_default_boolean
- ParameterInfo_get_parameter_bn_unit
- ParameterInfo_get_parameter_bn_num_enumeration_entries
- ParameterInfo_get_parameter_bn_enumeration_entry_name
- ParameterInfo_get_parameter_bn_enumeration_entry_value
- ParameterInfo_get_parameter_bn_enumeration_entry_display_name
- ParameterInfo_get_parameter_bn_enumeration_entry_effective_display_name
- ParameterInfo_get_parameter_bn_enumeration_entry_bn_value
- ParameterInfo_get_parameter_bn_enumeration_entry_bn_display_name
- ParameterInfo_get_parameter_bn_enumeration_entry_bn_effective_display_name
- ParameterInfo_get_parameter_bn_integer_min
- ParameterInfo_get_parameter_bn_integer_max
- ParameterInfo_get_parameter_bn_integer_increment
- ParameterInfo_get_parameter_bn_float_min
- ParameterInfo_get_parameter_bn_float_max
- ParameterInfo_get_parameter_bn_float_increment
- Device Enumeration
- EnumerationResult
- DriverType
- DriverState
- enumerate_devices
- EnumerationResult_num_devices
- EnumerationResult_get_device
- EnumerationResult_num_drivers
- EnumerationResult_get_driver
- EnumerationResult_num_warnings
- EnumerationResult_get_warning
- EnumerationResult_num_errors
- EnumerationResult_get_error
- EnumerationResult_free
- EnumeratedDevice
- EnumeratedDevice_get_id
- EnumeratedDevice_get_driver
- EnumeratedDevice_get_display_name
- EnumeratedDevice_get_manufacturer
- EnumeratedDevice_get_model_name
- EnumeratedDevice_get_serial_number
- EnumeratedDevice_get_parameter_info
- EnumeratedDriver
- EnumeratedDriver_get_name
- EnumeratedDriver_get_type
- EnumeratedDriver_get_description
- EnumeratedDriver_get_version
- EnumeratedDriver_get_state
- EnumeratedDriver_get_num_devices
- EnumeratedDriver_get_device
- EnumerationWarning
- EnumerationWarning_get_driver
- EnumerationWarning_get_message
- EnumerationError
- EnumerationError_get_driver
- EnumerationError_get_message
- Devices
- DeviceGroup
- ConnectionParameter
- ConnectionSettings
- DeviceGroup_connect
- DeviceGroup_disconnect
- DeviceGroup_unload
- DeviceGroup_get_primary_device
- DeviceGroup_get_driver_name
- DeviceGroup_get_driver_type
- DeviceGroup_get_driver_description
- DeviceGroup_get_driver_version
- DeviceNotificationType
- DeviceGroup_get_notification_event
- DeviceGroup_get_notification
- Device
- DeviceType
- Device_num_subdevices
- Device_get_subdevice
- Device_ping
- Device_reset_error
- Device_get_type
- Device_get_manufacturer
- Device_get_model
- Device_get_description
- Device_get_serial_number
- ParameterListType
- Device_get_parameter_list
- Device_get_parameter_type
- Device_get_parameter_string
- Device_get_parameter_integer
- Device_get_parameter_float
- Device_get_parameter_bool
- Device_is_parameter_command_complete
- Device_set_parameter_string
- Device_set_parameter_integer
- Device_set_parameter_float
- Device_set_parameter_bool
- Device_execute_parameter_command
- LightControlDeviceStatus
- LightControlDevice_get_status
- LightControlDeviceForceState
- LightControlDevice_set_force_state
- LightControlDevice_wait_for_ramp
- BufferScalarType
- expandedDataType
- InstrumentDeviceStatus
- InstrumentDevice_get_status
- InstrumentDevice_get_max_buffer_size
- InstrumentDevice_get_recommended_buffer_count
- InstrumentDevice_get_raw_buffer_dimensions
- InstrumentDevice_get_raw_buffer_scalar_type
- InstrumentDevice_get_raw_buffer_value_range
- InstrumentDevice_get_raw_buffer_dimension_labels
- InstrumentDevice_allocate_PersistentBuffer
- InstrumentDevice_setup_internal_buffers
- InstrumentDeviceAcquisitionParameters
- InstrumentDevice_start_acquisition
- InstrumentDevice_stop_acquisition
- InstrumentDevice_retrieve_buffer
- AbortCheckCallback
- InstrumentDevice_retrieve_buffer_ex
- InstrumentDevice_return_buffer
- InstrumentDevice_set_calibration_info
- BufferInfo
- Buffer_get_number
- Buffer_get_raw_dimensions
- Buffer_get_raw_scalar_type
- Buffer_get_raw_data
- Buffer_copy_raw_data
- Buffer_copy
- Buffer_copy_into
- PersistentBufferInfo
- PersistentBuffer_get_number
- PersistentBuffer_get_raw_dimensions
- PersistentBuffer_get_raw_scalar_type
- PersistentBuffer_get_raw_data
- PersistentBuffer_copy_raw_data
- PersistentBuffer_copy
- PersistentBuffer_copy_into
- PersistentBuffer_free
- BufferContainer
- BufferContainer_create
- BufferContainer_create_rb
- BufferContainer_get_count
- BufferContainer_clear
- BufferContainer_add
- BufferContainer_add_persistent
- BufferContainer_add_raw
- BufferContainer_get_structure
- BufferContainer_copy_data
- BufferContainer_copy_single_data
- BufferContainer_copy_buffer
- BufferContainer_copy_into_buffer
- BufferContainer_allocate_buffer
- BufferContainer_average_data_into_memory
- BufferContainer_average_data_into_memory_pqs
- BufferContainer_average_data_into_new_buffer
- BufferContainer_average_data_into_new_buffer_pqs
- BufferContainer_free
- File I/O for Raw References
- Instrument Data Standardization And Processing
- DeviceProcessingContext_CreationFlags
- ProcessingContext_create_instrument_preview
- ProcessingContext_create_instrument_preview_pqs
- ProcessingContext_ReferenceMeasurement
- ProcessingContext_ReferenceMeasurement_free
- ProcessingContext_HSIRecordingResult
- ProcessingContext_InstrumentParameters
- ProcessingContext_InstrumentParametersEx
- ProcessingContext_create_instrument_hsi_recording
- ProcessingContext_create_instrument_hsi_recording_pqs
- ProcessingContext_create_instrument_hsi_recording_ex
- ProcessingContext_create_instrument_hsi_recording_pqs_ex
- ProcessingContext_create_instrument_processing
- ProcessingContext_create_instrument_processing_pqs
- ProcessingContext_create_instrument_processing_ex
- ProcessingContext_create_instrument_processing_pqs_ex
- ProcessingContext_set_source_data_buffer
- ProcessingContext_set_source_data_buffer_seqid
- ProcessingContext_set_source_data_persistent_buffer
- ProcessingContext_set_source_data_persistent_buffer_seqid
- BufferContainer_create_from_recording_context
- BufferContainer_create_from_recording_context_rb
- BufferContainer_add_last_result
- Data Processing of Loaded Measurements