mitkNavigationDataCSVSequentialPlayer.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
 
#ifndef mitkNavigationDataCSVSequentialPlayer_h
#define mitkNavigationDataCSVSequentialPlayer_h
 
#include <mitkNavigationDataPlayerBase.h>
 
namespace mitk
{
 
  class NavigationDataCSVSequentialPlayer
    : public NavigationDataPlayerBase
  {
  public:
 
    mitkClassMacro(NavigationDataCSVSequentialPlayer, NavigationDataPlayerBase);
    itkNewMacro(Self);
 
    void SetFileName(const std::string& _FileName);
 
    void SetOptions(bool rightHanded, char seperatorSign, int sampleCount, bool headerRow, int xPos, int yPos, int zPos, bool useQuats,
                    int qx, int qy, int qz, int qr, int azimuth, int elevatino, int roll, bool eulerInRadiants, int minNumberOfColums);
 
    itkGetStringMacro(FileName);
 
    enum Filetype
    {
      NavigationDataCSV, //for csv files from the MITK navigation data player
      ManualLoggingCSV //for custom csv files
    };
    itkSetMacro(Filetype, Filetype);
 
    bool IsAtEnd();
 
    void UpdateOutputInformation() override;
 
    int GetNumberOfSnapshots();
 
  protected:
    NavigationDataCSVSequentialPlayer();
    ~NavigationDataCSVSequentialPlayer() override;
 
    void GenerateData() override;
 
    std::string m_FileName;
 
    int m_CurrentPos;
    Filetype m_Filetype;
 
    //member for the navigation datas which were read (only one output is supported at the moment)
    std::vector<mitk::NavigationData::Pointer> m_NavigationDatas;
 
    std::vector<mitk::NavigationData::Pointer> GetNavigationDatasFromFile(std::string filename);
    std::vector<std::string> GetFileContentLineByLine(std::string filename);
    mitk::NavigationData::Pointer GetNavigationDataOutOfOneLine(std::string line);
 
    void FillOutputEmpty(int number);
    mitk::NavigationData::Pointer GetEmptyNavigationData();
 
    bool m_RightHanded; //true if the used coordinate System is right handed, false if it is left handed
    char m_SeparatorSign; //symbol that is used to separate the values in the .csv file
    int m_SampleCount; //every n-th sample in the file that should be used
    bool m_HeaderRow; //true if the .csv file has a header row otherwise false
    int m_XPos; //number of the column in the .csv file for the x-coordinates of the position
    int m_YPos; //number of the column in the .csv file for the y-coordinates of the position
    int m_ZPos; //number of the column in the .csv file for the z-coordinates of the position
    bool m_UseQuats; //true if Quaternions are used to construct the orientation, false if Euler Angles are used
    int m_Qx; //number of the column in the .csv file for the x component of the quaternion
    int m_Qy; //number of the column in the .csv file for the y component of the quaternion
    int m_Qz; //number of the column in the .csv file for the z component of the quaternion
    int m_Qr; //number of the column in the .csv file for the r component of the quaternion
    int m_Azimuth; //number of the column in the .csv file for Azimuth (Euler Angles)
    int m_Elevation; //number of the column in the .csv file for Elevation (Euler Angles)
    int m_Roll; //number of the column in the .csv file for Roll (Euler Angles)
    bool m_EulersInRadiants; // true if the Euler Angles in the .csv file are in radiants, false if they are in degrees
    int m_MinNumberOfColumns; //minimal number of columns the file has to have (e.g. if you read data from column 8 the file has to have at least 8 columns)
  };
} // namespace mitk
 
#endif