PlusSpatialModel.h

Go to the documentation of this file.

/*=Plus=header=begin======================================================
  Program: Plus
  Copyright (c) Laboratory for Percutaneous Surgery. All rights reserved.
  See License.txt for details.
=========================================================Plus=header=end*/
#ifndef __SpatialModel_h
#define __SpatialModel_h

#include <deque>
#include <string>

#include "vtkPlusUsSimulatorExport.h"

class vtkMatrix4x4;
class vtkModifiedBSPTree;
class vtkPolyData;

class vtkPlusUsSimulatorExport PlusSpatialModel
{
public:
  struct LineIntersectionInfo
  {
    LineIntersectionInfo()
    {
      Model = NULL;
      IntersectionDistanceFromStartPointMm = 0;
      IntersectionIncidenceAngleRad = 0;
    }
    PlusSpatialModel* Model;
    // Distance between the line starting point and the intersection point, in mm
    double IntersectionDistanceFromStartPointMm;
    // Angle between the intersecting line and the surface normal (0 if the line is parallel to the surface normal)
    double IntersectionIncidenceAngleRad;
  };

  PlusSpatialModel();
  virtual ~PlusSpatialModel();

  PlusSpatialModel(const PlusSpatialModel& model);
  void operator=(const PlusSpatialModel& model);

  virtual PlusStatus ReadConfiguration(vtkXMLDataElement* spatialModelElement);

  void SetModelFile(const std::string& modelFile);

  SetMacro(ImagingFrequencyMhz, double);

  GetStdStringMacro(Name);
  SetStdStringMacro(Name);

  GetStdStringMacro(ObjectCoordinateFrame);
  SetStdStringMacro(ObjectCoordinateFrame);

  vtkMatrix4x4* GetModelToObjectTransform();

  void SetReferenceToObjectTransform(vtkMatrix4x4* referenceToObjectTransform);

  void GetLineIntersections(std::deque<LineIntersectionInfo>& lineIntersections, double* scanLineStartPoint_Reference, double* scanLineEndPoint_Reference);

  double GetAcousticImpedanceMegarayls();

  void CalculateIntensity(std::vector<double>& reflectedIntensity, unsigned int numberOfFilledPixels, double distanceBetweenScanlineSamplePointsMm,
                          double previousModelAcousticImpedanceMegarayls, double incidentIntensity, double& transmittedIntensity, double incidenceAngleRad);

  SetMacro(DensityKgPerM3, double);
  SetMacro(SoundVelocityMPerSec, double);
  SetMacro(AttenuationCoefficientDbPerCmMhz, double);
  SetMacro(SurfaceReflectionIntensityDecayDbPerMm, double);
  SetMacro(BackscatterDiffuseReflectionCoefficient, double);
  SetMacro(SurfaceDiffuseReflectionCoefficient, double);
  SetMacro(SurfaceSpecularReflectionCoefficient, double);
  SetMacro(TransducerSpatialModelMaxOverlapMm, double);

protected:
  void SetPolyData(vtkPolyData* polyData);
  void SetModelLocalizer(vtkModifiedBSPTree* modelLocalizer);
  void SetModelToObjectTransform(vtkMatrix4x4* modelToObjectTransform);
  void SetModelToObjectTransform(double* matrixElements);

  PlusStatus UpdateModelFile();
  void UpdatePrecomputedAttenuations(double intensityTransmittedFractionPerPixelTwoWay, int numberOfElements);

protected:
  //PlusStatus LoadModel(const std::string& absoluteImagePath);

  std::string Name;

  std::string ModelFile;

  bool ModelFileNeedsUpdate;

  vtkMatrix4x4* ModelToObjectTransform;

  vtkMatrix4x4* ReferenceToObjectTransform;

  std::string ObjectCoordinateFrame;

  //TODO: /*! ModelToReferenceTransform */ ... is not read in previously, probably not needed, keep an eye on it

  double ImagingFrequencyMhz;

  double DensityKgPerM3;

  double SoundVelocityMPerSec;

  double AttenuationCoefficientDbPerCmMhz;

  double SurfaceReflectionIntensityDecayDbPerMm;

  double BackscatterDiffuseReflectionCoefficient;

  double TransducerSpatialModelMaxOverlapMm;

  double SurfaceSpecularReflectionCoefficient;

  double SurfaceDiffuseReflectionCoefficient;

  vtkModifiedBSPTree* ModelLocalizer;

  vtkPolyData* PolyData;

  std::vector<double> PrecomputedAttenuations;
};

#endif