usTransducerSettings.cpp

/****************************************************************************
 *
 * This file is part of the ustk software.
 * Copyright (C) 2016 - 2017 by Inria. All rights reserved.
 *
 * This software is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * ("GPL") version 2 as published by the Free Software Foundation.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ustk with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at ustk@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Authors:
 * Pierre Chatelain
 * Marc Pouliquen
 *
 *****************************************************************************/
 
// std includes
#include <iostream>
 
// visp includes
#include <visp3/ustk_core/usTransducerSettings.h>
 
// ustk includes
 
usTransducerSettings::usTransducerSettings()
  : m_transducerRadius(0.0f), m_scanLinePitch(0.0f), m_scanLineNumber(0), m_isTransducerConvex(true),
    m_scanLineNumberIsSet(false), m_transmitFrequency(0), m_samplingFrequency(0)
{
}
 
usTransducerSettings::usTransducerSettings(double transducerRadius, double scanLinePitch, unsigned int scanLineNumber,
                                           bool transducerConvex, double depth, int transmitFrequency,
                                           int samplingFrequency)
  : m_transducerRadius(transducerRadius), m_scanLinePitch(scanLinePitch), m_scanLineNumber(scanLineNumber),
    m_isTransducerConvex(transducerConvex), m_depth(depth), m_scanLineNumberIsSet(true),
    m_transmitFrequency(transmitFrequency), m_samplingFrequency(samplingFrequency)
{
}
 
usTransducerSettings::usTransducerSettings(const usTransducerSettings &other) { *this = other; }
 
usTransducerSettings::~usTransducerSettings() {}
 
usTransducerSettings &usTransducerSettings::operator=(const usTransducerSettings &other)
{
  m_transducerRadius = other.getTransducerRadius();
  m_scanLinePitch = other.getScanLinePitch();
  m_scanLineNumber = other.getScanLineNumber();
  m_isTransducerConvex = other.isTransducerConvex();
  m_scanLineNumberIsSet = other.scanLineNumberIsSet();
  m_depth = other.getDepth();
  m_samplingFrequency = other.getSamplingFrequency();
  m_transmitFrequency = other.getTransmitFrequency();
 
  return *this;
}
 
bool usTransducerSettings::operator==(usTransducerSettings const &other)
{
  return (this->getTransducerRadius() == other.getTransducerRadius() &&
          this->getScanLinePitch() == other.getScanLinePitch() &&
          this->getScanLineNumber() == other.getScanLineNumber() &&
          this->isTransducerConvex() == other.isTransducerConvex() &&
          this->getSamplingFrequency() == other.getSamplingFrequency() &&
          this->getTransmitFrequency() == other.getTransmitFrequency());
}
 
bool usTransducerSettings::operator!=(usTransducerSettings const &other) { return !operator==(other); }
 
VISP_EXPORT std::ostream &operator<<(std::ostream &out, const usTransducerSettings &other)
{
  out << "transducer radius: " << other.getTransducerRadius() << std::endl;
  if (other.isTransducerConvex())
    out << "scan line pitch angle: " << other.getScanLinePitch() << std::endl;
  else
    out << "scan line pitch distance: " << other.getScanLinePitch() << std::endl;
  out << "scan line number : " << other.getScanLineNumber() << std::endl
      << "convex probe used: " << other.isTransducerConvex() << std::endl
      << "depth : " << other.getDepth() << std::endl
      << "sampling frequency " << other.getSamplingFrequency() << std::endl
      << "transmit frequency " << other.getTransmitFrequency() << std::endl;
  return out;
}
 
// Image settings getters/setters
 
void usTransducerSettings::setTransducerRadius(const double transducerRadius) { m_transducerRadius = transducerRadius; }
 
double usTransducerSettings::getTransducerRadius() const { return m_transducerRadius; }
 
void usTransducerSettings::setScanLinePitch(const double scanLinePitch) { m_scanLinePitch = scanLinePitch; }
 
double usTransducerSettings::getScanLinePitch() const { return m_scanLinePitch; }
 
void usTransducerSettings::setTransducerConvexity(const bool isTransducerConvex)
{
  m_isTransducerConvex = isTransducerConvex;
  if (!isTransducerConvex) {
    m_transducerRadius = 0.0;
  }
}
 
bool usTransducerSettings::isTransducerConvex() const { return m_isTransducerConvex; }
 
void usTransducerSettings::setTransducerSettings(const usTransducerSettings &other) { *this = other; }
 
unsigned int usTransducerSettings::getScanLineNumber() const { return m_scanLineNumber; }
 
void usTransducerSettings::setScanLineNumber(unsigned int scanLineNumber)
{
  m_scanLineNumberIsSet = true;
  m_scanLineNumber = scanLineNumber;
}
 
std::string usTransducerSettings::getProbeName() const { return m_probeName; }
 
void usTransducerSettings::setProbeName(std::string probeName) { m_probeName = probeName; }
 
double usTransducerSettings::getFieldOfView() const
{
  if (!m_scanLineNumberIsSet)
    throw vpException(vpException::notInitialized,
                      "The scan line number is not set, cannot determine the field of view");
  return m_scanLinePitch * (double)(m_scanLineNumber - 1);
}
 
void usTransducerSettings::setFieldOfView(double fieldOfView)
{
  if (!m_scanLineNumberIsSet)
    throw vpException(vpException::notInitialized,
                      "The scan line number is not set, cannot determine the pitch from the field of view");
  m_scanLinePitch = fieldOfView / (double)(m_scanLineNumber - 1);
}
 
bool usTransducerSettings::scanLineNumberIsSet() const { return m_scanLineNumberIsSet; }
 
void usTransducerSettings::setDepth(double depth) { m_depth = depth; }
 
double usTransducerSettings::getDepth() const { return m_depth; }
 
usTransducerSettings usTransducerSettings::getTransducerSettings() const
{
  usTransducerSettings ret = *this;
  return ret;
}
 
int usTransducerSettings::getSamplingFrequency() const { return m_samplingFrequency; }
 
int usTransducerSettings::getTransmitFrequency() const { return m_transmitFrequency; }
 
void usTransducerSettings::setSamplingFrequency(const int samplingFrequency)
{
  m_samplingFrequency = samplingFrequency;
}
 
void usTransducerSettings::setTransmitFrequency(const int transmitFrequency)
{
  m_transmitFrequency = transmitFrequency;
}