Jw: /* Result: */

2017-01-16T13:55:50Z

Result:

← Older revision		Revision as of 15:55, 16 January 2017
Line 408:		Line 408:

	An empty string on success or an error message on failure.		An empty string on success or an error message on failure.



	===setXData===		===setXData===

Jw: /* APar Class Members */

2017-01-16T13:39:55Z

APar Class Members

← Older revision		Revision as of 15:39, 16 January 2017
Line 215:		Line 215:

	The <code>APar</code> class implements the following public member functions. See CObj Member Functions for a list of functions implemented in the parent class.		The <code>APar</code> class implements the following public member functions. See CObj Member Functions for a list of functions implemented in the parent class.



	===construct===		===construct===

Jw at 13:37, 16 January 2017

2017-01-16T13:37:29Z

← Older revision		Revision as of 15:37, 16 January 2017
Line 212:		Line 212:
	A simple table with one entry per unit type.		A simple table with one entry per unit type.

	====APar Class Members====		==APar Class Members==

	The <code>APar</code> class implements the following public member functions. See CObj Member Functions for a list of functions implemented in the parent class.		The <code>APar</code> class implements the following public member functions. See CObj Member Functions for a list of functions implemented in the parent class.

Jw at 13:37, 16 January 2017

2017-01-16T13:37:06Z

← Older revision		Revision as of 15:37, 16 January 2017
Line 5:		Line 5:
	The <code>APar</code> class implements a parameter interface for the DataSet. An alternative to this class is the <code>[[Programmer Guide/Class Library/ADesc - Parameter Description Classes\|ADesc]]</code> class and its derivatives.		The <code>APar</code> class implements a parameter interface for the DataSet. An alternative to this class is the <code>[[Programmer Guide/Class Library/ADesc - Parameter Description Classes\|ADesc]]</code> class and its derivatives.

	====APar Static Functions====		==APar Static Functions==

	The following static functions are implemented:		The following static functions are implemented:

Jw: /* GetParameterInfo */

2017-01-16T13:28:55Z

GetParameterInfo

← Older revision		Revision as of 15:28, 16 January 2017
Line 137:		Line 137:
	===GetParameterInfo===		===GetParameterInfo===

	Retrieve all information about a parameter (type).		Retrieve all information about a parameter type. E.g a fundamental frequency parameter.

	=====Usage:=====		=====Usage:=====

Jw at 10:47, 7 November 2016

2016-11-07T10:47:46Z

← Older revision		Revision as of 12:47, 7 November 2016
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
			{{TOC limit\|3}}
	==APar : CObj==		==APar : CObj==

Toni: moved Programmer Guide/Class Library/APar : CObj to Programmer Guide/Macro Library/APar

2011-04-28T07:50:28Z

moved Programmer Guide/Class Library/APar : CObj to Programmer Guide/Macro Library/APar

← Older revision	Revision as of 09:50, 28 April 2011
(No difference)

Christian: Text replace - "S_TOOLS-STx" to "{{STX}}"

2011-04-05T15:54:50Z

Text replace - "S_TOOLS-STx" to "{{STX}}"

← Older revision		Revision as of 17:54, 5 April 2011
Line 100:		Line 100:
	===GetAllMethods===		===GetAllMethods===

	Retrieve all parameter extraction methods defined in the ~~S_TOOLS-STx~~ INI file.		Retrieve all parameter extraction methods defined in the {{STX}} INI file.

	=====Usage:=====		=====Usage:=====

Admin: 1 revision: Initial import

2010-11-18T16:31:29Z

1 revision: Initial import

← Older revision	Revision as of 18:31, 18 November 2010
(No difference)

193.171.195.8: initial import

2010-05-17T13:05:27Z

initial import

New page

{{DISPLAYTITLE:{{SUBPAGENAME}}}}
==APar : CObj==

The <code>APar</code> class implements a parameter interface for the DataSet. An alternative to this class is the <code>[[Programmer Guide/Class Library/ADesc - Parameter Description Classes|ADesc]]</code> class and its derivatives.

====APar Static Functions====

The following static functions are implemented:

===LoadData===

Load existing parameter data.

=====Usage:=====

<code>APar LoadData <var>aset</var> ; <var>aseg</var> ; <var>method</var> ; [ <var>xunit</var> [ <var>xuref</var> ]] | NO ; [ <var>yunit</var> [ <var>yuref</var> ]] | NO [; <var>channel</var> ; <var>id</var> ]</code>

=====Parameters:=====

;<var>aset</var>

:The audio set reference or position.

;<var>aseg</var>

:The audio segment ID.

;<var>method</var>

:The name of the parameter method (as displayed in the Detail view).

;<var>xunit</var>

:The unit for the x-scale data. The following keywords are supported:

:<code>no</code>, <code>off</code> or <code>false</code> Do not load the x-scale data.

:<empty> Load the x-scale data without unit conversion.

:unit Load the x-scale data and convert to the selected unit.

;<var>yunit</var>

:The unit for the y-scale data. The following keywords are supported:

:<code>no</code>, <code>off</code> or <code>false</code> Do not load the y-scale data.

:<empty> Load the y-scale data without unit conversion.

:unit Load the y-scale data and convert to the selected unit.

;<var>channel</var>

:Passed to the <code>Load</code> command.

;<var>id</var>

:Passed to the <code>Load</code> command.

=====Result:=====

An empty string if load fails or the following (depending on the <var>xunit</var> and <var>yunit</var> arguments).

[ <code>xdata</code> ] [ <code>ydata</code> ]

===Load===

Load parameter object of type '<var>method</var>' from the audio segment '<var>aset</var> ; <var>aseg</var>'.

Usage:

<code>APar Load <var>aset</var> ; <var>aseg</var> ; <var>method</var> [; <var>channel</var> ; <var>id</var> ]</code>

=====Parameters:=====

;<var>aset</var>

:The audio set reference or position.

;<var>aseg</var>

:The audio segment ID.

;<var>method</var>

:The name of the parameter method (as displayed in the Detail view).

;<var>channel</var>

:The channel number of the analysed signal. If specified, the channel attribute <code>CH</code> is included in the parameter selection.

;<var>id</var>

:The id of the analysed signal. If specified, the id attribute <code>ID</code> is included in the parameter selection.

=====Result:=====

An <code>APar</code> instance or empty string

===GetAllMethods===

Retrieve all parameter extraction methods defined in the S_TOOLS-STx INI file.

=====Usage:=====

<code>APar GetAllMethods</code>

=====Result:=====

A semi-colon separated list of methods in the format:

<code>method1 parameterName1 ; method2 parameterName2 ; ...</code>

===GetMethodInfo===

Retrieve all information about a specific method.

=====Usage:=====

<code>APar GetMethodInfo <var>method</var></code>

=====Parameters:=====

;<var>method</var>

:The method name (as returned by <code>GetAllMethods</code>).

=====Result:=====

Information about the method in the following format:

<code>method ; param ; ny ; text ; nx ; xtype ; ytype ; unit</code>

Otherwise an empty string is returned.

===GetParameterInfo===

Retrieve all information about a parameter (type).

=====Usage:=====

<code>APar GetParameterInfo <var>param</var></code>

=====Result:=====

If successful, the all information pertaining to the parameter param is returned in the following format:

<code>name ; nx ; text ; xtype ; ytype ; unit</code>

Otherwise an empty string is returned.

=====Examples:=====

The call

<pre>
APar GetParameterInfo F0
</pre>
returns the string

<code>F0; 1; Fundametal Frequency; time; frequency;</code>

===GetTypeInfo===

Retrieve information about a scale type.

=====Usage:=====

<code>APar GetTypeInfo <var>type</var></code>

=====Parameters:=====

;<var>type</var>

:A valid unit type (One of the entries returned by <code>GetAllUnitTypes</code>).

=====Result:=====

A simple table of defined units or empty string if type does not exist. Each table entry has the following format:

<code>unit ; unitname ; ref ; min ; max</code>

===GetAllUnits===

Get a list of all units (shortname) of a scale type.

=====Usage:=====

<code>APar GetAllUnits <var>type</var></code>

=====Parameters:=====

;<var>type</var>

:A valid unit type (One of the entries returned by <code>GetAllUnitTypes</code>).

=====Result:=====

A blank separated list of the units of the requested type.

===GetAllUnitTypes===

Retrieve all unit types currently supported. One of these types can then be passed to the functions <code>GetTypeInfo</code> or <code>GetAllUnits</code>.

=====Usage:=====

<code>APar GetAllUnitTypes</code>

=====Result:=====

A simple table with one entry per unit type.

====APar Class Members====

The <code>APar</code> class implements the following public member functions. See CObj Member Functions for a list of functions implemented in the parent class.

===construct===

Initialise the instance. If <var>posref</var> is specified, initialize the instance with parameter data from the element at the position reference (see Load for more details). If <var>table</var> is specified, initialize the instance with a table containing parameters (see NEW for more details).

=====Usage:=====

<code><var>inst</var> construct [ <var>posref</var> | <var>table</var> ]</code>

=====Parameters:=====

;<var>posref</var>

:An IRef to an <code>APar</code> element in the DataSet.

;<var>table</var>

:The table containing the parameters.

=====Result:=====

<code>0</code> if successful, <code>1</code> otherwise.

===destruct===

Destroy the instance.

===getScale===

Get the scale domain.

=====Usage:=====

<code><var>inst</var> getScale <var>axis</var> <var>order</var></code>

=====Parameters:=====

;<var>axis</var>

:The name of the axis (<code>X</code>|<code>Y</code>)

;<var>order</var>

:The axis order or parameter number.

=====Result:=====

The domain of selected scale or an empty string.

===getXData===

Get x scale data vector.

=====Usage:=====

<code><var>inst</var> getXData <var>order</var> ; <var>length</var> ; <var>unit</var> <var>uref</var> [; <var>table</var> <var>field</var> ]</code>

=====Parameters:=====

;<var>order</var>

:The x-scale order (<code>1</code> or <code>2</code>). The default value is <code>1</code>.

;<var>length</var>

:The number of values (<code>0</code>|<code>*</code> = original length)

;<var>unit, uref</var>

:The output unit and reference value. The default unit depends on the parameter type. For time parameters the default unit is seconds (s) whilst for frequency parameters, the default unit is Hz.

;<var>table, field</var>

:The output table and field (a new table is created if not specified).

=====Result:=====

The x-data vector (parameter table with one row) or empty string.

===getYData===

Get the y scale data vector(s).

=====Usage:=====

<code><var>inst</var> getYData <var>index</var> ; <var>length</var> ; <var>unit</var> <var>uref</var> [; <var>table</var> <var>field</var> ; <var>mvsym</var> ]</code>

=====Parameters:=====

;<var>index</var>

:The index of the y-data to be loaded (<code>0</code> for all).

;<var>length</var>

:The number of values (<code>0</code>|<code>*</code> = original length)

;<var>unit, uref</var>

:The output unit and reference value. If no unit is specified, the unit specified with the last <code>setYData</code> is used.

;<var>table, field</var>

:The output table and (first) field (a new table is created if not specified).

;<var>mvsym</var>

:The missing value symbol.

=====Result:=====

The y-data vector/s (parameter table) or empty string.

===load===

Load data from an existing APar in the DataSet into this instance.

=====Usage:=====

<code><var>inst</var> load <var>aparref</var></code>

=====Parameters:=====

;<var>aparref</var>

:An IRef to an APar in the DataSet.

=====Result:=====

An empty string on success or an error message on failure.

===new===

Initializes a new parameter instance with values from the table. The table must have the following format:

{|
|-
|<code>$table[0]</code>
|asegposref ; channel
|-
|<code>$table[1]</code>
|method ; framelength ; frameshift ; framecount ; methodparam
|-
|<code>$table[2]</code>
|axes order ; unit [ref] ; datavalue<nowiki>|</nowiki>datatable [datafield]
|-
|<code>$table[3]</code>
|....
|}

=====Usage:=====

<code>inst new <var>table</var></code>

=====Parameters:=====

;<var>table</var>

:The parameter table.

=====Result:=====

An empty string on success and an error message on failure.

===save===

Save local <code>APar</code> file in the DataSet. If a table is specified a new parameter is created by calling the function NEW table.

=====Usage:=====

<code><var>inst</var> save [ <var>replace</var> <var>table</var> <var>edit</var> <var>save</var> ]</code>

=====Parameters:=====

;<var>replace</var>

:1 if the existing parameter should be replace, 0 otherwise.

;<var>table</var>

:The parameter table to save. See the member function new for details.

;<var>edit</var>

:Set the edit attribute to <code>1</code> or <code>0</code>.

;<var>save</var>

:Set the save attribute to <code>1</code> or <code>0</code>.

=====Result:=====

An empty string on success or an error message on failure.

===setXData===

Set the x scale data.

=====Usage:=====

<code><var>inst</var> setXData <var>order</var> ; <var>unit</var> [ <var>uref</var> ]</code>

=====Parameters:=====

;<var>order</var>

:The x-scale order (<code>1</code>|<code>2</code>).

;<var>unit</var>

:The x-scale unit.

;<var>uref</var>

:The unit reference value.

=====Result:=====

An empty string on success or an error message on failure.

===setYData===

Set the y scale data.

=====Usage:=====

<code><var>inst</var> setYData <var>order</var> ; <var>unit</var> [ <var>uref</var> ] ; <var>table</var> [ <var>field</var> ]</code>

<code><var>inst</var> setYData <var>order</var> ; <var>unit</var> [ <var>uref</var> ] ; <var>value</var></code>

=====Parameters:=====

;<var>order</var>

:The y-scale order (>=<code>1</code>) or order range.

;<var>unit</var>

:The y-scale unit.

;<var>uref</var>

:The unit reference value.

;<var>table</var>

:The data table containing values to set (one value per order).

;<var>field</var>

:The first table field containing Y vectors.

;<var>value</var>

:The value to set the y data to or a range of values if an order range was specified.

=====Result:=====

An empty string on success or an error message on failure.

===getXScale===

The definitions of the independent scale x with the specified order.

=====Usage:=====

<code><var>inst</var> getXScale [ <var>order</var>]</code>

=====Parameters:=====

;<var>order</var>

:The order (<code>1</code> ... <code>ny</code>). The default order is <code>1</code>.

=====Result:=====

'<code>domain ; unit ; uref</code>' or an empty string.

===getYScale===

The definitions of the independent scale y with the specified order.

=====Usage:=====

<code><var>inst</var> getYScale [ <var>order</var>]</code>

=====Parameters:=====

;<var>order</var>

:The order (<code>1</code> ... <code>ny</code>). The default order is <code>1</code>.

=====Result:=====

'<code>domain ; unit ; uref</code>' or an empty string.

Programmer Guide/Macro Library/APar - Revision history

Jw: /* Result: */

Jw: /* APar Class Members */

Jw at 13:37, 16 January 2017

Jw at 13:37, 16 January 2017

Jw: /* GetParameterInfo */

Jw at 10:47, 7 November 2016

Toni: moved Programmer Guide/Class Library/APar : CObj to Programmer Guide/Macro Library/APar

Christian: Text replace - "S_TOOLS-STx" to "{{STX}}"

Admin: 1 revision: Initial import

193.171.195.8: initial import