HARK Document Version 2.5.0. (Revision: 9008) : SourceTransformer

6.7.28 SourceTransformer

6.7.28.1 Outline of the node

Edit values for information (ID, power, azimuth, elevation) of the sound source localization results given as the input. Replace each value with a constant value specified or performs a basic arithmetic operation using the specified value on each value.

6.7.28.2 Necessary file

No files are required.

6.7.28.3 Usage

When to use

This node is used to edit values of ID, power, azimuth, or elevation which is information of the sound source localization results. Replace each value with a constant value specified or performs a basic arithmetic operation using the specified value on each value.

Typical connection

Figure 6.121 shows a connection example. Mainly connect sound source localization results obtained with ConstantLocalization , LoadSourceLocation , LocalizeMUSIC , etc.

$\includegraphics[width=\linewidth ]{fig/modules/SourceTransformer}$

Figure 6.121: Example of connection of SourceTransformer in an Iterator subnetwork

6.7.28.4 Input-output and property of the node

Input

INPUT: : Vector<ObjectRef> type. The sound source localization results. The ObjectRef refers to data in the Source type indicating the sound source information to which an ID is assigned.

Output

OUTPUT: : Vector<ObjectRef> type. The sound source localization results. The ObjectRef refers to data in the Source type indicating the sound source information to which an ID is assigned.

Parameter

Table 6.115: Parameter list of SourceTransformer

Parameter name	Type	Default value	Unit	Description
ENABLE_ID	`bool`	false		Enable or disable to edit sound source ID.
ID_OPERATION_TYPE	`string`	CONST		The operation type to edit sound source ID. Select CONST, ADD, SUB, MUL, or DIV.
ID	`ObjectRef`	`Vector<int>`		The value used to edit the sound source ID.
ENABLE_POWER	`bool`	false		Enable or disable to edit sound source power.
POWER_OPERATION_TYPE	`string`	CONST		The operation type to edit sound source power. Select CONST, ADD, SUB, MUL, or DIV.
POWER	`ObjectRef`	`Vector<float>`		The value used to edit sound source power.
ENABLE_AZIMUTH	`bool`	false		Enable or disable to edit azimuth of sound source localization results.
AZIMUTH_OPERATION_TYPE	`string`	CONST		The operation type to edit azimuth of sound source localization results. Select CONST, ADD, SUB, MUL, or DIV.
AZIMUTH	`ObjectRef`	`Vector<float>`		The value used to edit azimuth of sound source localization results.
ENABLE_ELEVATION	`bool`	false		Enable or disable to edit elevation of sound source localization results.
ELEVATION_OPERATION_TYPE	`string`	CONST		The operation type to edit elevation of sound source localization results. Select CONST, ADD, SUB, MUL, or DIV.
ELEVATION	`ObjectRef`	`Vector<float>`		The value used to edit elevation of sound source localization results.

ENABLE_ID: : bool type. The default value is false. Setting the value to trueenables editing sound source ID of the localization results given as the input.
ID_OPERATION_TYPE: : string type. The operation type to edit sound source ID of the localization results given as the input available when the ENABLE_ID parameter is true. Select CONST, ADD, SUB, MUL, or DIV. The operation uses the value specified in the ID parameter. Selecting CONST replaces sound source ID with the ID parameter value. Selecting ADD, SUB, MUL, or DIV performs an arithmetic operation on the sound source ID such that add the ID parameter value to the sound source ID, subtract the ID parameter value from the sound source ID, multiply the sound source ID by the ID parameter value, or divide the sound source ID by the ID parameter value.
ID: : ObjectRef type. The value used to edit sound source ID. When a single value is given, use the value to all sound source localization results. Use Vector<int> when it is desired to specify different value per sound source localization result. However, the last element of the Vector<int> is used for the rest of sound source localization results when the number of Vector<int> elements is less than the number of sound source localization results.
ENABLE_POWER: : bool type. The default value is false. Setting the value to trueenables editing sound source power of the localization results given as the input.
POWER_OPERATION_TYPE: : string type. The operation type to edit sound source power of the localization results given as the input available when the ENABLE_POWER is set to true. Select CONST, ADD, SUB, MUL, or DIV. The operation uses the value specified in the POWER parameter. Selecting CONST replaces sound source power with the POWER parameter value. Selecting ADD, SUB, MUL, or DIV performs an arithmetic operation on sound source power such that add the POWER parameter value to the sound source power, subtract the POWER parameter value from the sound source power, multiply the sound source power by the POWER parameter value, or divide the sound source power by the POWER parameter value.
POWER: : ObjectRef type. The value used to edit sound source power. When a single value is given, use the value to all sound source localization results. Use Vector<float> when it is desired to specify different value per sound source localization result. However, the last element of the Vector<float> is used for the rest of sound source localization results when the number of Vector<float> elements is less than the number of sound source localization results.
ENABLE_AZIMUTH: : bool type. The default value is false. Setting the value to trueenables editing azimuth of the sound source localization results given as the input.
AZIMUTH_OPERATION_TYPE: : string type. The operation type to edit azimuth of the localization results given as the input available when the ENABLE_AZIMUTH is set to true. Select CONST, ADD, SUB, MUL, or DIV. The operation uses the value specified in the AZIMUTH parameter. Selecting CONST replaces the azimuth of the sound source localization results with the AZIMUTH parameter value. Selecting ADD, SUB, MUL, or DIV performs an arithmetic operation on the azimuth of the sound source localization results such that add the AZIMUTH parameter value to the azimuth of the sound source localization results, subtract the AZIMUTH parameter value from the azimuth of the sound source localization results, multiply the azimuth of the sound source localization results by the AZIMUTH parameter value, or divide the azimuth of the sound source localization results by the AZIMUTH parameter value.
AZIMUTH: : ObjectRef type. The value used to edit azimuth. When a single value is given, use the value to all sound source localization results. Use Vector<float> when it is desired to specify different value per sound source localization result. However, the last element of the Vector<float> is used for the rest of sound source localization results when the number of Vector<float> elements is less than the number of sound source localization results.
ENABLE_ELEVATION: : bool type. The default value is false. Setting the value to trueenables editing the elevation of sound source localization results given as the input.
ELEVATION_OPERATION_TYPE: : string type. The operation type to edit elevation of the localization results given as the input available when the ENABLE_ELEVATION is set to true. Select CONST, ADD, SUB, MUL, or DIV. The operation uses the value specified in the ELEVATION parameter. Selecting CONST replaces the elevation of the sound source localization results with the ELEVATION parameter value. Selecting ADD, SUB, MUL, or DIV performs an arithmetic operation on the elevation of the sound source localization results such that add the ELEVATION parameter value to the elevation of the sound source localization results, subtract the ELEVATION parameter value from the elevation of the sound source localization results, multiply the elevation of the sound source localization results by the ELEVATION parameter value, or divide the elevation of the sound source localization results by the ELEVATION parameter value.
ELEVATION: : ObjectRef type. The value used to edit elevation. When a single value is given, use the value to all sound source localization results. Use Vector<float> when it is desired to specify different value per sound source localization result. However, the last element of the Vector<float> is used for the rest of sound source localization results when the number of Vector<float> elements is less than the number of sound source localization results.