Macro Reference
Help for each Macro component is provided in the properties dialog box.
Macro Reference List
Timing
| Macro Name | Function | Use Notes |
|---|---|---|
| CoreSweepControl | Generation of the core timing & control signals used in OpenEx. This macro should be used once and only once in each OpenEx circuit. | Single and multi-processor devices. Designed for OpenEx. |
| StandardTimeControl | Generation and storage of the basic timing/control signals needed to drive various stimulation or acquisition structures. | Single and multi-processor devices. Designed for OpenEx. |
Filtering
| Macro Name | Function | Use Notes |
|---|---|---|
| HP-LP_Filter_1Ch | Filtering of floating point single-channel data streams through cascaded highpass (HP) and lowpass (LP) filters. | Single and multi-processor devices. |
| HP-LP_Filter_4Ch | Filtering for up to four-channels of floating point data streams through cascaded highpass (HP) and lowpass (LP) filters. | Single and multi-processor devices. |
| HP-LP_Filter_MC | Filtering of floating point multi-channel data streams through cascaded highpass (HP) and lowpass (LP) filters. | Multi-processor devices only. |
Data Saving | Segment_Snip
| Macro Name | Function | Use Notes |
|---|---|---|
| Block_Store_1-4Ch | Continuous or decimated block storage for up to four-channels of floating point data streams. | Single and multi-processor devices. Designed for OpenEx. |
| Block_Store_1-8Ch | Continuous or decimated block storage for up to eight-channels of floating point data streams. | Single and multi-processor devices. Designed for OpenEx. |
| Block_Store_MC | Continuous or decimated block storage of multi-channel floating point data streams. | Multi-processor devices only. Designed for OpenEx. |
| Spike_Store_1-4Ch | Spike thresholding and sorting for up to four-channels of floating point data streams using the FindSpike, SortSpike, SortSpike2, or SortSpike3 components, and storage of the snippets. | Single and multi-processor devices. Designed for OpenEx. |
| Spike_Store_MC | Spike thresholding and sorting of floating point data streams using the FindSpike, SortSpike, SortSpike2, or SortSpike3 components, and storage of the snippets. | Multi-processor devices only. Designed for OpenEx. |
Data Saving | Streaming
| Macro Name | Function | Use Notes |
|---|---|---|
| Stream_Store_1-4Ch | Continuous or decimated storage for up to four-channels of floating point data streams. | Single and multi-processor devices. Designed for OpenEx. |
| Stream_Store_1-8Ch | Continuous or decimated storage for up to eight-channels of floating point data streams. | Single and multi-processor devices. Designed for OpenEx. |
| Stream_Store_MC | Continuous or decimated storage of multi-channel floating point data streams. | Multi-processor devices only. Designed for OpenEx. |
| Stream_Store_MC2 | Continuous or decimated storage of multi-channel floating point data streams. | Multi-processor devices only. Designed for OpenEx. |
| Async_Stream_Store_1-4CH | Asynchronous continuous storage of floating or fixed point data. | Multi-processor devices only. Designed for OpenEx. |
| Asynch_Stream_Store_MC | Asynchronous continuous storage of multi-channel floating or fixed point data. | Multi-processor devices only. Designed for OpenEx. |
Data Saving | Epoch Store
| Macro Name | Function | Use Notes |
|---|---|---|
| Epoc_Store | Storage of scalar Epochs on transitions of control or signal inputs. | Single and multi-processor devices. Designed for OpenEx. |
| Slow_Store_1-4Ch | Triggered storage for up to four-channels of floating point or integer data streams. | Single and multi-processor devices. Designed for OpenEx. |
| Slow_Store_1-8Ch | Triggered storage for up to eight-channels of floating point or integer data streams. | Single and multi-processor devices. Designed for OpenEx. |
| Slow_Store_MC | Triggered storage of multi-channel floating point or integer data streams. | Multi-processor devices only. Designed for OpenEx. |
| Epoc_Store_with_Offset | Storage of scalar Epochs with onset and offset coding. | Single and multi-processor devices. Designed for OpenEx. |
Data Saving | With Processing | Averaging
| Macro Name | Function | Use Notes |
|---|---|---|
| Block_Avg_Store_1-4Ch | Asynchronous block storage of data streams. | Multi-processor devices only. Designed for OpenEx. |
| Block_Avg_Store_MC | Asynchronous block storage of data streams. | Multi-processor devices only. Designed for OpenEx. |
Device | PO8e_Streamer
| Macro Name | Function | Use Notes |
|---|---|---|
| Stream_Remote_MC | Configure RZ to PO8e data streaming. | RZDSP-U equipped RZs. |
Device | RZ2 Processor
| Macro Name | Function | Use Notes |
|---|---|---|
| RZ2_Control | Configure RZ2 Digital I/O. | RZ2 only. |
| RZ2_Input_MC | Configure RZ2 Analog I/O. | RZ2 only. |
Device | RZ5 Processor
| Macro Name | Function | Use Notes |
|---|---|---|
| RZ5_Control | Configure RZ5 Digital I/O. | RZ5 only. |
| RZ5_AmpIn_MC | Configure RZ5 preamplifier input (4-32 channels). | RZ5 only. |
| RZ5_AmpIn | Configures a single channel of RZ5 preamplifier input. | RZ5 only. |
Device | RZ5D Processor
| Macro Name | Function | Use Notes |
|---|---|---|
| RZ5D_Control | Configure RZ5D Digital I/O. | RZ5D only. |
| RZ5D_PZ2_Input | Configure RZ5D input from PZ2 preamplifier. | RZ5D only. |
| RZ5D_PZ3_Input | Configure RZ5D input from PZ3 preamplifier. | RZ5D only. |
| RZ5D_PZ4_Input | Configure RZ5D input from PZ4 digital headstage manifolds. | RZ5D only. |
Device | RZ6 Processor
| Macro Name | Function | Use Notes |
|---|---|---|
| RZ6_Control | Configure RZ6 Digital I/O direction. | RZ6 only. |
| RZ6_AmpIn | Reads up to four channels of RZ6 preamplifier input. | RZ6 only. |
| RZ6_AudioIn | Reads two channels of RZ6 ADC input. | RZ6 only. |
| RZ6_AudioOut | Controls two channels of RZ6 DAC output. | RZ6 only. |
Device | RS4_Data_Streamer
| Macro Name | Function | Use Notes |
|---|---|---|
| Stream_Server_MC | Configure RZ2 to RS4 data streaming. | RZDSP-S equipped RZs. |
Device | RV2 Video Processor
| Macro Name | unction | Use Notes |
|---|---|---|
| Video_Access | Control the RV2 Video Processor via an RZ processor. | RZDSP-V equipped RZs. |
Device | PZ2 Bioamp
| Macro Name | Function | Use Notes |
|---|---|---|
| PZ2_Control | Configures PZ2 LEDs and power down status. Also configures direct input from PZ2 when run on an RZDSP-P. | RZ2 or any RZ equipped with an RZDSP-P. |
Device | PZ3 Amplifier
| Macro Name | Function | Use Notes |
|---|---|---|
| PZ3_ChanMap | Maps channels from PZ3 to build a multi-channel output containing either the amplified waveforms or corresponding impedances. | RZ2 only. |
| PZ3_Control | Configures PZ3 operation modes. Also configures direct input from PZ2 when run on an RZDSP-P. | RZ2 or any RZ equipped with an RZDSP-P. |
Device | PZ5 NeuroDigitizer
| Macro Name | Function | Use Notes |
|---|---|---|
| PZ5_Control | Configures PZ5 logical amplifiers. | RZ2, RZ5D or any RZ equipped with an RZDSP-P. |
| PZ5_512_Control | Configures PZ5-512 logical amplifiers | RZ2, RZ5D or any RZ equipped with an RZDSP-P. |
Device | Medusa4Z Bioamp
| Macro Name | Function | Use Notes |
|---|---|---|
| Medusa4Z_Input | Read 1-4 channels of data from the Medusa4Z Bioamp. | RZ2, RZ5, RZ6 processors. |
Device | IZ2 Stimulus Isolator
| Macro Name | Function | Use Notes |
|---|---|---|
| IZ2_Control | Control the IZ2 Stimulus Isolator via an RZ processor. Also control an SH16-Z connected to an IZ2. | RZDSP-I equipped RZs. |
Device | MS16 Stimulus Isolator
| Macro Name | Function | Use Notes |
|---|---|---|
| MS16_Control | Control the MS16 Stimulus Isolator via the RZ5 or RX7 processor. | RZ5 or RX7 only. |
Device | SH16 Switching Headstage
| Macro Name | Function | Use Notes |
|---|---|---|
| SH16_Control | Control the SH16 switching headstage via the RZ5 or RX7 processor. | RZ5 or RX7 only. |
Device | UDP Ethernet
| Macro Name | Function | Use Notes |
|---|---|---|
| RZ_Serial_Rec | Receive serial data input. | RZ with UDP only. |
| RZ_Serial_Send | Send data on the serial port. | RZ with UDP only. |
| RZ_UDP_Rec | Receive data sent across a network to an RZ. | RZ with UDP only. |
| RZ_UDP_Send | Send data from RZ across a network. | RZ with UDP only. |
| RZ_BH_Rec_1-4CH | Receive data from a BH32 behavioral controller. | RZ with UDP only. |
| RZ_BH_Rec_MC | Receive multi-channel data from a BH32 behavioral controller. | RZ with UDP only. |
| RZ_BH_Send_1-4Ch | Send data from RZ to the BH32 behavioral controller. | RZ with UDP only. |
| RZ_BH_Send_MC | Send multi-channel data from RZ to the BH32 behavioral controller. | RZ with UDP only. |
Signal Generators
| Macro Name | Function | Use Notes |
|---|---|---|
| PulseGenN | A biphasic pulse train generator with all timing specified in samples. | Single and multi-processor devices. |
| Note: for RX or RZ devices it is more efficient to use PulseGen component with PulseTrain2. | ||
| Test_Spike_MC | A multi-channel spike test signal generator. | Multi-processor devices. |
Misc Calculators
| Macro Name | Function | Use Notes |
| RateToSamples | Convert input rate to number of samples based on the sample rate of the circuit. | Single and multi-processor devices. |
| TimeToSamples | Convert an input time to number of samples based on the sample rate of the circuit and bound the output regardless of the input. | Single and multi-processor devices. |