btk::AnalogOffsetRemover Class Reference

Remove a possible analog offset to the selected analog channels. More...

#include <btkAnalogOffsetRemover.h>

Inheritance diagram for btk::AnalogOffsetRemover:

Public Types
typedef btkSharedPtr< const AnalogOffsetRemover >	ConstPointer
typedef btkSharedPtr < AnalogOffsetRemover >	Pointer
Public Types inherited from btk::ProcessObject
typedef btkSharedPtr< const ProcessObject >	ConstPointer
typedef btkSharedPtr < ProcessObject >	Pointer
Public Types inherited from btk::Object
typedef btkSharedPtr< const Object >	ConstPointer
typedef btkSharedPtr< Object >	Pointer

Public Member Functions
Acquisition::Pointer	GetOffsetInput ()
Acquisition::Pointer	GetOutput ()
Acquisition::Pointer	GetRawInput ()
void	SetOffsetInput (Acquisition::Pointer input)
void	SetRawInput (Acquisition::Pointer input)
Public Member Functions inherited from btk::ProcessObject
int	GetInputNumber () const
int	GetOutputNumber () const
int	GetValidInputNumber () const
void	ResetState ()
void	Update ()
Public Member Functions inherited from btk::Object
unsigned long int	GetTimestamp () const

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	AnalogOffsetRemover ()
virtual void	GenerateData ()
Acquisition::Pointer	GetInput (int idx)
Acquisition::Pointer	GetOutput (int idx)
virtual DataObject::Pointer	MakeOutput (int idx)
Protected Member Functions inherited from btk::ProcessObject
int	GetInputIndex (DataObject::Pointer input)
DataObject::Pointer	GetNthInput (int idx)
DataObject::ConstPointer	GetNthInput (int idx) const
DataObject::Pointer	GetNthOutput (int idx)
DataObject::ConstPointer	GetNthOutput (int idx) const
int	GetOutputIndex (DataObject::Pointer output)
bool	IsModified () const
void	Modified ()
	ProcessObject ()
void	SetInputNumber (int num)
virtual void	SetNthInput (int idx, DataObject::Pointer input)
virtual void	SetNthOutput (int idx, DataObject::Pointer output)
void	SetOutputNumber (int num)
virtual	~ProcessObject ()
Protected Member Functions inherited from btk::Object
	Object ()
	Object (const Object &toCopy)
virtual	~Object ()

Additional Inherited Members
Protected Attributes inherited from btk::Object
unsigned long int	m_Timestamp

Detailed Description

Remove a possible analog offset to the selected analog channels.

Based on the given offset input (see the method SetOffsetInput()), each analog signals are averaged and removed from the raw input (see the method SetRawInput()). The analog signals set in the raw input which are not given to the offset input are not processed but will be available in the output.

Member Typedef Documentation

btk::AnalogOffsetRemover::ConstPointer

Smart pointer associated with a const AnalogOffsetRemover object.

btk::AnalogOffsetRemover::Pointer

Smart pointer associated with a AnalogOffsetRemover object.

Constructor & Destructor Documentation

btk::AnalogOffsetRemover::AnalogOffsetRemover ( )

protected

Constructor. Sets the number of inputs to 2 (raw and offset acquisition) and outputs to 1.

Member Function Documentation

void btk::AnalogOffsetRemover::GenerateData ( )

protectedvirtual

Generates the outputs' data.

Implements btk::ProcessObject.

Acquisition::Pointer btk::AnalogOffsetRemover::GetInput ( int  idx )

inlineprotected

Returns the input at the index idx.

Acquisition::Pointer btk::AnalogOffsetRemover::GetOffsetInput ( )

inline

Gets the input registered with this process which corresponds to the offsets to remove.

PointCollection::Pointer btk::AnalogOffsetRemover::GetOutput ( )

inline

Gets the output created with this process.

Acquisition::Pointer btk::AnalogOffsetRemover::GetOutput ( int  idx )

inlineprotected

Returns the output at the index idx.

Acquisition::Pointer btk::AnalogOffsetRemover::GetRawInput ( )

inline

Gets the input registered with this process which is used as the input to process.

DataObject::Pointer btk::AnalogOffsetRemover::MakeOutput ( int  idx )

protectedvirtual

Creates an Acquisition:Pointer object and return it as a DataObject::Pointer.

Implements btk::ProcessObject.

static Pointer btk::AnalogOffsetRemover::New ( )

inlinestatic

Creates a smart pointer associated with a AnalogOffsetRemover object.

void btk::AnalogOffsetRemover::SetOffsetInput ( Acquisition::Pointer  input )

inline

Sets the input required with this process which corresponds to the offsets to remove.

void btk::AnalogOffsetRemover::SetRawInput ( Acquisition::Pointer  input )

inline

Sets the input required with this process which is used as the input to process.