Commit 36937d08 authored by Jussi Lindgren's avatar Jussi Lindgren

everything:

 * Fixed lots of typographic errors. Thanks to ozan.caglayan for pointing them out.
parent 99baac98
......@@ -1193,7 +1193,7 @@ OpenViBE::boolean CBoxAlgorithmSkeletonGenerator::initialize( void )
m_vTooltips[l_pTooltipButton_nameVersion] = CString("Box Name: \nThis name will be the one displayed in the Designer.\nUsually, the box name reflects its main purpose.\nPlease also enter a version number for your box.\nAuthorized characters: letters (lower and upper case), numbers, special characters '()[]._-'\n------\nExample: Clock Stimulator (tic tac), version 1.2");
m_vTooltips[l_pTooltipButton_category] = CString("Category: \nThe category decides where the box will be strored in designer's box panel.\nYou can refer to an existing category, already used in the designer, or choose a new one.\nIf you need to specifiy a subcategory, use the character '/'.\nAuthorized characters: letters (lower and upper case) and spaces.\n------\nExample: Samples/Seleton Generator\n");
m_vTooltips[l_pTooltipButton_description] = CString("Description: \nThe short description will be displayed next to the box in the designer box panel.\nThe detailed description is showed on the 'About Box...' panel.\nAll characters are authorized.\n------\nExample:\nShort Description : Periodic stimulation generator\nDetailed description : This box triggers stimulation at fixed frequency.");
m_vTooltips[l_pTooltipButton_icon] = CString("Box Icon: \nThe icon used in the designer box panel for this box.\nThis is an optionnal field.\n------\nExample: 'gtk-help' will be the corresponding gtk stock item (depending on the gtk theme used)\n\n\n");
m_vTooltips[l_pTooltipButton_icon] = CString("Box Icon: \nThe icon used in the designer box panel for this box.\nThis is an optional field.\n------\nExample: 'gtk-help' will be the corresponding gtk stock item (depending on the gtk theme used)\n\n\n");
m_vTooltips[l_pTooltipButton_inputs] = CString("Inputs: \nUse the 'Add' and 'Remove' buttons to set all the inputs your box will have.\nWhen pressing 'Add' a dialog window will appear to know the name and type of the new input.\n------\nExample:\n'Incoming Signal' of type 'Signal'\n\n");
m_vTooltips[l_pTooltipButton_inputs_modify] = CString("Modify: \nCheck this option if the input(s) of your box can be modified (type and name) in the Designer by right-clicking the box.\nIn the implementation, this option decides whether or not the box will have the flag 'BoxFlag_CanModifyInput'.\n\n\n\n\n");
m_vTooltips[l_pTooltipButton_inputs_addRemove] = CString("Add/Remove: \nCheck this option if the user must be able to add (or remove) inputs, by right-clicking the box.\nIn the implementation, this option decides whether or not the box will have the flag 'BoxFlag_CanAddInput'.\n\n\n\n");
......
......@@ -45,11 +45,11 @@ namespace OpenViBESkeletonGenerator
OpenViBE::boolean executeSedCommand(OpenViBE::CString sTemplateFile, OpenViBE::CString sCommand, OpenViBE::CString sDestinationFile = OpenViBE::CString(""));
// executes a sed substitution and build a new file, by replacing the tag by the substitute. Sed-compliancy is verified. If no destination file is provided, the template file is modified.
OpenViBE::boolean executeSedSubstitution(OpenViBE::CString sTemplateFile, OpenViBE::CString sTag, OpenViBE::CString sSubstitute, OpenViBE::CString sDestinationFile = OpenViBE::CString(""));
// get the formated string date
// get the formatted string date
OpenViBE::CString getDate();
// generate a new file, giving a template file, a destination file, and a map ofsubstitutions (Tag,Substitute)
// return false if an error occured.
// return false if an error occurred.
OpenViBE::boolean generate(OpenViBE::CString sTemplateFile, OpenViBE::CString sDestinationFile, std::map<OpenViBE::CString,OpenViBE::CString> mSubstitutions, OpenViBE::CString& rLog);
virtual void getCurrentParameters(void) = 0;
......
......@@ -137,7 +137,7 @@ namespace OpenViBEAcquisitionServer
* \note This function can be called several times if needed
* but does not change what \ref getDriftSampleCount
* returns until the next \ref IDriver::loop execution
* \warning Please be carefull when calling this function.
* \warning Please be careful when calling this function.
* Consider the fact that there could be some drifting
* in the device and ths OS-level driver itself, or even
* in the communication pipeline to the prorprietary
......@@ -159,14 +159,14 @@ namespace OpenViBEAcquisitionServer
* and are usually not provided by the device manufacturer. An intelligent
* setup based on hardware tagging could however induce a fair estimate of this
* latency so that it can be injected in the drift correction process.
* Driver developpers will generally not have to care about this feature.
* Driver developers will generally not have to care about this feature.
* However, if it is important to have neurophysiologically relevant measures
* (more particularly on ERPs) and it is know that the driver and / or hardware
* has a latency, this latency compensation can be injected in the drift correction
* process using the aforementionned function.
*
* \note Passing a positive value supposes the driver / hardware induce a delay which shall be corrected
* \note Passing a negative value supposes the driver / hardware is able to predict and send future measures before they actually get measured (probably not recommanded)
* \note Passing a negative value supposes the driver / hardware is able to predict and send future measures before they actually get measured (probably not recommended)
* \note Passing 0 supposes both the driver and hardware are ideals and send samples immediately to the acquisition server as they happen on the scalp
* \note Default configuration supposes both the driver and hardware are ideal, thus sets the inner latency to 0
*
......@@ -385,7 +385,7 @@ namespace OpenViBEAcquisitionServer
*
* Filling these information can be done any way you want... But
* if the driver developer wants to use a GUI for this, it is
* recommanded to use Glade/GTK since the acquisition server
* recommended to use Glade/GTK since the acquisition server
* already uses this API. If you use Glade/GTK, you won't have to
* perform API initialization ; this is done by the acquisition server
* already. It is the responsability of the driver developer to
......@@ -439,7 +439,7 @@ namespace OpenViBEAcquisitionServer
* \return the header information for the session
*
* The returned header is used by the acquisition server to send
* encapsulated data to the platform at the begining of the sending
* encapsulated data to the platform at the beginning of the sending
* process. This header should be filled by the information collected
* from the hardware or the driver itself when configure is called.
*
......
......@@ -297,7 +297,7 @@ boolean CDriverBrainProductsBrainampSeries::initialize(
m_ui32SampleCountPerSentBlock=ui32SampleCountPerSentBlock;
m_ui16Marker=0;
// -- Optionnaly starts impedance check
// -- Optionally starts impedance check
m_rDriverContext.getLogManager() << LogLevel_Trace << (m_rDriverContext.isImpedanceCheckRequested()?"Impedance will be checked":"Impedance won't be checked") << "\n";
if(m_rDriverContext.isImpedanceCheckRequested())
......@@ -316,7 +316,7 @@ boolean CDriverBrainProductsBrainampSeries::start(void)
if(!m_rDriverContext.isConnected()) { return false; }
if(m_rDriverContext.isStarted()) { return false; }
// -- Optionnaly stops impedance check
// -- Optionally stops impedance check
if(m_rDriverContext.isImpedanceCheckRequested())
{
......@@ -520,7 +520,7 @@ boolean CDriverBrainProductsBrainampSeries::stop(void)
m_rDriverContext.getLogManager() << LogLevel_Error << "Could not stop acquisition\n";
}
// -- Optionnaly starts impedance check
// -- Optionally starts impedance check
if(m_rDriverContext.isImpedanceCheckRequested())
{
......@@ -538,7 +538,7 @@ boolean CDriverBrainProductsBrainampSeries::uninitialize(void)
if(!m_rDriverContext.isConnected()) { return false; }
if(m_rDriverContext.isStarted()) { return false; }
// -- Optionnaly stops impedance check
// -- Optionally stops impedance check
if(m_rDriverContext.isImpedanceCheckRequested())
{
......
......@@ -524,13 +524,13 @@ boolean CConfigurationBrainProductsVAmp::controlVampService(boolean bStartServic
{
if (l_handleService != NULL)
{
m_rDriverContext.getLogManager() << LogLevel_Error << " [VampService] An error occured with the VampService handler (err code "<<(uint32)GetLastError()<<".\n";
m_rDriverContext.getLogManager() << LogLevel_Error << " [VampService] An error occurred with the VampService handler (err code "<<(uint32)GetLastError()<<".\n";
CloseServiceHandle(l_handleService);
l_handleService = NULL;
}
if (l_handleSCM != NULL)
{
m_rDriverContext.getLogManager() << LogLevel_Error << " [VampService] An error occured with the SCManager handler (err code "<<(uint32)GetLastError()<<".\n";
m_rDriverContext.getLogManager() << LogLevel_Error << " [VampService] An error occurred with the SCManager handler (err code "<<(uint32)GetLastError()<<".\n";
CloseServiceHandle(l_handleSCM);
l_handleSCM = NULL;
}
......
......@@ -277,13 +277,13 @@ boolean CDriverEmotivEPOC::loop(void)
m_ui32EDK_LastErrorCode = EE_DataUpdateHandle(m_ui32UserID, m_tDataHandle);
if(m_ui32EDK_LastErrorCode != EDK_OK)
{
m_rDriverContext.getLogManager() << LogLevel_Error << "[LOOP] Emotiv Driver: An error occured while updating the DataHandle. EDK Error Code [" << m_ui32EDK_LastErrorCode << "]\n";
m_rDriverContext.getLogManager() << LogLevel_Error << "[LOOP] Emotiv Driver: An error occurred while updating the DataHandle. EDK Error Code [" << m_ui32EDK_LastErrorCode << "]\n";
return false;
}
m_ui32EDK_LastErrorCode = EE_DataGetNumberOfSample(m_tDataHandle, &l_ui32nSamplesTaken);
if(m_ui32EDK_LastErrorCode != EDK_OK)
{
m_rDriverContext.getLogManager() << LogLevel_Error << "[LOOP] Emotiv Driver: An error occured while getting new samples from device. EDK Error Code [" << m_ui32EDK_LastErrorCode << "]\n";
m_rDriverContext.getLogManager() << LogLevel_Error << "[LOOP] Emotiv Driver: An error occurred while getting new samples from device. EDK Error Code [" << m_ui32EDK_LastErrorCode << "]\n";
return false;
}
// warning : if you connect/disconnect then reconnect, the internal buffer may be full of samples, thus maybe l_ui32nSamplesTaken > m_ui32SampleCountPerSentBlock
......@@ -298,7 +298,7 @@ boolean CDriverEmotivEPOC::loop(void)
m_ui32EDK_LastErrorCode = EE_DataGet(m_tDataHandle, g_ChannelList[i], l_pBuffer, l_ui32nSamplesTaken);
if(m_ui32EDK_LastErrorCode != EDK_OK)
{
m_rDriverContext.getLogManager() << LogLevel_Error << "[LOOP] Emotiv Driver: An error occured while getting new samples from device. EDK Error Code [" << m_ui32EDK_LastErrorCode << "]\n";
m_rDriverContext.getLogManager() << LogLevel_Error << "[LOOP] Emotiv Driver: An error occurred while getting new samples from device. EDK Error Code [" << m_ui32EDK_LastErrorCode << "]\n";
return false;
}
......@@ -319,7 +319,7 @@ boolean CDriverEmotivEPOC::loop(void)
m_ui32EDK_LastErrorCode = EE_DataGet(m_tDataHandle, g_ChannelList[i], l_pBuffer, l_ui32nSamplesTaken);
if(m_ui32EDK_LastErrorCode != EDK_OK)
{
m_rDriverContext.getLogManager() << LogLevel_Error << "[LOOP] Emotiv Driver: An error occured while getting new samples from device. EDK Error Code [" << m_ui32EDK_LastErrorCode << "]\n";
m_rDriverContext.getLogManager() << LogLevel_Error << "[LOOP] Emotiv Driver: An error occurred while getting new samples from device. EDK Error Code [" << m_ui32EDK_LastErrorCode << "]\n";
return false;
}
m_pSample[i] = (float32)l_pBuffer[s];
......
......@@ -232,7 +232,7 @@ boolean CConfigurationNeuroskyMindset::preConfigure(void)
else if(l_iErrCode == -2)
m_rDriverContext.getLogManager() << LogLevel_Info << " Last TG_ReadPackets error: -2, 0 bytes on the stream\n";
else if(l_iErrCode == -3)
m_rDriverContext.getLogManager() << LogLevel_Info << " Last TG_ReadPackets error: -3, I/O error occured\n";
m_rDriverContext.getLogManager() << LogLevel_Info << " Last TG_ReadPackets error: -3, I/O error occurred\n";
else
m_rDriverContext.getLogManager() << LogLevel_Info << " Last TG_ReadPackets error: " << l_iErrCode << ", Unknown\n";
}
......
......@@ -216,7 +216,7 @@ boolean CDriverNeuroskyMindset::initialize(
else if(l_iErrCode == -2)
m_rDriverContext.getLogManager() << LogLevel_Info << " Last TG_ReadPackets error: -2, 0 bytes on the stream\n";
else if(l_iErrCode == -3)
m_rDriverContext.getLogManager() << LogLevel_Info << " Last TG_ReadPackets error: -3, I/O error occured\n";
m_rDriverContext.getLogManager() << LogLevel_Info << " Last TG_ReadPackets error: -3, I/O error occurred\n";
else
m_rDriverContext.getLogManager() << LogLevel_Info << " Last TG_ReadPackets error: " << l_iErrCode << ", Unknown\n";
}
......
......@@ -1341,7 +1341,7 @@ boolean CDesignerVisualisation::removeVisualisationPanel()
//destroy hierarchy but only unaffect visualisation boxes (as opposed to destroying them)
if(m_rVisualisationTree.destroyHierarchy(m_rVisualisationTree.getVisualisationWidget(l_oVisualisationPanelIdentifier)->getIdentifier(), false) == false)
{
displayErrorDialog("Tab removal failed !", "An error occured while destroying widget hierarchy.");
displayErrorDialog("Tab removal failed !", "An error occurred while destroying widget hierarchy.");
return false;
}
......
......@@ -327,7 +327,7 @@ int edf_set_label(int handle, int edfsignal, const char *label);
/* Sets the label (name) of signal edfsignal. ("FP1", "SaO2", etc.) */
/* label is a pointer to a NULL-terminated ASCII-string containing the label (name) of the signal edfsignal */
/* Returns 0 on success, otherwise -1 */
/* This function is recommanded for every signal when you want to write a file */
/* This function is recommended for every signal when you want to write a file */
/* and can be called only after opening a file in writemode and before the first sample write action */
......@@ -354,7 +354,7 @@ int edf_set_physical_dimension(int handle, int edfsignal, const char *phys_dim);
/* Sets the physical dimension of signal edfsignal. ("uV", "BPM", "mA", "Degr.", etc.) */
/* phys_dim is a pointer to a NULL-terminated ASCII-string containing the physical dimension of the signal edfsignal */
/* Returns 0 on success, otherwise -1 */
/* This function is recommanded for every signal when you want to write a file */
/* This function is recommended for every signal when you want to write a file */
/* and can be called only after opening a file in writemode and before the first sample write action */
......
......@@ -67,7 +67,7 @@ __________________________________________________________________
* needs. First, it only works on Linux for now. Second, it does not use
* a sound file reading nor a sound card management API. It simply directly
* sends an uncompressed wave file to the dsp device. This results in a
* non audible articfact due to the header of the wave file. Also, the
* non audible artifact due to the header of the wave file. Also, the
* wave file sampling rate should be at the exact same value as the
* configuration of the dsp device.
*
......
......@@ -9,7 +9,7 @@ __________________________________________________________________
This box can process data from and to OpenViBE using Python script.
Available IO types are Streamed Matrix, Signal and Stimulations.
The user Pyhton Script must define a new class that inherits from OVBox,
The user Python Script must define a new class that inherits from OVBox,
and implements the initialize, process and uninitialize methods.
User script must end with : box = MyOVBox() where MyOVBox is the new class.
......
......@@ -10,7 +10,7 @@ __________________________________________________________________
This box computes spatial filters according to the Common Spatial Pattern algorithm. The goal of the algorithm is to improve the discrimination of two types of signals.
The spatial filters are constructed in a way they maximize the variance for signals of the first condition while at the same time they minimize it for the second condition.
This can be used for discriminating the signals of two commonly used motor-imagery tasks (e.g. left versus right hand movement).
It can also be used for two-class SSVEP experiments or any other experiment where the disciminative information is contained in the variance (or power in a certain band) of the signal conditions.
It can also be used for two-class SSVEP experiments or any other experiment where the discriminative information is contained in the variance (or power in a certain band) of the signal conditions.
Please note that this implementation computes a <b>trace normalization</b>.
......@@ -43,7 +43,7 @@ __________________________________________________________________
* |OVP_DocEnd_BoxAlgorithm_CSPSpatialFilterTrainer_Outputs|
* |OVP_DocBegin_BoxAlgorithm_CSPSpatialFilterTrainer_Output1|
The CSP Trainer outputs the stimulation <b>OVTK_StimulationId_TrainCompleted</b> when the training process was successfull. No output is produced if the process failed.
The CSP Trainer outputs the stimulation <b>OVTK_StimulationId_TrainCompleted</b> when the training process was successful. No output is produced if the process failed.
* |OVP_DocEnd_BoxAlgorithm_CSPSpatialFilterTrainer_Output1|
__________________________________________________________________
......
......@@ -72,7 +72,7 @@ __________________________________________________________________
* |OVP_DocBegin_BoxAlgorithm_Downsampling_Examples|
* Let's consider our input signal sampling rate is 1 kHz.
* If the new selected sampling rate is 200 Hz and the Frequency
* cutoff ratio is 1/4, then a low-pass filter (with freqeuncy
* cutoff ratio is 1/4, then a low-pass filter (with frequency
* cutoff equal to 200*1/4 = 50 Hz) is applied before downsampling
* at 200 Hz.
* |OVP_DocEnd_BoxAlgorithm_Downsampling_Examples|
......
......@@ -6,7 +6,7 @@ Detailed description
__________________________________________________________________
* |OVP_DocBegin_BoxAlgorithm_IndependentComponentAnalysisFastICA_Description|
* This plugin is used to decompose into independant components the
* This plugin is used to decompose into independent components the
* input signal. This plugin is based on the Fast ICA algorithm.
* |OVP_DocEnd_BoxAlgorithm_IndependentComponentAnalysisFastICA_Description|
__________________________________________________________________
......
......@@ -42,7 +42,7 @@ namespace OpenViBEPlugins
virtual OpenViBE::CString getAuthorName(void) const { return OpenViBE::CString("G. Gibert - E. Maby - P.E. Aguera"); }
virtual OpenViBE::CString getAuthorCompanyName(void) const { return OpenViBE::CString("INSERM/U821"); }
virtual OpenViBE::CString getShortDescription(void) const { return OpenViBE::CString("Downsamples input signal."); }
virtual OpenViBE::CString getDetailedDescription(void) const { return OpenViBE::CString("Downsamples input signal respect of the new sampling rate choosen by user."); }
virtual OpenViBE::CString getDetailedDescription(void) const { return OpenViBE::CString("Downsamples input signal to the new sampling rate chosen by user."); }
virtual OpenViBE::CString getCategory(void) const { return OpenViBE::CString("Signal processing Gpl/Basic"); }
virtual OpenViBE::CString getVersion(void) const { return OpenViBE::CString("1.1"); }
......
......@@ -697,7 +697,7 @@ boolean CDriverBrainProductsActiCHamp::loop(void)
}
}
// As described in at the begining of this file, the drift
// As described in at the beginning of this file, the drift
// correction process is altered to consider the ~ 50ms delay
// of the single way filtering process
// Inner latency was set accordingly.
......
......@@ -94,7 +94,7 @@ void rda_aux_convert_to_float(UINT32_T N, void *dest, UINT32_T data_type, const
@param blocksize Block size for streaming out samples (0=send out variable blocks depending on incoming data)
@param errval Optional pointer to an integer error value. Will contain either
FT_NO_ERROR, FT_ERR_SOCKET, FT_OUT_OF_MEM or FT_THREADING on exit.
@return Pointer to RDA server control structure, or NULL if an error occured
@return Pointer to RDA server control structure, or NULL if an error occurred
*/
rda_server_ctrl_t *rda_start_server(int ft_buffer, int use16bit, int port, int blocksize, int *errval);
......
......@@ -444,7 +444,7 @@ OpenViBE::boolean CDriverGTecGUSBamp::acquire(void)
//wait for notification from the system telling that new data is available
if (WaitForSingleObject(m_overlapped[deviceIndex][m_ui32CurrentQueueIndex].hEvent, 1000) == WAIT_TIMEOUT)
{
//cout << "Error on data transfer: timeout occured." << "\n";
//cout << "Error on data transfer: timeout occurred." << "\n";
m_flagChunkTimeOutDetected = true;
}
......
......@@ -156,7 +156,7 @@ public:
* When it is set to one (upon first call to this method) the group is actually initialized, but isn't upon
* subsequent calls. It has to be destroyed (its ref count set back to 0) and recreated to be reinitialized.
* \param rResourceGroupIdentifier Resource group identifier
* \return True if resource group could be initialized (or was initialized already), false if an error occured
* \return True if resource group could be initialized (or was initialized already), false if an error occurred
*/
OpenViBE::boolean initializeResourceGroup(
const OpenViBE::CIdentifier& rResourceGroupIdentifier);
......@@ -166,7 +166,7 @@ public:
* \remarks Each call to this method decrements the group's internal reference counter.
* Only when this counter reaches 0 is the group actually destroyed.
* \param rResourceGroupIdentifier Resource group identifier
* \return True if resource group could be destroyed (or was initialized already), false if an error occured
* \return True if resource group could be destroyed (or was initialized already), false if an error occurred
*/
OpenViBE::boolean destroyResourceGroup(
const OpenViBE::CIdentifier& rResourceGroupIdentifier);
......
......@@ -59,7 +59,7 @@ namespace OpenViBE
* When it is set to one (upon first call to this method) the group is actually initialized, but isn't upon
* subsequent calls. It has to be destroyed (its ref count set back to 0) and recreated to be reinitialized.
* \param rResourceGroupIdentifier Resource group identifier
* \return True if resource group could be initialized (or was initialized already), false if an error occured
* \return True if resource group could be initialized (or was initialized already), false if an error occurred
*/
virtual OpenViBE::boolean initializeResourceGroup(
const OpenViBE::CIdentifier& rResourceGroupIdentifier);
......@@ -69,7 +69,7 @@ namespace OpenViBE
* \remarks Each call to this method decrements the group's internal reference counter.
* Only when this counter reaches 0 is the group actually destroyed.
* \param rResourceGroupIdentifier Resource group identifier
* \return True if resource group could be destroyed (or was initialized already), false if an error occured
* \return True if resource group could be destroyed (or was initialized already), false if an error occurred
*/
virtual OpenViBE::boolean destroyResourceGroup(
const OpenViBE::CIdentifier& rResourceGroupIdentifier);
......
......@@ -234,7 +234,7 @@ CIdentifier CAutomatonContext::getVariableIdentifier(const char * pName)
CIdentifier CAutomatonContext::addParameter(const char * pName, Automaton::uint64 ui64Value)
{
//uses the value map's size plus 1 to create the identifier (plus 1 since 0 is used
//to indicate that an error occured)
//to indicate that an error occurred)
CIdentifier l_oCurrentIdentifier(m_oParameterValue.size() + 1);
if(pName)
......
......@@ -119,7 +119,7 @@ namespace
l_ui64Result2_last=l_ui64Result2;
}
// when denominator is 0, consider that elapsed time was not sufficient since the begining
// when denominator is 0, consider that elapsed time was not sufficient since the beginning
if(l_ui64Result2_last==0)
{
return 0;
......
......@@ -149,7 +149,7 @@ namespace OpenViBE
//@{
/**
* \brief Logs a formated time value (64 bits unsigned integer)
* \brief Logs a formatted time value (64 bits unsigned integer)
* \param ui64Value [in] : the value that should be logged
*/
virtual void log(const OpenViBE::time64 time64Value)=0;
......
......@@ -17,7 +17,7 @@ namespace OpenViBE
*
* The log manager is responsible for keeping a trace of all the messages
* the application could send as debug output. Such information is not
* usefull most of the cases but could become crucial in some cases.
* useful most of the cases but could become crucial in some cases.
* Thus there are different levels of activation for the log manager
* to work. The log manager forwards each log request to its registered
* log listeners that effectively do the log the way they want
......
......@@ -23,7 +23,7 @@ namespace OpenViBE
* to override the parameter content directly pointing to another parameter
* or another value. In order to be as generic as possible, this interface
* uses \c void* pointers in conjunction with data size values. It can be
* hard/tricky to understand for unexperienced developers. Thus I recommand
* hard/tricky to understand for unexperienced developers. Thus I recommend
* the use of the TParameterHandler object which dramatically eases the use
* of the IParameter interface.
*/
......
......@@ -103,7 +103,7 @@ namespace OpenViBE
* \return \e true in case of success.
* \return \e false in case of error.
*
* This handler won't be useable until \c initialize is called successfully again.
* This handler won't be usable until \c initialize is called successfully again.
*/
OpenViBE::boolean uninitialize(void)
{
......@@ -134,7 +134,7 @@ namespace OpenViBE
* \return The handled object itself
*
* This cast operator allows the handler to be used as if it was the handled
* object itself. For example, an unsigned integer parameter handler is useable
* object itself. For example, an unsigned integer parameter handler is usable
* in arithmetic operations :
*
* \code
......@@ -159,7 +159,7 @@ namespace OpenViBE
* \return The handled object itself for access operation
*
* This operator allows the handler to be used as if it was the handled
* object itself. For example, a matrix parameter handler is useable
* object itself. For example, a matrix parameter handler is usable
* as if it was a matrix pointer :
*
* \code
......
......@@ -148,7 +148,7 @@ namespace OpenViBE
* When it is set to one (upon first call to this method) the group is actually initialized, but isn't upon
* subsequent calls. It has to be destroyed (its ref count set back to 0) and recreated to be reinitialized.
* \param rResourceGroupIdentifier Resource group identifier
* \return True if resource group could be initialized (or was initialized already), false if an error occured
* \return True if resource group could be initialized (or was initialized already), false if an error occurred
*/
virtual OpenViBE::boolean initializeResourceGroup(
const OpenViBE::CIdentifier& rResourceGroupIdentifier)=0;
......@@ -158,7 +158,7 @@ namespace OpenViBE
* \remark Each call to this method decrements the group's internal reference counter.
* Only when this counter reaches 0 is the group actually destroyed.
* \param rResourceGroupIdentifier Resource group identifier
* \return True if resource group could be destroyed (or was initialized already), false if an error occured
* \return True if resource group could be destroyed (or was initialized already), false if an error occurred
*/
virtual OpenViBE::boolean destroyResourceGroup(
const OpenViBE::CIdentifier& rResourceGroupIdentifier)=0;
......
......@@ -79,7 +79,7 @@ namespace OpenViBE
* When it is set to one (upon first call to this method) the group is actually initialized, but isn't upon
* subsequent calls. It has to be destroyed (its ref count set back to 0) and recreated to be reinitialized.
* \param rResourceGroupIdentifier Resource group identifier
* \return True if resource group could be initialized (or was initialized already), false if an error occured
* \return True if resource group could be initialized (or was initialized already), false if an error occurred
*/
virtual OpenViBE::boolean initializeResourceGroup(
const OpenViBE::CIdentifier& rResourceGroupIdentifier)=0;
......@@ -89,7 +89,7 @@ namespace OpenViBE
* \remark Each call to this method decrements the group's internal reference counter.
* Only when this counter reaches 0 is the group actually destroyed.
* \param rResourceGroupIdentifier Resource group identifier
* \return True if resource group could be destroyed (or was initialized already), false if an error occured
* \return True if resource group could be destroyed (or was initialized already), false if an error occurred
*/
virtual OpenViBE::boolean destroyResourceGroup(
const OpenViBE::CIdentifier& rResourceGroupIdentifier)=0;
......
......@@ -28,7 +28,7 @@ namespace OpenViBE
*
* This class is heavily used in the OpenViBE::IObject class. Also,
* the OpenViBE specification gives serveral already defined
* class identifiers the developper should know of. For this,
* class identifiers the developer should know of. For this,
* let you have a look to the documentation of ov_defines.h !
*
* \sa ov_defines.h
......@@ -92,14 +92,14 @@ namespace OpenViBE
const OpenViBE::CIdentifier& rIdentifier);
/**
* \brief Increments this identifier by 1
* \return this identifer
* \return this identifier
* \note if this identifier is \c OV_UndefinedIdentifier, it is not incremented
* \note if this idenfitier is not \c OV_UndefinedIdentifier, it can not becomre \c OV_UndefinedIdentifier after being incremented
*/
OpenViBE::CIdentifier& operator++(void);
/**
* \brief Decrements this identifier by 1
* \return this identifer
* \return this identifier
* \note if this identifier is \c OV_UndefinedIdentifier, it is not decremented
* \note if this idenfitier is not \c OV_UndefinedIdentifier, it can not becomre \c OV_UndefinedIdentifier after being decremented
*/
......
......@@ -60,7 +60,7 @@ namespace OpenViBE
/**
* \brief ASCII string cast operator
* \return The string formated as standard ASCII string used in C.
* \return The string formatted as standard ASCII string used in C.
*
* The implementation simply calls \c c_str().
*/
......
......@@ -52,7 +52,7 @@ namespace OpenViBE
* the object could finally be casted in this interface or subclass.
* Several interfaces are provided in the OpenViBE specficiation
* but custom class could also be created. It is the responsability
* of the developper to notify the user of what interfaces are
* of the developer to notify the user of what interfaces are
* implemented in a concrete class.
*
* See isDerivedFromClass to have a sample of how this function
......
......@@ -42,7 +42,7 @@ namespace OpenViBE
* \brief Gets the date of a specific stimulation in this stimulation set
* \param ui64StimulationIndex [in] : the index of the stimulation which date has to be returned
* \return the date for the specified stimulation.
* \note the returned date is relative to the begining of this stimulation set
* \note the returned date is relative to the beginning of this stimulation set
* \note dates and durations are returned in seconds fixed point 32:32. Refer to \Doc_TimeManagement for more details
*/
virtual const OpenViBE::uint64 getStimulationDate(
......@@ -90,7 +90,7 @@ namespace OpenViBE
* \param ui64StimulationDuration [in] : the new duration for the specified stimulation
* \return \e true in case of success.
* \return \e false in case of error.
* \note the returned date is relative to the begining of this stimulation set
* \note the returned date is relative to the beginning of this stimulation set
* \note dates and durations are returned in seconds fixed point 32:32. Refer to \Doc_TimeManagement for more details
*/
virtual OpenViBE::boolean setStimulationDuration(
......
......@@ -61,7 +61,7 @@ namespace OpenViBE
* \return \e false in case of error.
*
* When called, this function should get its "input" parameters, do stuffs with them
* and finally produce "ouput" parameters.
* and finally produce "output" parameters.
*/
virtual OpenViBE::boolean process(
OpenViBE::Kernel::IAlgorithmContext& rAlgorithmContext)=0;
......
......@@ -14,7 +14,7 @@ namespace OpenViBE
* \brief Algorithm plugin descriptor
* \ingroup Group_Extend
*
* This class should be derived by any plugin developper in
* This class should be derived by any plugin developer in
* order to describe a specific OpenViBE algorithm.
*
* \sa OpenViBE::Plugins::IAlgorithm
......
......@@ -118,7 +118,7 @@ namespace OpenViBE
* or \e false if it didn't succeed to initialize.
* \note Default implementation simply returns \e true.
*
* After a successfull initialization, the caller knows
* After a successful initialization, the caller knows
* the object can safely be used... On failure, this object
* should be ready to be uninitialized and then released.
*
......
......@@ -22,7 +22,7 @@ namespace OpenViBE
* \brief Box algorithm plugin descriptor
* \ingroup Group_Extend
*
* This class should be derived by any plugin developper in
* This class should be derived by any plugin developer in
* order to describe a specific OpenViBE box algorithm.
*
* \sa OpenViBE::Plugins::IBoxAlgorithm
......
......@@ -41,7 +41,7 @@ namespace OpenViBE
* \brief Informs the plugin object it won't be used anymore
*
* This is called by the OpenViBE platform to inform
* the plugin object it is not usefull anymore. The plugin
* the plugin object it is not useful anymore. The plugin
* can chose whether to delete itself or to stay in
* memory until it decides is is ok to be deleted.
* However, the OpenViBE platform will not call any
......
......@@ -92,7 +92,7 @@ namespace OpenViBE
* \brief Informs the plugin description it won't be used any more
*
* This is called by the OpenViBE platform to inform
* the plugin description it is not usefull anymore.
* the plugin description it is not useful anymore.
* The plugin can chose whether to delete itself or
* to stay in memory until it decides it is ok to be
* deleted. However, the OpenViBE platform will not
......
......@@ -26,7 +26,7 @@ namespace OpenViBE
* or \e false if it didn't succeed to initialize.
* \note Default implementation simply returns \e true.
*
* After a successfull initialization, the caller knows
* After a successful initialization, the caller knows
* the object can safely be used... On failure, this object
* should be ready to be uninitialized and then released.
*
......
......@@ -26,7 +26,7 @@ namespace OpenViBE
* or \e false if it didn't succeed to initialize.
* \note Default implementation simply returns \e true.
*
* After a successfull initialization, the caller knows
* After a successful initialization, the caller knows
* the object can safely be used... On failure, this object
* should be ready to be uninitialized and then released.
*
......
......@@ -28,7 +28,7 @@ __________________________________________________________________
* |OVP_DocEnd_BoxAlgorithm_GenericNetworkAcquisition_Output2|
* |OVP_DocBegin_BoxAlgorithm_GenericNetworkAcquisition_Output3|
* Contains information about the stimulations that occured during the experiment
* Contains information about the stimulations that occurred during the experiment
* |OVP_DocEnd_BoxAlgorithm_GenericNetworkAcquisition_Output3|
__________________________________________________________________
......
......@@ -7,7 +7,7 @@ __________________________________________________________________
* |OVP_DocBegin_BoxAlgorithm_ClassifierProcessor_Description|
The <em>Classifier Processor</em> box is a generic box for classification purpose. It works
in cunjunction with the \ref Doc_BoxAlgorithm_ClassifierTrainer box.
in conjunction with the \ref Doc_BoxAlgorithm_ClassifierTrainer box.
This box' role is to expose a generic interface to the rest of the BCI pipelines. The tasks
specific to a given classifier are forwarded to one of the registered \c OVTK_TypeId_ClassifierAlgorithm
algorithms. The behavior is simple, at initialization phase, the classification algorithm is initialized
......@@ -17,7 +17,7 @@ status and the actual class value and translates this information to its output.
a stimulation and the algorithm status is sent in the form a streamed matrix. The stimulation can be generically
interpreted by the rest of the pipeline but it is important to understand that each classification algorithm is
free to report whatever it wants in its "status matrix". Consequently, the use of this output stream will be
depedendent on the choosen classification algorithm. For example, the LDA classifier sends the hyperplane distance
dependent on the chosen classification algorithm. For example, the LDA classifier sends the hyperplane distance
value as its status.
* |OVP_DocEnd_BoxAlgorithm_ClassifierProcessor_Description|
__________________________________________________________________
......@@ -43,13 +43,13 @@ __________________________________________________________________
* |OVP_DocBegin_BoxAlgorithm_ClassifierProcessor_Output1|
This output will contain the classification stimulations. Each time a new feature vector arrives to this box,
a new classification process is triggered, resuling int the generation of the corresponding class stimulation.
a new classification process is triggered, resulting in the generation of the corresponding class stimulation.
* |OVP_DocEnd_BoxAlgorithm_ClassifierProcessor_Output1|
* |OVP_DocBegin_BoxAlgorithm_ClassifierProcessor_Output2|
This output reflects the classification algorithm status in the form of a matrix of value. The content of this
matrix is dependent of the choosen classification algorithm. For example, the LDA classifier sends the hyperplane
distance as its status. Given that this value is dependent of the choosen algorithm, you should be very carefull
matrix is dependent of the chosen classification algorithm. For example, the LDA classifier sends the hyperplane
distance as its status. Given that this value is dependent of the chosen algorithm, you should be very carefull
with the use of this output stream. Unexepected behavior may (will) occur when changing the classifier.
* |OVP_DocEnd_BoxAlgorithm_ClassifierProcessor_Output2|
__________________________________________________________________
......@@ -71,7 +71,7 @@ This setting points to the configuration file of the algorithm. This configurati
* |OVP_DocEnd_BoxAlgorithm_ClassifierProcessor_Setting2|
* |OVP_DocBegin_BoxAlgorithm_ClassifierProcessor_Setting3|
For classification algorithms that support rejection, you can choose a stimulation that reflects the feature vectore
For classification algorithms that support rejection, you can choose a stimulation that reflects the feature vector
could not be classified.
* |OVP_DocEnd_BoxAlgorithm_ClassifierProcessor_Setting3|