From 32c98f950642e76d6e3f3cb568f548697f94efde Mon Sep 17 00:00:00 2001 From: Frank Mori Hess Date: Fri, 25 Jan 2008 15:00:01 +0000 Subject: [PATCH] Added some links. --- doc/calibration_funcref.txt | 57 ++++++++++++++++++++++++------------- 1 file changed, 37 insertions(+), 20 deletions(-) diff --git a/doc/calibration_funcref.txt b/doc/calibration_funcref.txt index 5bc32b2..f9db0ba 100644 --- a/doc/calibration_funcref.txt +++ b/doc/calibration_funcref.txt @@ -50,8 +50,10 @@ Description: file location. The calibration information used by this function is generated by the comedi_calibrate program (see its man page). - The functions comedi_parse_calibration_file(), - comedi_apply_parsed_calibration(), and comedi_cleanup_calibration() + The functions + comedi_parse_calibration_file, + comedi_apply_parsed_calibration, + and comedi_cleanup_calibration_file provide the same functionality at a slightly lower level. Returns: Zero on success, a negative number on failure. @@ -66,13 +68,15 @@ Param: unsigned int aref Param: const comedi_calibration_t *calibration Status: alpha Description: - This function is similar to comedi_apply_calibration() + This function is similar to + comedi_apply_calibration, except the calibration information is read from memory instead of a file. This function can be more efficient than comedi_apply_calibration() since the calibration file does not need to be reparsed with every call. The calibration is - obtained by a call to comedi_parse_calibration_file(). + obtained by a call to + comedi_parse_calibration_file. Returns: Zero on success, a negative number on failure. @@ -84,7 +88,8 @@ Status: alpha Description: This function frees the resources associated with a comedi_calibration_t obtained from - comedi_parse_calibration_file(). calibration + comedi_parse_calibration_file. + *calibration can not be used again after calling this function. Function: comedi_get_default_calibration_path -- get default calibration file path @@ -98,7 +103,8 @@ Description: the string is no longer needed. Returns: A string which contains a file path useable by - comedi_parse_calibration_file(). On error, NULL is returned. + comedi_parse_calibration_file. + On error, NULL is returned. Function: comedi_get_hardcal_converter -- get converter for hardware-calibrated subdevice Retval: int @@ -110,14 +116,17 @@ Param: enum comedi_conversion_direction direction Param: comedi_polynomial_t *converter Status: alpha Description: - comedi_get_hardcal_converter() initializes converter so it can be - passed to either comedi_to_physical() or comedi_from_physical(). The result can be used to + comedi_get_hardcal_converter() initializes *converter so it can be + passed to either + comedi_to_physical, + or comedi_from_physical. + The result can be used to convert data from the specified subdevice, channel, and range. The direction parameter specifies whether converter will be passed to comedi_to_physical() or comedi_from_physical(). - This function initializes converter as a simple linear function with no + This function initializes *converter as a simple linear function with no calibration information, appropriate for boards which do their gain/offset/nonlinearity corrections in hardware. If your board needs calibration to be performed in software by the host computer, use comedi_get_softcal_converter() @@ -125,8 +134,10 @@ Description: with the SDF_SOFT_CALIBRATED subdevice flag. The result of this function will only depend on the channel - parameter if either comedi_range_is_chan_specific() or comedi_maxdata_is_chan_specific() - is true for the specified subdevice. + parameter if either + comedi_range_is_chan_specific + or comedi_maxdata_is_chan_specific + returns true for the specified subdevice. Returns: Zero on success or -1 on failure. @@ -140,14 +151,18 @@ Param: const comedi_calibration_t *parsed_calibration Param: comedi_polynomial_t *converter Status: alpha Description: - comedi_get_softcal_converter() initializes converter so it can be - passed to either comedi_to_physical() or comedi_from_physical(). The converter - parameter can then be used to + comedi_get_softcal_converter() initializes *converter so it can be + passed to either + comedi_to_physical + or comedi_from_physical. + The *converter + struct can then be used to convert data from the specified subdevice, channel, and range. The direction - parameter specifies whether converter will be passed to comedi_to_physical() + parameter specifies whether *converter will be passed to comedi_to_physical() or comedi_from_physical(). The parsed_calibration parameter contains the - software calibration values for your device, and may be obtained by calling comedi_parse_calibration_file() + software calibration values for your device, and may be obtained by calling + comedi_parse_calibration_file on a calibration file generated by the comedi_soft_calibrate program. This function is only useful for boards that perform their calibrations in software on the host @@ -176,13 +191,15 @@ Description: This function parses a calibration file (produced by the comedi_calibrate or comedi_soft_calibrate programs) and returns a pointer to a comedi_calibration_t which can be passed to the - comedi_apply_parsed_calibration() or comedi_get_softcal_converter() + comedi_apply_parsed_calibration + or comedi_get_softcal_converter functions. When you are finished using the comedi_calibration_t, you should - call comedi_cleanup_calibration() to free the resources + call comedi_cleanup_calibration + to free the resources associated with the comedi_calibration_t. - The comedi_get_default_calibration_path() function may - be useful in conjunction with this function. + The comedi_get_default_calibration_path + function may be useful in conjunction with this function. Returns: A pointer to parsed calibration information on success, or NULL on failure. -- 2.26.2