mitkUSProbe.h

Go to the documentation of this file.

/*===================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.

This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.

See LICENSE.txt or http://www.mitk.org for details.

===================================================================*/

#ifndef MITKUSProbe_H_HEADER_INCLUDED_
#define MITKUSProbe_H_HEADER_INCLUDED_

#include <MitkUSExports.h>
#include <mitkCommon.h>
#include <itkObject.h>
#include <itkObjectFactory.h>
#include <mitkVector.h>

namespace mitk {
  //Be sure to check the isEqualTo() method if you expand this class to see if it needs work!
  class MITKUS_EXPORT USProbe : public itk::Object
  {
  public:
    mitkClassMacroItkParent(USProbe, itk::Object);
    itkFactorylessNewMacro(Self)
      itkCloneMacro(Self)
      mitkNewMacro1Param(Self, std::string);

    bool IsEqualToProbe(mitk::USProbe::Pointer probe);

    void SetDepthAndSpacing(int depth, Vector3D spacing);

    std::map<int, Vector3D> GetDepthsAndSpacing();

    void SetDepth(int depth);

    void RemoveDepth(int depthToRemove);

    void SetSpacingForGivenDepth(int givenDepth, Vector3D spacing);

    Vector3D GetSpacingForGivenDepth(int givenDepth);

    //## getter and setter ##

    itkGetMacro(Name, std::string);
    itkSetMacro(Name, std::string);

  protected:
    USProbe();
    USProbe(std::string identifier);
    virtual ~USProbe();

    std::string m_Name;

    // Map containing the depths and the associated spacings as an std::vector with depth as key and spacing as value
    std::map<int, Vector3D> m_DepthsAndSpacings;
  };
} // namespace mitk
#endif