Difference: DocsSectionsPathsFolders (1 vs. 14)

Revision 1418 Nov 2014 - Main.PhilipVanDenBroek

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
<---Start1--->

Paths and Folders

Line: 51 to 51
 session folders: a separate folder is created for each session with the same subject. The folder's name is the date of the session (YYYYMMDD).
Changed:
<
<
session folder ('brainstream'): contains the most recently saved version of user defined variables. This is the folder where BrainStream looks for variables when a 'load' statement is specified in the Actions table.
>
>
This folder contains the most recently saved version of user defined variables. This is the folder where BrainStream looks for variables when a 'load' statement is specified in the Actions table.
  runfolders: a separate runfolder is created for each block within the experiment. The name of the folder is the name of the block followed by _ and a number indicating how many times this block has been repeated. Each runfolder contains:
Added:
>
>
module folders: Each module stores its results in a separate folder named accordingly. BrainStream always stores its result in the 'main' module.
 log file: gives an overview of everything that happened during your experiment.

brainstream folder: contains copies of the user defined variables that have been saved with a 'save' statement in the Actions table.

Line: 63 to 66
 expdefs folder: contains copies of the experiment definition tables and blocksettings.

raw_bdf folder: contains the raw EEG data.

Changed:
<
<
>
>
 
<---End1--->

Revision 1316 Dec 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
<---Start1--->

Paths and Folders

Line: 19 to 19
  It is often useful to write a user defined function that adds all necessary paths and execute this function at the start of the experiment (e.g. at the BS_INIT marker). For example, if the experiment needs access to functions that are located in the folder /Volumes/BCI/my_functions, you could make a function:
function event = add_folder(event)
Changed:
<
<
addpath('/Volumes/BCI/my_functions'); % add my_functions folder to the Matlab search path
>
>
addpath(fullfile('Volumes','BCI','my_functions')); % add my_functions folder to the Matlab search path
 
Changed:
<
<
And execute this function at the BS_INIT marker:
>
>
Then execute this function at the BS_INIT marker:
 
Actions Table
marker time
function
BS_INIT EVENT add_folder

Revision 1215 Nov 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
<---Start1--->

Paths and Folders

Line: 7 to 7
 
Added:
>
>
All files (e.g. functions or figures) and folders that are used in your experiment must be on the Matlab search path.
 

Adding folders to the search path

Deleted:
<
<
Files (e.g. functions or figures) and folders that are used in your experiment must be on the Matlab search path.
 At startup, BrainStream adds the BrainStream core folder and nearly all its subfolders to the search path. If you need additional files or folders, you must make sure they are added to the search path. It is possible to specify these folders in the block file under the keys MatlabPathFnc or MatlabPathAdd. Alternatively, you can use Matlab's addpath function to add individual folders. If you want to add a folder with all its subfolders, use addpath in combination with genpath:
addpath(pwd);          %adds the current working directory to the search path
addpath(genpath(pwd)); %adds the current working directory and all its subfolders to the search path 
Line: 21 to 21
 
function event = add_folder(event)
addpath('/Volumes/BCI/my_functions'); % add my_functions folder to the Matlab search path  
Added:
>
>
And execute this function at the BS_INIT marker:
Actions Table
marker time
function
BS_INIT EVENT add_folder
 

Tip: Use the fullfile function

Changed:
<
<
It is recommended to use Matlab's fullfile function when you specify a file or folder. This ensures that the proper folders will be added on computers with different operating systems, as different systems may use either '/' or '\' as a file separator.
>
>
It is recommended to use Matlab's fullfile function when you specify a file or folder. This ensures that the proper folders will be added on computers with different operating systems, as different systems may use either '/' or '\' as a file separator.
 

Tip: Use relative path names

It is recommended to use relative path names when you specify a folder, whether it is in the blocksettings or in functions like addpath. This means that you specify the path name of the folder you want to add relative to a folder of which the location is already known. The advantage of using relative path names is that the proper folders will be added also if you work on a different computer.

Changed:
<
<
In BrainStream, you can make use of the bs_folder function. For example, with input argument 'BLOCK', the output of this function is the path to the folder containing the block file of the experiment. If the block file is located in '/Volumes/BCI/my_bci/blockfile', and you want to add a folder which contains your functions and is located in '/Volumes/BCI/my_bci/functions', you can specify this folder like this:
>
>
In BrainStream, you can make use of the bs_folder function. For example, with input argument 'BLOCK', the output of this function is the path to the folder containing the block file of the experiment. If the block file is located in '/Volumes/BCI/my_bci/blockfile', and you want to add a folder which contains your functions and is located in '/Volumes/BCI/my_bci/functions', you can specify this folder like this:
 
functionfolder = fullfile(bs_folder('BLOCK'),..,'functions') % N.B. the '..' expression means going up one level
Deleted:
<
<
For more information about the bs_folder function and its input arguments, see the function index.
 

Output folders

Revision 1114 Nov 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
<---Start1--->

Paths and Folders

Line: 6 to 6
 Generate current PDF
Added:
>
>
 

Adding folders to the search path

Files (e.g. functions or figures) and folders that are used in your experiment must be on the Matlab search path.

Changed:
<
<
At startup, BrainStream adds the BrainStream core folder and nearly all its subfolders to the search path. If you need additional files or folders, you must make sure they are added to the search path. It is possible to specify these folders in the block file under the keys MatlabPathFnc? or MatlabPathAdd? . Alternatively, you can use Matlab's addpath function to add individual folders. If you want to add a folder with all its subfolders, use addpath in combination with genpath:
>
>
At startup, BrainStream adds the BrainStream core folder and nearly all its subfolders to the search path. If you need additional files or folders, you must make sure they are added to the search path. It is possible to specify these folders in the block file under the keys MatlabPathFnc or MatlabPathAdd. Alternatively, you can use Matlab's addpath function to add individual folders. If you want to add a folder with all its subfolders, use addpath in combination with genpath:
 
addpath(pwd);          %adds the current working directory to the search path
addpath(genpath(pwd)); %adds the current working directory and all its subfolders to the search path 
Line: 37 to 39
 

Output folders

Changed:
<
<
BrainStream saves output in the folder specified in the block file under topic Files and key OutFolder? .
>
>
BrainStream saves output in the folder specified in the block file under topic Files and key OutFolder.
  The output folder contains:

Revision 1014 Nov 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
Changed:
<
<
META TOPICPARENT name="BrainStream.BrainStreamDocs"
>
>
META TOPICPARENT name="WebHome"
 
<---Start1--->

Paths and Folders

Revision 914 Nov 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
Changed:
<
<
META TOPICPARENT name="BrainStreamDocs"
>
>
META TOPICPARENT name="BrainStream.BrainStreamDocs"
 
<---Start1--->

Paths and Folders

Changed:
<
<
Generate current PDF
>
>
Generate current PDF
 

Adding folders to the search path

Line: 67 to 67
 
  • Access control
    • Set DENYTOPICVIEW =
-->
Added:
>
>
META TOPICMOVED by="MarjoleinVanDerWaal" date="1321264431" from="BrainStream.DocsSectionsPathsFolders" to="BrainStreamDocs.DocsSectionsPathsFolders"

Revision 809 Nov 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="BrainStreamDocs"
<---Start1--->

Paths and Folders

Added:
>
>
Generate current PDF
 

Adding folders to the search path

Line: 18 to 20
 addpath('/Volumes/BCI/my_functions'); % add my_functions folder to the Matlab search path

Tip: Use the fullfile function

Added:
>
>
  It is recommended to use Matlab's fullfile function when you specify a file or folder. This ensures that the proper folders will be added on computers with different operating systems, as different systems may use either '/' or '\' as a file separator.
Added:
>
>
 

Tip: Use relative path names

It is recommended to use relative path names when you specify a folder, whether it is in the blocksettings or in functions like addpath. This means that you specify the path name of the folder you want to add relative to a folder of which the location is already known. The advantage of using relative path names is that the proper folders will be added also if you work on a different computer.

Revision 701 Nov 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="BrainStreamDocs"
<---Start1--->

Paths and Folders

Line: 8 to 8
  Files (e.g. functions or figures) and folders that are used in your experiment must be on the Matlab search path.
Changed:
<
<
At startup, BrainStream adds the BrainStream core folder and nearly all its subfolders to the search path. If you need additional files or folders, you must make sure they are added to the search path. It is possible to specify these folders in the block file under the keys MatlabPathFnc? or MatlabPathAdd? . Alternatively, you can use Matlab's addpath function to add individual folders. If you want to add a folder with all its subfolders, use addpath in combination with genpath:
>
>
At startup, BrainStream adds the BrainStream core folder and nearly all its subfolders to the search path. If you need additional files or folders, you must make sure they are added to the search path. It is possible to specify these folders in the block file under the keys MatlabPathFnc? or MatlabPathAdd? . Alternatively, you can use Matlab's addpath function to add individual folders. If you want to add a folder with all its subfolders, use addpath in combination with genpath:
 
addpath(pwd);          %adds the current working directory to the search path
addpath(genpath(pwd)); %adds the current working directory and all its subfolders to the search path 

Revision 601 Nov 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="BrainStreamDocs"
<---Start1--->

Paths and Folders

Line: 47 to 47
 runfolders: a separate runfolder is created for each block within the experiment. The name of the folder is the name of the block followed by _ and a number indicating how many times this block has been repeated. Each runfolder contains:
Changed:
<
<
log file
>
>
log file: gives an overview of everything that happened during your experiment.
  brainstream folder: contains copies of the user defined variables that have been saved with a 'save' statement in the Actions table.

Revision 527 Oct 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="BrainStreamDocs"
Added:
>
>
<---Start1--->
 

Paths and Folders

Line: 17 to 18
 addpath('/Volumes/BCI/my_functions'); % add my_functions folder to the Matlab search path

Tip: Use the fullfile function

Changed:
<
<
It is recommended to use Matlab's fullfile function when you specify a file or folder. This ensures that the proper folders will be added on computers with different operating systems, as different systems may use either '/' or '\' as a file separator.
>
>
It is recommended to use Matlab's fullfile function when you specify a file or folder. This ensures that the proper folders will be added on computers with different operating systems, as different systems may use either '/' or '\' as a file separator.
 

Tip: Use relative path names

It is recommended to use relative path names when you specify a folder, whether it is in the blocksettings or in functions like addpath. This means that you specify the path name of the folder you want to add relative to a folder of which the location is already known. The advantage of using relative path names is that the proper folders will be added also if you work on a different computer.

Line: 54 to 55
  raw_bdf folder: contains the raw EEG data.
Added:
>
>
<---End1--->

<-- 
  • Access control
    • Set DENYTOPICVIEW =
-->
 \ No newline at end of file

Revision 421 Oct 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="BrainStreamDocs"

Paths and Folders

Line: 7 to 7
  Files (e.g. functions or figures) and folders that are used in your experiment must be on the Matlab search path.
Changed:
<
<
-paths that are added by BrainStream (MatlabPathFnc)

If you need additional files or folders, you must add them to the search path yourself. You can use the addpath function to add individual folders. If you want to add a folder with all its subfolders, use addpath in combination with genpath:

>
>
At startup, BrainStream adds the BrainStream core folder and nearly all its subfolders to the search path. If you need additional files or folders, you must make sure they are added to the search path. It is possible to specify these folders in the block file under the keys MatlabPathFnc? or MatlabPathAdd? . Alternatively, you can use Matlab's addpath function to add individual folders. If you want to add a folder with all its subfolders, use addpath in combination with genpath:
 
addpath(pwd);          %adds the current working directory to the search path
addpath(genpath(pwd)); %adds the current working directory and all its subfolders to the search path 
Line: 18 to 16
 
function event = add_folder(event)
addpath('/Volumes/BCI/my_functions'); % add my_functions folder to the Matlab search path  
Added:
>
>

Tip: Use the fullfile function

It is recommended to use Matlab's fullfile function when you specify a file or folder. This ensures that the proper folders will be added on computers with different operating systems, as different systems may use either '/' or '\' as a file separator.

Tip: Use relative path names

It is recommended to use relative path names when you specify a folder, whether it is in the blocksettings or in functions like addpath. This means that you specify the path name of the folder you want to add relative to a folder of which the location is already known. The advantage of using relative path names is that the proper folders will be added also if you work on a different computer.

In BrainStream, you can make use of the bs_folder function. For example, with input argument 'BLOCK', the output of this function is the path to the folder containing the block file of the experiment. If the block file is located in '/Volumes/BCI/my_bci/blockfile', and you want to add a folder which contains your functions and is located in '/Volumes/BCI/my_bci/functions', you can specify this folder like this:

functionfolder = fullfile(bs_folder('BLOCK'),..,'functions') % N.B. the '..' expression means going up one level

For more information about the bs_folder function and its input arguments, see the function index.

 

Output folders

Line: 45 to 54
  raw_bdf folder: contains the raw EEG data.
Deleted:
<
<

Relative path names

It is recommended to always use relative path names when you specify a folder, whether it is in the blocksettings or in functions like addpath. This means that you specify the path name of the folder you want to add relative to a folder of which the location is already known. The advantage of using relative path names is that the proper folders will be added also if you work on a different computer.

In BrainStream, you can make use of the bs_folder function. For example, with input argument 'BLOCK', the output of this function is the path to the folder containing the block file of the experiment. If the block file is located in '/Volumes/BCI/my_bci/blockfile', and you want to add a folder which contains your functions and is located in '/Volumes/BCI/my_bci/functions', you can specify this folder like this:

functionfolder = fullfile(bs_folder('BLOCK'),..,'functions') % N.B. the '..' expression means going up one level
For more information about the bs_folder function and its input arguments, see the function index.
 \ No newline at end of file

Revision 321 Oct 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="BrainStreamDocs"

Paths and Folders

Line: 51 to 51
 It is recommended to always use relative path names when you specify a folder, whether it is in the blocksettings or in functions like addpath. This means that you specify the path name of the folder you want to add relative to a folder of which the location is already known. The advantage of using relative path names is that the proper folders will be added also if you work on a different computer.

In BrainStream, you can make use of the bs_folder function. For example, with input argument 'BLOCK', the output of this function is the path to the folder containing the block file of the experiment. If the block file is located in '/Volumes/BCI/my_bci/blockfile', and you want to add a folder which contains your functions and is located in '/Volumes/BCI/my_bci/functions', you can specify this folder like this:

Changed:
<
<
functionfolder = fullfile(bs_folder('BLOCK'),..,'functions') % N.B. the '..' expression means going up one level
For more information about the bs_folder function and its input arguments, see the function index.
>
>
functionfolder = fullfile(bs_folder('BLOCK'),..,'functions') % N.B. the '..' expression means going up one level
For more information about the bs_folder function and its input arguments, see the function index.
 \ No newline at end of file

Revision 220 Oct 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="BrainStreamDocs"

Paths and Folders

Adding folders to the search path

Changed:
<
<
Files (functions) and folders that are used in your experiment must be on the Matlab search path. For more information, see Using the Matlab search path.
>
>
Files (e.g. functions or figures) and folders that are used in your experiment must be on the Matlab search path.
 
Changed:
<
<
-paths that are added by BrainStream
>
>
-paths that are added by BrainStream (MatlabPathFnc)
 
Changed:
<
<
If you need additional files or folders, you must add them to the search path yourself. You can use the addpath function to add individual folders. If you want to add a folder with all its subfolders, use addpath in combination with genpath:
>
>
If you need additional files or folders, you must add them to the search path yourself. You can use the addpath function to add individual folders. If you want to add a folder with all its subfolders, use addpath in combination with genpath:
 
addpath(pwd);          %adds the current working directory to the search path
addpath(genpath(pwd)); %adds the current working directory and all its subfolders to the search path 
Line: 45 to 45
  raw_bdf folder: contains the raw EEG data.
Added:
>
>
 

Relative path names

Changed:
<
<
It is recommended to always use relative path names when you specify a folder. This means that you specify the path name of the folder you want to add relative to a folder of which the location is already known. The advantage of using relative path names is that the proper folders will be added on com
>
>
It is recommended to always use relative path names when you specify a folder, whether it is in the blocksettings or in functions like addpath. This means that you specify the path name of the folder you want to add relative to a folder of which the location is already known. The advantage of using relative path names is that the proper folders will be added also if you work on a different computer.
 
Changed:
<
<
In BrainStream, you can use the bs_folder function. For example, with input argument 'BLOCK', the output of this function is the path to the folder containing the block file of the experiment. If the block file is located in '/Volumes/BCI/my_bci/blockfile', and you want to add a folder which contains your functions and is located in '/Volumes/BCI/my_bci/functions', you can specify this folder like this:
functionfolder = fullfile(bs_folder('BLOCK'),..,'functions') % N.B. the '..' expression means going up one level
For more information about the bs_folder function and its input arguments, see the function index.
>
>
In BrainStream, you can make use of the bs_folder function. For example, with input argument 'BLOCK', the output of this function is the path to the folder containing the block file of the experiment. If the block file is located in '/Volumes/BCI/my_bci/blockfile', and you want to add a folder which contains your functions and is located in '/Volumes/BCI/my_bci/functions', you can specify this folder like this:
functionfolder = fullfile(bs_folder('BLOCK'),..,'functions') % N.B. the '..' expression means going up one level
For more information about the bs_folder function and its input arguments, see the function index.

Revision 120 Oct 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
Added:
>
>
META TOPICPARENT name="BrainStreamDocs"

Paths and Folders

Adding folders to the search path

Files (functions) and folders that are used in your experiment must be on the Matlab search path. For more information, see Using the Matlab search path.

-paths that are added by BrainStream

If you need additional files or folders, you must add them to the search path yourself. You can use the addpath function to add individual folders. If you want to add a folder with all its subfolders, use addpath in combination with genpath:

addpath(pwd);          %adds the current working directory to the search path
addpath(genpath(pwd)); %adds the current working directory and all its subfolders to the search path 

It is often useful to write a user defined function that adds all necessary paths and execute this function at the start of the experiment (e.g. at the BS_INIT marker). For example, if the experiment needs access to functions that are located in the folder /Volumes/BCI/my_functions, you could make a function:

function event = add_folder(event)
addpath('/Volumes/BCI/my_functions'); % add my_functions folder to the Matlab search path  

Output folders

BrainStream saves output in the folder specified in the block file under topic Files and key OutFolder? .

The output folder contains:

subject folders: a separate folder is created for each new subject. The folder has the subject's name.

session folders: a separate folder is created for each session with the same subject. The folder's name is the date of the session (YYYYMMDD).

session folder ('brainstream'): contains the most recently saved version of user defined variables. This is the folder where BrainStream looks for variables when a 'load' statement is specified in the Actions table.

runfolders: a separate runfolder is created for each block within the experiment. The name of the folder is the name of the block followed by _ and a number indicating how many times this block has been repeated. Each runfolder contains:

log file

brainstream folder: contains copies of the user defined variables that have been saved with a 'save' statement in the Actions table.

expdefs folder: contains copies of the experiment definition tables and blocksettings.

raw_bdf folder: contains the raw EEG data.

Relative path names

It is recommended to always use relative path names when you specify a folder. This means that you specify the path name of the folder you want to add relative to a folder of which the location is already known. The advantage of using relative path names is that the proper folders will be added on com

In BrainStream, you can use the bs_folder function. For example, with input argument 'BLOCK', the output of this function is the path to the folder containing the block file of the experiment. If the block file is located in '/Volumes/BCI/my_bci/blockfile', and you want to add a folder which contains your functions and is located in '/Volumes/BCI/my_bci/functions', you can specify this folder like this:

functionfolder = fullfile(bs_folder('BLOCK'),..,'functions') % N.B. the '..' expression means going up one level
For more information about the bs_folder function and its input arguments, see the function index.
 
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback