Method ao/convert


  CONVERT perform various conversions on the ao.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: CONVERT perform various conversions on the ao.
 
  CALL:        ao = convert(ao, pl)
 
  PARAMETERS:
 
               'action' - choose a conversion to make [default: none]
 
  Possible actions:
 
     Unit conversions:
          's to Hz'   - convert seconds to Hz in the yunits of this AO.
          'Hz to s'   - convert Hz to seconds in the yunits of this AO.
 
     Data conversions:
          'to cdata'  - convert the data in the AO to a cdata type.
          'to tsdata' - convert the data in the AO to a tsdata type.
          'to fsdata' - convert the data in the AO to a fsdata type.
          'to xydata' - convert the data in the AO to a xydata type.
 
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class ao
Sealed 0
Static 0

Parameter Description

Default

no description
Key Default Value Options Description
convert
ACTION ''
  • ''
  • 's to Hz'
  • 'Hz to s'
  • 'to cdata'
  • 'to tsdata'
  • 'to fsdata'
  • 'to xydata'
Choose the action to perform.
XAXIS 'x'
  • 'x'
  • 'y'
  • 'z'
The axis to use to fill the new x field.
YAXIS 'y'
  • 'x'
  • 'y'
  • 'z'
The axis to use to fill the new y field.
SLICEAXIS 'y'
  • 'x'
  • 'y'
For the case of converting 3D data to xydata, choose the axis on which to perform the slicing.

Example

plist('ACTION', '', 'XAXIS', 'x', 'YAXIS', 'y', 'SLICEAXIS', 'y')

back to top back to top

Some information of the method ao/convert are listed below:
Class name ao
Method name convert
Category Helper
Package name ltpda
Can be used as modifier 1
Supported numeric types {'double'}




©LTP Team