More #1461

Author: dcwhite

src/Modules/BrainStimulator/ElectrodeCoilSetup.h

@@ -6,7 +6,7 @@
    Copyright (c) 2015 Scientific Computing and Imaging Institute,
    University of Utah.
 
-   
+
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
@@ -26,22 +26,22 @@
    DEALINGS IN THE SOFTWARE.
 */
 ///@file ElectrodeCoilSetup
-///@brief With this module the user is able to position tDCS electrodes and TMS coils to setup a simulation scenario. 
-///  
+///@brief With this module the user is able to position tDCS electrodes and TMS coils to setup a simulation scenario.
+///
 ///
 ///@author
 /// Moritz Dannhauer
 ///
 ///@details
 /// The module gets the triangulated scalp surface as the first input and a matrix of possible locations as the second. The third and any following input fields (dynamic input ports)
 /// are considered to be prototypes of electrodes or TMS coils that need to be positioned. After the first execution using a minimum of 3 (valid) inputs the positions appear as table rows
-/// in the GUI. The GUI allows to assign a prototype (first table column), normal direction etc. as well as the type of stimulation (second table column). Based on the choices made in the  
+/// in the GUI. The GUI allows to assign a prototype (first table column), normal direction etc. as well as the type of stimulation (second table column). Based on the choices made in the
 /// first (prototype, "Input #") and second column (stimulation type, "Type") information are gathered from the rest of the row. An defined tDCS electrode or TMS coil will be moved using
 /// its location ("X","Y","Z"), its normal ("NX","NY","NZ") and can be rotated along its normal by the angle table cell defined in degrees. Throughout this table, multiple electrodes and TMS coils
 /// can be located at their final destinations. For a tDCS electrode specification, the placed and oriented prototype (contains electrode dimension) is used to cut the scalp that is covered by the
-/// electrode. This piece of scalp and its normals are used to generate the electrode sponge shape by using the thickness table parameter. The module contains three outputs: 1) the averaged scalp 
+/// electrode. This piece of scalp and its normals are used to generate the electrode sponge shape by using the thickness table parameter. The module contains three outputs: 1) the averaged scalp
 /// sponge locations (+thickness, as a DenseMatrix) which are designed to be the last input of the SetupTDCS module, 2) a collection of all valid tDCS electrodes and 3) a collection of all
-/// valid TMS coil inputs that are represented by rotated points and dipole normals approximating the magnetic field. 
+/// valid TMS coil inputs that are represented by rotated points and dipole normals approximating the magnetic field.
 
 #ifndef MODULES_BRAINSTIMULATOR_ELECTRODECOILSETUP_H
 #define MODULES_BRAINSTIMULATOR_ELECTRODECOILSETUP_H
@@ -66,17 +66,18 @@ class SCISHARE ElectrodeCoilSetupModule : public SCIRun::Dataflow::Networks::Mod
 
     virtual void execute();
     virtual void setStateDefaults();
-    
+
     virtual bool hasDynamicPorts() const override { return true; }
-    
+
     INPUT_PORT(0, SCALP_SURF, LegacyField);
     INPUT_PORT(1, LOCATIONS, Matrix);
-    INPUT_PORT_DYNAMIC(2, ELECTRODECOILPROTOTYPES, LegacyField);    
+    INPUT_PORT_DYNAMIC(2, ELECTRODECOILPROTOTYPES, LegacyField);
     OUTPUT_PORT(0, ELECTRODE_SPONGE_LOCATION_AVR, Matrix);
     OUTPUT_PORT(1, MOVED_ELECTRODES_FIELD, LegacyField);
     OUTPUT_PORT(2, FINAL_ELECTRODES_FIELD, LegacyField);
     OUTPUT_PORT(3, COILS_FIELD, LegacyField);
-    
+
+    NEW_BRAIN_STIMULATOR_MODULE
 };
 
 }}}

src/Modules/BrainStimulator/GenerateROIStatistics.h

@@ -6,7 +6,7 @@
    Copyright (c) 2015 Scientific Computing and Imaging Institute,
    University of Utah.
 
-   
+
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
@@ -26,27 +26,27 @@
    DEALINGS IN THE SOFTWARE.
 */
 
-///@file 
+///@file
 /// GenerateROIStatisticsModule.cc
-///@brief 
+///@brief
 /// This module allows to perform statistical analysis of simulation results and is part of the BrainStimulator package.
-/// 
+///
 ///@author
 /// Moritz Dannhauer
 ///
 ///@details
 /// The GUI presents two tables that are functionally different.
-/// First, the upper table is for output only and presents any statistical results where each ROI is one row in the table. In its default state the module will analyze 
-/// and present results for all ROIs that are correctly provided as inputs. Second, the lower table is meant to be able to define an individual ROI based on several critia (location, 
+/// First, the upper table is for output only and presents any statistical results where each ROI is one row in the table. In its default state the module will analyze
+/// and present results for all ROIs that are correctly provided as inputs. Second, the lower table is meant to be able to define an individual ROI based on several critia (location,
 /// material label number and a radius that defines a spherical ROI around it). Once valid parameter are provided (in lower table, e.g. radius > 0) the results will be presented in the upper table after
 /// module execution.
 /// Two inputs have to be provided to be able to run the module it. The first input is a field that contains the simulation data defined on a mesh (tested with tetrahedra) elements.
 /// The third input represents the atlas that is identical in terms of geometry but contains label numbers (>0) to define anatomical regions. The anatomical regions can be used to
 /// compute descriptive statistics (avr., stddev., min, max). All other inputs are optional. You can provide anatomical names as a string (separated by ";", e.g. region1;region2) that must be ordered
 /// in a way that they match up with the ordered label numbers. An addtional (latvol) input can be provided to define a coordinate space to query anatomical statistics of common
 /// and self-defined neurological spaces such as Talairach or MNI space. The module is therefore generic since any anatomical data are provided by inputs only.
-/// Using the second and seventh input, GUI labels describing the analysis (the physical unit the first input is in; the name of the cordinate space system that is used) can be provided.   
-/// The user is responsible for providing appropriate inputs that are registered etc. 
+/// Using the second and seventh input, GUI labels describing the analysis (the physical unit the first input is in; the name of the cordinate space system that is used) can be provided.
+/// The user is responsible for providing appropriate inputs that are registered etc.
 /// You can use the tutorial walkthrough and example networks to explore its functionality.
 
 #ifndef MODULES_BRAINSTIMULATOR_GenerateROIStatistics_H
@@ -77,9 +77,10 @@ class SCISHARE GenerateROIStatisticsModule : public SCIRun::Dataflow::Networks::
     INPUT_PORT(3, AtlasMeshLabels, String);
     INPUT_PORT(4, CoordinateSpace, LegacyField);
     INPUT_PORT(5, CoordinateSpaceLabel, String);
-    
+
     OUTPUT_PORT(0, StatisticalResults, Matrix);
 
+    NEW_BRAIN_STIMULATOR_MODULE
 };
 
 }}}

src/Modules/BrainStimulator/SetConductivitiesToTetMesh.h

@@ -6,7 +6,7 @@
    Copyright (c) 2015 Scientific Computing and Imaging Institute,
    University of Utah.
 
-   
+
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
@@ -35,7 +35,7 @@
 /// Moritz Dannhauer
 ///@details
 /// The SetConductivitiesToTetMesh module uses a single field input and assigns conductivities to output field that are provided by the GUI elements to work in the BrainStimulator environment (uses SI units).
-/// The module looks for the numbers in round brackets (range visible in GUI) of the input field and sends them to the algorithm to be converted to the conductivities (specified in GUI). 
+/// The module looks for the numbers in round brackets (range visible in GUI) of the input field and sends them to the algorithm to be converted to the conductivities (specified in GUI).
 ///
 
 #ifndef MODULES_BRAINSTIMULATOR_SetConductivitiesToTetMesh_H
@@ -60,6 +60,8 @@ class SCISHARE SetConductivitiesToMesh : public SCIRun::Dataflow::Networks::Modu
 
     INPUT_PORT(0, InputField, LegacyField);
     OUTPUT_PORT(0, OutputField, LegacyField);
+
+    NEW_BRAIN_STIMULATOR_MODULE
 };
 
 }}}

src/Modules/BrainStimulator/SetupRHSforTDCSandTMS.h

@@ -6,7 +6,7 @@
    Copyright (c) 2015 Scientific Computing and Imaging Institute,
    University of Utah.
 
-   
+
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
@@ -27,23 +27,23 @@
 */
 
 ///@file SetupRHSforTDCSandTMS
-///@brief 
-/// This module sets up TDCS problem by providing the right hand side vector (controlled by GUI) and inputs for the modules: AddKnownsToLinearSystem, BuildTDCSMatrix. 
+///@brief
+/// This module sets up TDCS problem by providing the right hand side vector (controlled by GUI) and inputs for the modules: AddKnownsToLinearSystem, BuildTDCSMatrix.
 ///
 ///@author
 /// Moritz Dannhauer, Spencer Frisby
 ///
 ///@details
 /// .The module gets 4 inputs the tetrahedral mesh (first), triangle surfaces (as part of the first input) for the scalp (second) and electrodes sponges (third) as well as the a matrix (output of ElectrodeCoilSetup)
-///  that contains the center location and thickness of the electrode sponge. The first output contains the knowns (reference zeros node) of the linear system (third input of AddKnownsToLinearSystem). 
+///  that contains the center location and thickness of the electrode sponge. The first output contains the knowns (reference zeros node) of the linear system (third input of AddKnownsToLinearSystem).
 ///  The zero potential node is set to be the first mesh node by default, which can be chosen arbitrarily in the GUI by the user. The second until fifth output prepares the inputs for the BuildTDCSMatrix module that
 ///  combines the FEM stiffness matrix with the boundary conditions of the complete electrode model. The electrical impedances can be provided in the GUI for each electrode individually.
-///  The module needs to identify the surface of the sponge which makes up the major part of the algorithmic module implementation. 
-///  The sixth output creates the right hand side (RHS) vector that can be provided by the GUI. The electrical charges (ingoing and outgoing current intensities) need to sum up zero. 
+///  The module needs to identify the surface of the sponge which makes up the major part of the algorithmic module implementation.
+///  The sixth output creates the right hand side (RHS) vector that can be provided by the GUI. The electrical charges (ingoing and outgoing current intensities) need to sum up zero.
 ///  If you execute the module once the module will graphically only present the number of electrodes defined in the input data.
 ///  The complete electrode model solves the nodal and electrode potentials in an agumented linear system the potential solution (output of SolveLinearSystem) needs to adjuested.
-///  Therefore, a seventh output is provided that contains the relevant indeces to be used for the module 'SelectSubMatrix'. 
-///  Since the identification of the contact surface between electrode sponge and the electrode itself (the sponge surface top is assumed to be that) is a difficult geometrical process the eighth 
+///  Therefore, a seventh output is provided that contains the relevant indeces to be used for the module 'SelectSubMatrix'.
+///  Since the identification of the contact surface between electrode sponge and the electrode itself (the sponge surface top is assumed to be that) is a difficult geometrical process the eighth
 ///  output provides a triangle mesh that can be used for visual inspection (->ShowField->ViewScene).
 
 #ifndef MODULES_BRAINSTIMULATOR_SetupRHSforTDCSandTMS_H
@@ -72,7 +72,7 @@ class SCISHARE SetupTDCS : public SCIRun::Dataflow::Networks::Module,
     INPUT_PORT(1, SCALP_TRI_SURF_MESH, LegacyField);
     INPUT_PORT(2, ELECTRODE_TRI_SURF_MESH, LegacyField);
     INPUT_PORT(3, ELECTRODE_SPONGE_LOCATION_AVR, Matrix);
-    
+
     OUTPUT_PORT(0, LHS_KNOWNS, Matrix);
     OUTPUT_PORT(1, ELECTRODE_ELEMENT, Matrix);
     OUTPUT_PORT(2, ELECTRODE_ELEMENT_TYPE, Matrix);
@@ -81,6 +81,8 @@ class SCISHARE SetupTDCS : public SCIRun::Dataflow::Networks::Module,
     OUTPUT_PORT(5, RHS, Matrix);
     OUTPUT_PORT(6, SELECTMATRIXINDECES, Matrix);
     OUTPUT_PORT(7, ELECTRODE_SPONGE_SURF, LegacyField);
+
+    NEW_BRAIN_STIMULATOR_MODULE
 };
 
 }}}

src/Modules/BrainStimulator/SimulateForwardMagneticField.h

@@ -6,7 +6,7 @@
    Copyright (c) 2015 Scientific Computing and Imaging Institute,
    University of Utah.
 
-   
+
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
@@ -63,10 +63,11 @@ class SCISHARE SimulateForwardMagneticFieldModule : public SCIRun::Dataflow::Net
     INPUT_PORT(1, ConductivityTensor, LegacyField);
     INPUT_PORT(2, DipoleSources, LegacyField);
     INPUT_PORT(3, DetectorLocations, LegacyField);
-    
+
     OUTPUT_PORT(0, MagneticField, LegacyField);
     OUTPUT_PORT(1, MagneticFieldMagnitudes, LegacyField);
 
+    LEGACY_BIOPSE_MODULE
 };
 
 }}}