Parameters - Revision history

Wengelhardt: /* Creating Parameters (for Developers) */

2025-04-22T21:45:19Z

Creating Parameters (for Developers)

← Older revision		Revision as of 21:45, 22 April 2025
Line 38:		Line 38:
	Parameters are defined in the [[Programming_Reference:GenericFilter_Class#Publish\|''Publish'']] method of a BCI2000 filter, using the same syntax of [[Technical_Reference:Parameter_Definition#Parameter_Lines\|parameter lines]].		Parameters are defined in the [[Programming_Reference:GenericFilter_Class#Publish\|''Publish'']] method of a BCI2000 filter, using the same syntax of [[Technical_Reference:Parameter_Definition#Parameter_Lines\|parameter lines]].

	Elsewhere in your BCI2000 filter, you can access the parameter according to the [[Programming Reference:Environment Class\|syntax here]] and [[Programming Reference:Accessing Parameters and States\|here]]. If you really want the full syntax, it is [[Programming Reference:Parameters\|described here]].		Elsewhere in your BCI2000 filter, you can access the parameter according to the [[Programming Reference:Environment Class\|syntax here]] and [[Programming Reference:Accessing Parameters and States\|here]]. If you really want the full syntax, it is [[Programming Reference:Parameters\|described here]]. And [[Programming_Reference:GenericFilter_Class#Rules_for_Parameter_and_State_access\|here]] are some notes on rules for parameter access.

Wengelhardt: /* Creating Parameters (for Developers) */

2025-04-22T21:33:46Z

Creating Parameters (for Developers)

← Older revision		Revision as of 21:33, 22 April 2025
Line 38:		Line 38:
	Parameters are defined in the [[Programming_Reference:GenericFilter_Class#Publish\|''Publish'']] method of a BCI2000 filter, using the same syntax of [[Technical_Reference:Parameter_Definition#Parameter_Lines\|parameter lines]].		Parameters are defined in the [[Programming_Reference:GenericFilter_Class#Publish\|''Publish'']] method of a BCI2000 filter, using the same syntax of [[Technical_Reference:Parameter_Definition#Parameter_Lines\|parameter lines]].

	Elsewhere in your BCI2000 filter, you can access the parameter according to the [[Programming Reference:Environment Class\|syntax here]]. If you really want the full syntax, it is [[Programming Reference:Parameters\|described here]].		Elsewhere in your BCI2000 filter, you can access the parameter according to the [[Programming Reference:Environment Class\|syntax here]] and [[Programming Reference:Accessing Parameters and States\|here]]. If you really want the full syntax, it is [[Programming Reference:Parameters\|described here]].

Wengelhardt: Create a summary page for parameters

2025-04-22T21:23:21Z

Create a summary page for parameters

New page

Parameters are the BCI2000 data type that contains constant, static information. This is best used for task settings, amplifier configuration, and user settings. Parameters are loaded into BCI2000, are able to be changed by the user, and then are saved into the BCI2000 data file. With parameters, all the information about the experiment can be recovered in the analysis.

This page provides a summary of parameters for both users and developers. Users can interface with parameters in a variety of ways, detailed below. Developers can learn how to create their own parameters with a BCI2000 filter.

=Parameter design=
Parameter files are saved as a ''.prm'' file. Each parameter is one line. A parameter can be a string, float, boolean, integer, matrix, enumeration, file, directory, or color.

[[Technical Reference:Parameter Definition#Parameter Lines|More detailed information about the syntax can be found here.]] However, it is very tedious to edit these parameters in this format. Instead, they can be opened in a tool called BCI2000FileInfo or set in Matlab, as detailed below.

=Viewing Parameters in BCI2000=
Parameters are most easily viewed in the BCI2000 Parameter Configuration window. This can either be opened with BCI2000FileInfo, or by pressing the ''Config'' button in the main BCI2000 window.
[[File:OperatorConfiguration.png|center|frame|The parameter configuration window, opened with either BCI2000FileInfo or the Config button]]

Once you have navigated the tabs and changed whichever parameters you desire, click on ''Save Parameters'' to save the parameters to a ''.prm'' file. Likewise, if you already have the parameter file and want to load it, click on ''Load Parameters''.

[[User_Reference:Operator_Module#Preferences_Dialog|Further information is detailed here.]]

==Advanced Features==
* ''Configure Save'' and ''Configure Load'' buttons: These limit which parameters are saved/loaded. It is BCI2000 "best practice" to save only the parameters you change, and always load every parameter (''Configure Load'' should always have every box enabled). This means before you click ''Save Parameters'', change ''Configure Save'' to the parameters you changed. This saves a parameter file with only a couple parameters, commonly called a '''parameter fragment'''.

* Sliding bar: This defines the parameter's ''User Level''. The ''User Level'' can be specified in the ''Preferences Dialog'' (File -> Preferences). By default it is set to the highest level, but if you change it, only the parameters which are at or below the user level will appear. For example, if ''SubjectName'' is set to the 2nd level and SubjectSession to the 1st level, if the ''UserLevel'' is set to level 2, both ''SubjectName'' and ''SubjectSession'' will be shown, while ''SubjectRun'' (still at level 3) will not appear. If the ''UserLevel'' is then set to level 1, only ''SubjectSession'' will appear.

=Setting Parameters (Matlab / Python)=
Another easy way to populate parameters is through either Matlab or Python. Matlab uses a mex file [[User_Reference:Matlab_MEX_Files#convert_bciprm|convert_bciprm]], while Python uses a function by [https://github.com/neurotechcenter/Convert_bciprm-Python- the same name]. This function takes the parameter struct as the input, and output a ''.prm'' file.

[https://github.com/neurotechcenter/BCI2000_ExperimentalDesignDemos/tree/main/BCI2000Native_StimulusPresentation Examples can be found here for both Matlab and Python]

=Loading Parameters=
# Clicking ''Load Parameters'' in the parameter configuration window (above)
# Using the [[User_Reference:Operator_Module_Scripting#LOAD_PARAMETERFILE_<file>,_LOAD_PARAMETERS_<file>|''Load ParameterFile'']] command in your batch file.
# Load parameter file with BCI2000Remote. Refer to [[APIs|this page]] for the command in each possible language.

=Accessing Parameters=
# Loading the ''.dat'' file, which returns the signal, states, and <u>parameters</u>: [[User_Reference:Matlab_MEX_Files#load_bcidat|load_bcidat]] in Matlab or [https://github.com/neurotechcenter/BCI2kReader BCI2kReader] in Python.
# Loading the ''.prm'' or ''.dat'' file in [[User Reference:BCI2000FileInfo|BCI2000FileInfo]]

=Creating Parameters (for Developers)=
Parameters are defined in the [[Programming_Reference:GenericFilter_Class#Publish|''Publish'']] method of a BCI2000 filter, using the same syntax of [[Technical_Reference:Parameter_Definition#Parameter_Lines|parameter lines]].

Elsewhere in your BCI2000 filter, you can access the parameter according to the [[Programming Reference:Environment Class|syntax here]]. If you really want the full syntax, it is [[Programming Reference:Parameters|described here]].