Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes

mitk::NavigationDataDisplacementFilter Class Reference

NavigationDataDisplacementFilter adds an offset to navigation data objects. More...

#include <mitkNavigationDataDisplacementFilter.h>

Inheritance diagram for mitk::NavigationDataDisplacementFilter:
Inheritance graph
[legend]
Collaboration diagram for mitk::NavigationDataDisplacementFilter:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 mitkClassMacro (NavigationDataDisplacementFilter, NavigationDataToNavigationDataFilter)
 mitkSetVectorMacro (Offset, mitk::Vector3D)
 Get Offset parameter.
 mitkGetVectorMacro (Offset, mitk::Vector3D)
 Set Offset parameter.
virtual void SetParameters (const mitk::PropertyList *p)
 Set all filter parameters (Offset) as the PropertyList p.
mitk::PropertyList::ConstPointer GetParameters () const
 Get all filter parameters (offset) as a PropertyList.

Static Public Member Functions

static Pointer New ()

Protected Member Functions

 NavigationDataDisplacementFilter ()
virtual ~NavigationDataDisplacementFilter ()
virtual void GenerateData ()
 filter execute method

Protected Attributes

mitk::Vector3D m_Offset
 offset that is added to all inputs

Detailed Description

NavigationDataDisplacementFilter adds an offset to navigation data objects.

Documentation Example class that shows how to write a navigation filter. This filter adds a offset that can be specified as a parameter to each input navigation data.

Definition at line 34 of file mitkNavigationDataDisplacementFilter.h.


Constructor & Destructor Documentation

mitk::NavigationDataDisplacementFilter::NavigationDataDisplacementFilter (  ) [protected]

Definition at line 22 of file mitkNavigationDataDisplacementFilter.cpp.

References m_Offset.

mitk::NavigationDataDisplacementFilter::~NavigationDataDisplacementFilter (  ) [protected, virtual]

Definition at line 31 of file mitkNavigationDataDisplacementFilter.cpp.

{
}

Member Function Documentation

void mitk::NavigationDataDisplacementFilter::GenerateData (  ) [protected, virtual]

filter execute method

Documentation adds the offset m_Offset to all inputs

Definition at line 36 of file mitkNavigationDataDisplacementFilter.cpp.

References mitk::NavigationData::GetPosition(), mitk::NavigationData::Graft(), mitk::NavigationData::IsDataValid(), mitk::NavigationData::SetDataValid(), and mitk::NavigationData::SetPosition().

{
  /* update outputs with tracking data from tools */
  for (unsigned int i = 0; i < this->GetNumberOfOutputs() ; ++i)
  {
    mitk::NavigationData* output = this->GetOutput(i);
    assert(output);
    const mitk::NavigationData* input = this->GetInput(i);
    assert(input);

    if (input->IsDataValid() == false)
    {
      output->SetDataValid(false);
      continue;
    }
    output->Graft(input); // First, copy all information from input to output
    output->SetPosition(input->GetPosition() + m_Offset);  // Then change the member(s): add offset to position of navigation data
    output->SetDataValid(true); // operation was successful, therefore data of output is valid.
    // don't change anything else here
  }
}
mitk::PropertyList::ConstPointer mitk::NavigationDataDisplacementFilter::GetParameters (  ) const [virtual]

Get all filter parameters (offset) as a PropertyList.

This method returns a PropertyList containing the following properties (name : data type):

  • "NavigationDataDisplacementFilter_Offset" : mitk::Vector3DProperty The returned PropertyList must be assigned to a SmartPointer immediately, or else it will get destroyed.

Reimplemented from mitk::NavigationDataSource.

Definition at line 69 of file mitkNavigationDataDisplacementFilter.cpp.

References mitk::Vector3DProperty::New(), and mitk::PropertyList::New().

{
  mitk::PropertyList::Pointer p = mitk::PropertyList::New();
  p->SetProperty("NavigationDataDisplacementFilter_Offset", mitk::Vector3DProperty::New(this->GetOffset()));  // store Offset parameter
  return mitk::PropertyList::ConstPointer(p);
}
mitk::NavigationDataDisplacementFilter::mitkClassMacro ( NavigationDataDisplacementFilter  ,
NavigationDataToNavigationDataFilter   
)
mitk::NavigationDataDisplacementFilter::mitkGetVectorMacro ( Offset  ,
mitk::Vector3D   
)

Set Offset parameter.

mitk::NavigationDataDisplacementFilter::mitkSetVectorMacro ( Offset  ,
mitk::Vector3D   
)

Get Offset parameter.

static Pointer mitk::NavigationDataDisplacementFilter::New (  ) [static]
void mitk::NavigationDataDisplacementFilter::SetParameters ( const mitk::PropertyList p ) [virtual]

Set all filter parameters (Offset) as the PropertyList p.

This method reads the following properties from the PropertyList (name : data type):

Reimplemented from mitk::NavigationDataSource.

Definition at line 59 of file mitkNavigationDataDisplacementFilter.cpp.

References mitk::PropertyList::GetPropertyValue().

{
  if (p == NULL)
    return;
  mitk::Vector3D v;
  if (p->GetPropertyValue<mitk::Vector3D>("NavigationDataDisplacementFilter_Offset", v) == true)  // search for Offset parameter
    this->SetOffset(v);   // apply if found;
}

Member Data Documentation

offset that is added to all inputs

Definition at line 73 of file mitkNavigationDataDisplacementFilter.h.

Referenced by NavigationDataDisplacementFilter().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines