Programming Reference:ParallelCombination - Revision history

Mellinger at 14:34, 7 September 2023

2023-09-07T14:34:37Z

← Older revision		Revision as of 14:34, 7 September 2023
Line 7:		Line 7:
	#include "Filter2.h"		#include "Filter2.h"

	struct MyCombination : ParallelCombination<Filter1, Filter2> {}		struct MyCombination : ParallelCombination<Filter1, Filter2> {};

	The instantiated <tt>ParallelCombination</tt> template may then be referred to as a filter with name <tt>MyCombination</tt>.		The instantiated <tt>ParallelCombination</tt> template may then be referred to as a filter with name <tt>MyCombination</tt>.

Mellinger: /* Output Signal */

2023-09-07T14:25:43Z

Output Signal

← Older revision		Revision as of 14:25, 7 September 2023
Line 46:		Line 46:
	If one of these output signals has more signal elements (samples) than the other, then the ''maximum'' number of signal elements (samples) is taken as the number of signal elements of the concatenated output signal.		If one of these output signals has more signal elements (samples) than the other, then the ''maximum'' number of signal elements (samples) is taken as the number of signal elements of the concatenated output signal.
	Signal elements (samples) of the concatenated output signal that do not exist in one of the two subfilters' output will be filled with NaN values.		Signal elements (samples) of the concatenated output signal that do not exist in one of the two subfilters' output will be filled with NaN values.

			==See also==
			[[Programming Reference:SubchainFilter]], [[Programming Reference:LinearCombination]], [[Programming Reference:ChoiceCombination]]

			[[Category:Filters]][[Category:Signal Processing]][[Category:Filter Combinations]]

Mellinger: /* Function */

2023-09-05T17:06:31Z

Function

← Older revision		Revision as of 17:06, 5 September 2023
Line 1:		Line 1:
	==Function==		==Function==
	The ParallelCombination class is a template that takes as arguments two filter class names.		The <tt>ParallelCombination</tt> class is a template that takes as arguments two filter class names.
	The instantiated template is then a combined filter, and must be given its own class name by defining a struct that publicly inherits from the instantiated template:		The instantiated template is then a combined filter, and must be given its own class name by defining a struct that publicly inherits from the instantiated template:

Line 9:		Line 9:
	struct MyCombination : ParallelCombination<Filter1, Filter2> {}		struct MyCombination : ParallelCombination<Filter1, Filter2> {}

	*The ~~combination~~'s ''input'' channels may be fed selectively into the inputs of the two filters.		The instantiated <tt>ParallelCombination</tt> template may then be referred to as a filter with name <tt>MyCombination</tt>.
	*The ~~combination~~'s ''output'' is a concatenation of ~~the~~ two ~~filters~~' outputs.
			For the resulting filter, the following applies:
			*The the filter's ''input'' channels may be fed selectively into the inputs of the two filters (see ''Parameters'' below).
			*The filter's ''output'' is a concatenation of its two subfilters' outputs (see ''Output Signal'' below),

	Any of the two filters may be a [[Programming_Reference:SubchainFilter\|SubchainFilter]], which allows for two parallel chains of filters, as well as more complex topologies because SubchainFilters may again contain ParallelCombination instantiations.		Any of the two filters may be a [[Programming_Reference:SubchainFilter\|SubchainFilter]], which allows for two parallel chains of filters, as well as more complex topologies because SubchainFilters may again contain ParallelCombination instantiations.

Mellinger: /* Function */

2023-09-05T17:02:04Z

Function

← Older revision		Revision as of 17:02, 5 September 2023
Line 6:		Line 6:
	#include "Filter1.h"		#include "Filter1.h"
	#include "Filter2.h"		#include "Filter2.h"

	struct MyCombination : ParallelCombination<Filter1, Filter2> {}		struct MyCombination : ParallelCombination<Filter1, Filter2> {}

Mellinger: /* Function */

2023-09-05T17:01:42Z

Function

← Older revision		Revision as of 17:01, 5 September 2023
Line 2:		Line 2:
	The ParallelCombination class is a template that takes as arguments two filter class names.		The ParallelCombination class is a template that takes as arguments two filter class names.
	The instantiated template is then a combined filter, and must be given its own class name by defining a struct that publicly inherits from the instantiated template:		The instantiated template is then a combined filter, and must be given its own class name by defining a struct that publicly inherits from the instantiated template:

			#include "FilterCombination.h"
			#include "Filter1.h"
			#include "Filter2.h"

	struct MyCombination : ParallelCombination<Filter1, Filter2> {}		struct MyCombination : ParallelCombination<Filter1, Filter2> {}

Mellinger: /* Function */

2023-09-05T17:00:47Z

Function

← Older revision		Revision as of 17:00, 5 September 2023
Line 6:		Line 6:

	*The combination's ''input'' channels may be fed selectively into the inputs of the two filters.		*The combination's ''input'' channels may be fed selectively into the inputs of the two filters.
	*The combination's ''output'' is ~~joined together from the output~~ of the two filters.		*The combination's ''output'' is a concatenation of the two filters' outputs.

	Any of the two filters may be a [[Programming_Reference:SubchainFilter\|SubchainFilter]], which allows for two parallel chains of filters, as well as more complex topologies because SubchainFilters may again contain ParallelCombination instantiations.		Any of the two filters may be a [[Programming_Reference:SubchainFilter\|SubchainFilter]], which allows for two parallel chains of filters, as well as more complex topologies because SubchainFilters may again contain ParallelCombination instantiations.

Mellinger at 16:59, 5 September 2023

2023-09-05T16:59:44Z

← Older revision		Revision as of 16:59, 5 September 2023
Line 30:		Line 30:
	EMG* [matches all channels whose name begins with 'EMG']		EMG* [matches all channels whose name begins with 'EMG']
	EEG* [matches all channels whose name begins with 'EEG']		EEG* [matches all channels whose name begins with 'EEG']

			==States==
			None.

	==Output Signal==		==Output Signal==
Line 36:		Line 39:
	If one of these output signals has more signal elements (samples) than the other, then the ''maximum'' number of signal elements (samples) is taken as the number of signal elements of the concatenated output signal.		If one of these output signals has more signal elements (samples) than the other, then the ''maximum'' number of signal elements (samples) is taken as the number of signal elements of the concatenated output signal.
	Signal elements (samples) of the concatenated output signal that do not exist in one of the two subfilters' output will be filled with NaN values.		Signal elements (samples) of the concatenated output signal that do not exist in one of the two subfilters' output will be filled with NaN values.

	~~==States==~~
	~~None.~~

Mellinger: /* Channels */

2023-09-05T16:59:10Z

Channels

← Older revision		Revision as of 16:59, 5 September 2023
Line 30:		Line 30:
	EMG* [matches all channels whose name begins with 'EMG']		EMG* [matches all channels whose name begins with 'EMG']
	EEG* [matches all channels whose name begins with 'EEG']		EEG* [matches all channels whose name begins with 'EEG']

			==Output Signal==
			The output signal is a ''concatenation'' of both subfilters' (or subchains') output signals.
			First are output channels of the first subfilter, then output channels of the second subfilter.
			If one of these output signals has more signal elements (samples) than the other, then the ''maximum'' number of signal elements (samples) is taken as the number of signal elements of the concatenated output signal.
			Signal elements (samples) of the concatenated output signal that do not exist in one of the two subfilters' output will be filled with NaN values.

			==States==
			None.

Mellinger: /* Channels */

2023-09-05T15:20:53Z

Channels

← Older revision		Revision as of 15:20, 5 September 2023
Line 25:		Line 25:
	* Wildcard patterns may be negated by prepending an exclamation mark.		* Wildcard patterns may be negated by prepending an exclamation mark.
	* Ranges of channels may be specified using : or - to separate begin from end.		* Ranges of channels may be specified using : or - to separate begin from end.

			Examples for channel lists are:
			* [matches all channels]
			EMG* [matches all channels whose name begins with 'EMG']
			EEG* [matches all channels whose name begins with 'EEG']

Mellinger: /* Channels */

2023-09-05T15:16:01Z

Channels

← Older revision		Revision as of 15:16, 5 September 2023
Line 16:		Line 16:
	The parameter is matrix-valued, and contains only a single column with two entries.		The parameter is matrix-valued, and contains only a single column with two entries.
	The two rows correspond to the two filters given as template arguments, and each row's label gives the name of the filter it corresponds to.		The two rows correspond to the two filters given as template arguments, and each row's label gives the name of the filter it corresponds to.

	Matrix elements themselves contain a list of channels each, determing which channels are transmitted to which of the two subfilters, or chains.		Matrix elements themselves contain a list of channels each, determing which channels are transmitted to which of the two subfilters, or chains.
	In channel lists, ~~channel names~~ are separated by white space~~, and~~ may contain wildcards: * to represent one or more arbitrary characters, and ? to represent a single arbitrary character. Character ranges may be enclosed by []~~, and wilcard~~ patterns may be negated by prepending an exclamation mark.
	Ranges of channels may be specified using : or - to separate begin from end.		For channel lists, the following rules apply:
			* Entries are separated by white space.
			* Entries may contain wildcards: * to represent one or more arbitrary characters, and ? to represent a single arbitrary character.
			* Character ranges may be enclosed by [].
			* Wildcard patterns may be negated by prepending an exclamation mark.
			* Ranges of channels may be specified using : or - to separate begin from end.