mitkUSProbe.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 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);

    typedef struct USProbeCropping_
    {
      unsigned int top;
      unsigned int bottom;
      unsigned int left;
      unsigned int right;

      USProbeCropping_()
        : top(0), bottom(0), left(0), right(0) { };

      USProbeCropping_(unsigned int top, unsigned int bottom, unsigned int left, unsigned int right)
        : top(top), bottom(bottom), left(left), right(right) { };
    }USProbeCropping;

    void SetProbeCropping(unsigned int top, unsigned int bottom, unsigned int left, unsigned int right);
    USProbeCropping GetProbeCropping();

    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);

    bool IsDepthAndSpacingEmpty();

    //## getter and setter ##

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

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

    std::string m_Name;
    double m_CurrentDepth;

    // 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;

    USProbeCropping m_Cropping;
  };
} // namespace mitk
#endif