usImagePreScan3D.h

/****************************************************************************
 *
 * 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
 *
 *****************************************************************************/
 
#ifndef __usImagePreScan3D_h_
#define __usImagePreScan3D_h_
 
#include <visp3/ustk_core/usImage3D.h>
#include <visp3/ustk_core/usImagePreScan2D.h>
 
#include <visp3/ustk_core/usImagePreScanSettings.h>
 
#include <visp3/ustk_core/usMotorSettings.h>
 
template <class Type>
class usImagePreScan3D : public usImage3D<Type>, public usImagePreScanSettings, public usMotorSettings
{
public:
  // default constructors
  usImagePreScan3D();
  // All parameters initialisation constructors
  usImagePreScan3D(const usImage3D<Type> &image, const usImagePreScanSettings &preScanSettings,
                   const usMotorSettings &motorSettings);
  // usImagePreScan3D copy constructor
  usImagePreScan3D(const usImagePreScan3D &other);
 
  // destructor
  virtual ~usImagePreScan3D();
 
  unsigned int getBModeSampleNumber() const;
 
  void getFrame(usImagePreScan2D<Type> &image, unsigned int index);
 
  void insertFrame(const usImagePreScan2D<Type> &frame, unsigned int index);
 
  // assignement
  usImagePreScan3D<Type> &operator=(const usImagePreScan3D<Type> &other);
  // comparison
  bool operator==(const usImagePreScan3D<Type> &other);
 
  void setData(const usImage3D<Type> &image);
  void setFrameNumber(unsigned int frameNumber);
  void setScanLineNumber(unsigned int scanLineNumber);
 
  // Filtering before calling vpImage::resize() to update scanLineNumber
  void resize(unsigned int height, unsigned int width, unsigned int numberOfFrames);
};
 
template <class Type>
usImagePreScan3D<Type>::usImagePreScan3D() : usImage3D<Type>(), usImagePreScanSettings(), usMotorSettings()
{
}
 
template <class Type>
usImagePreScan3D<Type>::usImagePreScan3D(const usImage3D<Type> &image, const usImagePreScanSettings &preScanSettings,
                                         const usMotorSettings &motorSettings)
  : usImage3D<Type>(image), usImagePreScanSettings(preScanSettings), usMotorSettings(motorSettings)
{
  if (image.getWidth() != preScanSettings.getScanLineNumber())
    throw(vpException(vpException::badValue, "3D pre-scan image X-size differ from transducer scan line number"));
  if (image.getNumberOfFrames() != motorSettings.getFrameNumber())
    throw(vpException(vpException::badValue, "3D pre-scan image Z-size differ from motor frame number"));
}
 
template <class Type>
usImagePreScan3D<Type>::usImagePreScan3D(const usImagePreScan3D &other)
  : usImage3D<Type>(other), usImagePreScanSettings(other), usMotorSettings(other)
{
}
 
template <class Type> usImagePreScan3D<Type>::~usImagePreScan3D() {}
 
template <class Type> usImagePreScan3D<Type> &usImagePreScan3D<Type>::operator=(const usImagePreScan3D<Type> &other)
{
  // from vpImage
  usImage3D<Type>::operator=(other);
 
  // from usImageSettings
  usImagePreScanSettings::operator=(other);
 
  // for motor settings
  usMotorSettings::operator=(other);
 
  return *this;
}
 
template <class Type> bool usImagePreScan3D<Type>::operator==(const usImagePreScan3D<Type> &other)
{
  return (usImage3D<Type>::operator==(other) && usImagePreScanSettings::operator==(other) &&
          usMotorSettings::operator==(other));
}
 
template <class Type> std::ostream &operator<<(std::ostream &out, const usImagePreScan3D<Type> &other)
{
  return out << static_cast<const usImage3D<Type> &>(other) << static_cast<const usImagePreScanSettings &>(other)
             << static_cast<const usMotorSettings &>(other);
}
 
template <class Type> unsigned int usImagePreScan3D<Type>::getBModeSampleNumber() const
{
  return usImage3D<Type>::getHeight();
}
 
template <class Type> void usImagePreScan3D<Type>::setData(const usImage3D<Type> &image)
{
  usImage3D<Type>::operator=(image);
  setScanLineNumber(image.getWidth());
  setFrameNumber(image.getNumberOfFrames());
}
 
template <class Type> void usImagePreScan3D<Type>::setScanLineNumber(unsigned int scanLineNumber)
{
  usImage3D<Type>::resize(usImage3D<Type>::getHeight(), scanLineNumber, usImage3D<Type>::getNumberOfFrames());
  usTransducerSettings::setScanLineNumber(scanLineNumber);
}
 
template <class Type> void usImagePreScan3D<Type>::setFrameNumber(unsigned int frameNumber)
{
  usImage3D<Type>::resize(usImage3D<Type>::getHeight(), usImage3D<Type>::getWidth(), frameNumber);
  usMotorSettings::setFrameNumber(frameNumber);
}
 
template <class Type>
void usImagePreScan3D<Type>::resize(unsigned int height, unsigned int width, unsigned int numberOfFrames)
{
  usImage3D<Type>::resize(height, width, numberOfFrames);
  usMotorSettings::setFrameNumber(numberOfFrames);
  usTransducerSettings::setScanLineNumber(width);
}
 
template <class Type> void usImagePreScan3D<Type>::insertFrame(const usImagePreScan2D<Type> &frame, unsigned int index)
{
  // Dimentions checks
  if (index > this->getNumberOfFrames())
    throw(vpException(vpException::badValue, "usImage3D::insertFrame : frame index out of volume"));
 
  if (frame.getHeight() != this->getHeight() || frame.getWidth() != this->getWidth())
    throw(vpException(vpException::badValue, "usImage3D::insertFrame : frame size don't match volume size"));
 
  // offset to access the frame in the volume
  int offset = index * this->getHeight() * this->getWidth();
  Type *frameBeginning = this->getData() + offset;
 
  // copy
  for (unsigned int i = 0; i < this->getWidth(); i++) {
    for (unsigned int j = 0; j < this->getHeight(); j++) {
      frameBeginning[i + this->getWidth() * j] = frame[j][i];
    }
  }
}
 
template <class Type> void usImagePreScan3D<Type>::getFrame(usImagePreScan2D<Type> &image, unsigned int index)
{
 
  // Dimentions checks
  if (index > this->getNumberOfFrames() - 1)
    throw(vpException(vpException::badValue, "usImage3D::getFrame : frame index out of volume"));
 
  image.resize(this->getHeight(), this->getWidth());
 
  // offset to access the frame in the volume
  int offset = index * this->getHeight() * this->getWidth();
  const Type *frameBeginning = this->getConstData() + offset;
 
  // copy
  for (unsigned int i = 0; i < this->getWidth(); i++) {
    for (unsigned int j = 0; j < this->getHeight(); j++) {
      image[j][i] = frameBeginning[i + this->getWidth() * j];
    }
  }
}
 
#endif // __usImagePreScan3D_h_