AwCore
AnyWave core library
Public Member Functions | List of all members
AwSensor Class Reference

AwSensor describes physical properties for a sensor. More...

Public Member Functions

 AwSensor (int type)
 
 AwSensor (AwSensor *s)
 
 AwSensor (AwChannel *channel)
 
int type ()
 
const QString & label ()
 
double * coordinates ()
 
double * orientation ()
 
float value ()
 
bool isBad ()
 
bool isAlwaysBad ()
 
void setType (int type)
 
void setLabel (const QString &label)
 
void setCoordinates (double x, double y, double z)
 
void setCoordinates (double *point)
 
void setOrientation (double ox, double oy, double oz)
 
void setOrientation (double *orientation)
 
void setValue (float value)
 
void setBad (bool bad=true)
 

Detailed Description

AwSensor describes physical properties for a sensor.

A sensor may have 3D coordiates (x, y, z) and an orientation (ox, oy, oz). A sensors has a label and a type (MEG, EEG) principally

Remarks
This object may be usefull to create 3D ou 2D mapping of activities.
See also
AwSensorList

Constructor & Destructor Documentation

AwSensor::AwSensor ( int  type)

Instantiate a sensor based on a channel type.

AwSensor::AwSensor ( AwSensor s)

Copy constructor

AwSensor::AwSensor ( AwChannel channel)

Instantiate a sensor from a AwChannel object

Member Function Documentation

double* AwSensor::coordinates ( )
inline

Returns 3D coordinates as a pointer to an array of double.

bool AwSensor::isAlwaysBad ( )
inline

Returns trus if the sensor is marked as always bad. Always bad sensors are sensors that will stay marked as bad forever.

bool AwSensor::isBad ( )
inline

Returns true if the sensor is marked as bad.

const QString& AwSensor::label ( )
inline

Returns the sensor's label

double* AwSensor::orientation ( )
inline

Returns 3D orientation coordinates as a pointer to an array of double.

void AwSensor::setBad ( bool  bad = true)
inline

Sets the marker as bad.

void AwSensor::setCoordinates ( double  x,
double  y,
double  z 
)

Sets the 3D coordinates

void AwSensor::setCoordinates ( double *  point)

Sets the 3D coordinates using an array of double

void AwSensor::setLabel ( const QString &  label)
inline

Sets the sensor's label

void AwSensor::setOrientation ( double  ox,
double  oy,
double  oz 
)

Sets the 3D coordinates of the orientation vector.

void AwSensor::setOrientation ( double *  orientation)

Sets the 3D coordinates of the orientation vector using an array of double.

void AwSensor::setType ( int  type)
inline

Sets the sensor's type

void AwSensor::setValue ( float  value)
inline

Sets the scalar value

int AwSensor::type ( )
inline

Returns the type of sensor (AwChannel::EEG or AwChannel::MEG)

float AwSensor::value ( )
inline

Returns the scalar value set for the sensor. Used when computing mapping of activies.


The documentation for this class was generated from the following files: