libRASCH
Home
General
About libRASCH/News
Design
Screen shots
Sample programs (with source code)
License
Download
libRASCH
Tools
Documentation
User
Developer
Resources
Mailing list
Supported Formats
Plugins
Status
Links
Contact
About this site
Last updated
Tue Mar 27 23:03:50 2007
Reference Manual for libRASCH-0.7.4
Reference Manual for libRASCH-0.7.4
Raphael Schneider
Copyright © 2004 Raphael Schneider
Table of Contents
1.
Function Reference for C
ra_lib_init
-- init libRASCH
ra_lib_close
-- close libRASCH
ra_lib_get_error
-- get last error
ra_lib_handle_from_any_handle
-- retrive handle of libRASCH instance from any handle
ra_meas_handle_from_any_handle
-- retrive measurement-handle from any handle
ra_lib_use_plugin
-- set using a plugin (or not)
ra_plugin_get_by_num
-- get plugin-handle
ra_plugin_get_by_name
-- get plugin-handle
ra_meas_find_first
-- find libRASCH-handled measurements (return first one)
ra_meas_find_next
-- find libRASCH-handled measurements (returns next)
ra_meas_close_find
-- close the search for libRASCH-handled measurements
ra_meas_open
-- open a measurement
ra_meas_new
-- creates a new measurement
ra_meas_save
-- saves a measurement
ra_meas_close
-- close a measurement
ra_info_get
-- get infos
ra_info_get_by_name
-- get infos
ra_info_get_by_idx
-- get infos
ra_info_set
-- set info
ra_rec_get_first
-- get root-recording
ra_rec_get_next
-- get next recording
ra_rec_get_first_child
-- get first sub-recording
ra_rec_add
-- add a recording
ra_dev_add
-- add a recording-device
ra_ch_add
-- add a recording-channel
ra_session_new
-- start a new recording session
ra_raw_add
-- add raw data
ra_raw_get
-- get raw-signal data
ra_raw_get_unit
-- get raw-signal data scaled to 'unit'-values
ra_gui_call
-- shows GUI-element of a plugin (if avail.)
ra_proc_get
-- get a processing handle
ra_proc_free
-- free a processing handle
ra_proc_do
-- process the signal
ra_proc_get_result
-- get the processing results
ra_view_get
-- create/show view of view-plugin
ra_lib_get_option
-- returns an option value
ra_lib_set_option
-- set an option
ra_meas_copy
-- copy measurement
ra_meas_move
-- move measurement
ra_meas_delete
-- delete measurement
ra_value_malloc
-- allocate and initialize a value_handle
ra_value_free
-- free value-handle
ra_value_reset
-- reset value-handle
ra_value_get_type
-- return value-type
ra_value_is_ok
-- checks if value is valid
ra_value_get_num_elem
-- return number of elements of array values
ra_value_get_info
-- returns id of info
ra_value_get_name
-- returns name of info
ra_value_get_desc
-- returns description of info
ra_value_set_number
-- set a number in a value-handle
ra_value_get_number
-- get a number set in a value-handle
ra_value_set_long
-- set long value in value-handle
ra_value_set_double
-- set double value in value-handle
ra_value_set_string
-- set a string in value-handle
ra_value_set_string_utf8
-- set a UTF-8 encoded string in value-handle
ra_value_set_long_array
-- set long-array values in value-handle
ra_value_set_double_array
-- set double-array values in value-handle
ra_value_set_string_array
-- set a string-array in value-handle
ra_value_set_string_array_utf8
-- set a string-array (UTF-8 encoded) in value-handle
ra_value_get_long
-- return long value from value-handle
ra_value_get_double
-- return double value from value-handle
ra_value_get_string
-- return character pointer from value-handle
ra_value_get_string_utf8
-- return character pointer from value-handle (UTF-8 encoded)
ra_value_get_long_array
-- return pointer to long array from value-handle
ra_value_get_double_array
-- return pointer to double array from value-handle
ra_value_get_string_array
-- return pointer to character pointer array from value-handle
ra_value_get_string_array_utf8
-- return pointer to character pointer array from value-handle (UTF-8 encoded)
ra_value_copy
-- copy one value_handle to another value_handle
ra_list_add
-- add an entry to a linked list
ra_list_insert
-- insert an entry to a linked list
ra_list_del
-- delete an entry from a linked list
ra_comm_add
-- add a signal receiver
ra_comm_del
-- delete a signal receiver
ra_comm_emit
-- emits a signal
ra_eval_add
-- adds an evaluation
ra_eval_get
-- returns an evaluation-handle
ra_eval_get_def
-- returns the default evaluation-handle
ra_eval_get_orig
-- returns the original evaluation-handle
ra_eval_delete
-- delete an evaluation
ra_eval_set_def
-- set an evaluation to the default evaluation
ra_ev_insert
-- insert an event
ra_ev_del
-- delete an event
ra_evset_get_num_events
-- returns number of events
ra_evset_set_start_end
-- set start- and end-position of an event
ra_evset_get_start_end
-- get start- and end-position of an event
ra_ev_get_value
-- returns the property of an event
ra_ev_set_value
-- set the property of an event
ra_ev_get_value_inf
-- returns the property of an event in a ra_info struct
ra_ev_set_value_inf
-- set the property of an event to the value given in a ra_info struct
ra_prop_add
-- add a predefined event-property
ra_prop_add_name
-- add a predefined event-property (selected by name)
ra_prop_add_custom
-- add an event-property
ra_prop_del
-- delete an event-property from an evaluation
ra_prop_get_by_num
-- returns an event-property handle
ra_prop_get_by_name
-- returns an event-property handle
ra_evset_get_by_num
-- returns an event-set handle
ra_evset_get_by_name
-- returns an event-set handle
ra_evset_get_by_prop
-- returns an event-set handle
ra_evset_get_flag_prop
-- returns the event-property handling the event-set flags
ra_eval_loadxml
-- load evalution in XML format
ra_eval_savexml
-- save evalution in XML format
ra_templ_add
-- adds a template
ra_templ_del
-- deletes all templates
ra_templ_add_single
-- adds a template
ra_templ_del_single
-- deletes a template
ra_templ_get_raw
-- returns template raw-data
2.
Structure Reference for C
3.
Function Reference for Perl (OO-Interface)
4.
Function Reference for Python (OO-Interface)
5.
Function Reference for Matlab/Octave
6.
Infos Reference
7.
Signals for Inter Plugin Communication
select-event
-- select evens with a specific value
highlight-event
-- highlight an event
eval-change
-- evaluation has changed
start-event-change
-- some event-change signals are coming
end-event-change
-- close an start-event-change
event-change
-- event-value has changed
region-change
--
add-event
-- an event was added
del-event-begin
-- start of an event-deletion
del-event-end
-- end of an event-deletion
template-delete
-- a template was deleted
template-add
-- a template was added
pos-change
-- set view to a new position
gui-event-start
-- start of signal activated by GUI-event
gui-event-end
-- end of signal activated by GUI-event
x-resolution
-- set new resolution of x-axis
y-resolution
-- set new mm/unit of a channel
8.
libRASCH Plugins
8.1.
Access Plugins
ART
-- Handle signals recorded for ART-Study
cfs
-- Handle signals saved using the CED Filing System (CFS)
ctg-rasch
-- Handle cardiotocogram signals exported from GMT system
ctg-sonicaid
-- Handle cardiotocogram signals saved with the Oxford FetalCare system
dadisp
-- Handle signals saved a DaDisp signal file format
dasylab
-- Handle signals recorded using DasyLab
edf/edf+
-- Handle signals recorded using European Data Format(+)
ishne-holter
-- Handle signals saved using ISHNE standard output for Holter ECG
mit-bih
-- Handle signals recorded using the MIT/BIH Data Format (Physiobank data sets)
portapres
-- Handle signals recorded with Portapres-System
poly5/tms32
-- Handle signals recorded using TMS ADC system and PortiLab
read-rri
-- Handle RR interval-files (nearly the final design)
8.2.
Process Plugins
ap-morphology
-- get systolic and diastolyc values and positions of aterial pressure waves
calibration
-- measure calibration signals in a recording
dawes-redman
-- calculate FHR variations using the Dawes/Redman criteria
detect-ctg
-- perform detections in cardiotocograms
detect-simple
-- a simple beat-detection algorithm
ecg
-- perform ecg specific actions after reading original evaluation or doing detect using libRASCH
fiducial-point
-- finds fiducial point of a QRS-complex
freq-analysis
-- perform frequency analysis
hrv
-- calculate heart rate variability (HRV) parameters
template
-- combine events in templates
respiration
-- calculates respiration parameters
8.3.
GUI/View Plugins
ch-select-dlg
-- dialog for selecting channels which will be used for processing
eval-dlg
-- a dialog showing all evaluations for a measurement
plugin-info-dlg
-- a dialog showing the list of all loaded plugins
sig-sel-dlg
-- dialog to choose signales which can be handled with libRASCH
simple-calc-dlg
-- dialog to perform calculations using process plugins
cont-ap-view
-- view for continues arterial pressure recordings
ctg-view
-- view for cardiotocograms
ecg-view
-- view for ecg's
plot-view
-- plot evaluation data
rasch-view
-- general view for libRASCH, handling all views
template-view
-- view for templates
ts-view
-- view for time-series
List of Tables
6-1.
List of info-names for library infos -- ra_lib_get_info
6-2.
List of info-names for measurement infos -- ra_meas_get_info
6-3.
List of info-names for measurement-object (person) infos -- ra_obj_get_info
6-4.
List of info-names for measurement-object (patient) infos -- ra_obj_get_info
6-5.
List of info-names for recording infos -- ra_rec_get_info
6-6.
List of info-names for device infos -- ra_dev_get_info
6-7.
List of info-names for channel infos -- ra_ch_get_info
6-8.
List of info-names for evaluation infos -- ra_eval_get_info
6-9.
List of info-names for event-property infos -- ra_prop_get_info
6-10.
List of info-names for template infos -- not yet implemented
6-11.
List of info-names for single-template infos -- not yet implemented
6-12.
List of info-names for plugin infos -- ra_plugin_get_info
6-13.
List of info-names for plugin-results infos -- ra_proc_get_result_info
8-1.
List of options for plugin ap-morphology
8-2.
List of results of plugin ap-morphology
8-1.
List of options for plugin calibration
8-2.
List of results of plugin calibration
8-1.
List of options for plugin dawes-redman
8-2.
List of results of plugin dawes-redman
8-1.
List of options for plugin detect-ctg
8-2.
List of results of plugin detect-ctg
8-1.
List of options for plugin detect-simple
8-2.
List of results of plugin detect-simple
8-1.
List of options for plugin ecg
8-2.
List of results of plugin ecg
8-1.
List of options for plugin fiducial-point
8-1.
List of options for plugin freq-analysis
8-2.
List of results of plugin freq-analysis
8-1.
List of options for plugin hrv
8-2.
List of results of plugin hrv
8-1.
List of options for plugin template
8-1.
List of options for plugin respiration
8-1.
List of results of plugin ch-select-dlg
8-1.
List of options for plugin sig-sel-dlg
8-2.
List of results of plugin sig-sel-dlg
Next
Function Reference for C