LabVIEW Biomedical Toolkit API Reference

Write Biosignal Express VI

  • Updated2023-02-21
  • 3 minute(s) read

Owning Palette: Biomedical File I/O Express VIs

Requires: Biomedical Toolkit

Writes biosignals to files.

This VI supports writing biosignals to the following file types:

  • TDMS (.tdms)
  • PhysioBank Database (.hea)
  • European Data Format (.edf)

This VI supports writing annotations and comments to new TDMS files or to existing TDMS files that the LabVIEW Biomedical Toolkit generates.

Examples

Dialog Box Options
Block Diagram Inputs
Block Diagram Outputs

Dialog Box Options

ParameterDescription
File path (new or existing)Specifies the path to the file to which you want to write biosignals.
View file contentsSpecifies to view the content of the file that you specify in File path (new or existing). This option is available only when you specify an existing file in File path (new or existing). A View File Contents dialog box appears after you click View file contents.
Group nameSpecifies the name of the channel group to write biosignals. You must specify a name in Group name.
If A File Already ExistsSpecifies how this VI writes biosignals when you specify an existing file in File path (new or existing).
  • Replace the existing file—Specifies to overwrite the existing file.
  • Append signals to the file—Specifies to append biosignals to the existing file. This option is available only when the file that you specify in File path (new or existing) is a TDMS file.
Write annotations/comments?Specifies whether this VI writes annotations or comments to the file. The default is FALSE. This option is available only when the file that you specify in File path (new or existing) is a new TDMS file or an existing TDMS file that you generated with the Biomedical Toolkit.
Configure annotation detailsSpecifies the configuration of the annotation type. This option displays the Configure Annotation Type dialog box. This option is available only when you place a checkmark in the Write annotations/comments? checkbox.
Channel Property OptionSpecifies the method for configuring channel properties.
  • Read channel properties from input waveforms—Specifies to read channel properties from input waveforms.
  • Specify channel properties—Specifies to configure channel properties in the configuration dialog box or by using block diagram inputs.
Channel propertiesSpecifies the properties of the channel to which this VI writes biosignals. This option is available only when you select Specify channel properties in Channel properties.

Block Diagram Inputs

ParameterDescription
annotationsSpecifies the annotations to write to the file.
biosignalsSpecifies the biosignals to write to the file.
channel propertiesSpecifies the properties of the channel to which this VI writes biosignals.
commentsSpecifies the comments to write to the file.
error in (no error)Describes error conditions that occur before this node runs.
file pathSpecifies the path to the file to which this VI writes biosignals.
group nameSpecifies the name of the channel group to which this VI writes biosignals.
stop?Specifies whether to stop writing biosignals to the file. The default is FALSE.

Block Diagram Outputs

ParameterDescription
error outContains error information. This output provides standard error out functionality.

Examples

Refer to the following VIs for examples of using the Write Biosignal VI:

  • Biosignal Logger VI: labview\examples\Biomedical\Biosignal
  • Biosignal File Format Converter VI: labview\examples\Biomedical\Biosignal
  • Write Annotation and Comment VI: labview\examples\Biomedical\Biosignal