usImagePreScan2D.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
 *
 *****************************************************************************/
 
#ifndef __usImagePreScan2D_h_
#define __usImagePreScan2D_h_
 
#include <visp3/core/vpImage.h>
 
#include <visp3/ustk_core/usImagePreScanSettings.h>
 
template <class Type> class usImagePreScan2D : public vpImage<Type>, public usImagePreScanSettings
{
public:
  // default constructors
  usImagePreScan2D();
  // sized constructor
  usImagePreScan2D(unsigned int height, unsigned int width);
  // All parameters initialisation constructors
  usImagePreScan2D(const vpImage<Type> &image, const usImagePreScanSettings &preScanSettings);
  // usImagePreScan2D copy constructor
  usImagePreScan2D(const usImagePreScan2D &other);
 
  // destructor
  virtual ~usImagePreScan2D();
 
  // Those parameters have to be passed in the constructor.
  unsigned int getBModeSampleNumber() const;
 
  // assignement
  usImagePreScan2D<Type> &operator=(const usImagePreScan2D<Type> &other);
 
  // comparison
  bool operator==(const usImagePreScan2D<Type> &other);
  bool operator!=(const usImagePreScan2D<Type> &other);
 
  void setData(const vpImage<Type> image);
  void setScanLineNumber(unsigned int scanLineNumber);
 
  // Filtering before calling vpImage::resize() to update scanLineNumber
  void resize(const unsigned int h, const unsigned int w);
  void resize(const unsigned int h, const unsigned int w, const Type val);
};
 
template <class Type> usImagePreScan2D<Type>::usImagePreScan2D() : vpImage<Type>(), usImagePreScanSettings() {}
 
template <class Type>
usImagePreScan2D<Type>::usImagePreScan2D(const usImagePreScan2D &other)
  : vpImage<Type>(other), usImagePreScanSettings(other)
{
}
 
template <class Type>
usImagePreScan2D<Type>::usImagePreScan2D(unsigned int height, unsigned int width)
  : vpImage<Type>(height, width), usImagePreScanSettings()
{
  usTransducerSettings::setScanLineNumber(width);
}
 
template <class Type>
usImagePreScan2D<Type>::usImagePreScan2D(const vpImage<Type> &image, const usImagePreScanSettings &preScanSettings)
  : vpImage<Type>(image), usImagePreScanSettings(preScanSettings)
{
  if (image.getWidth() != preScanSettings.getScanLineNumber())
    throw(vpException(vpException::badValue, "Pre-scan image width differ from transducer scanline number"));
}
 
template <class Type> usImagePreScan2D<Type>::~usImagePreScan2D() {}
 
template <class Type> usImagePreScan2D<Type> &usImagePreScan2D<Type>::operator=(const usImagePreScan2D<Type> &other)
{
  // from vpImage
  vpImage<Type>::operator=(other);
 
  // from usImagePreScanSettings
  usImagePreScanSettings::operator=(other);
 
  return *this;
}
 
template <class Type> bool usImagePreScan2D<Type>::operator==(const usImagePreScan2D<Type> &other)
{
  return (vpImage<Type>::operator==(other) && usImagePreScanSettings::operator==(other));
}
 
template <class Type> bool usImagePreScan2D<Type>::operator!=(const usImagePreScan2D<Type> &other)
{
  return (!operator==(other));
}
 
template <class Type> std::ostream &operator<<(std::ostream &out, const usImagePreScan2D<Type> &other)
{
  return out << static_cast<const usImagePreScanSettings &>(other)
             << "number of B-mode samples in a scan line : " << other.getBModeSampleNumber() << std::endl
             << "number of scan lines : " << other.getScanLineNumber() << std::endl;
}
 
template <class Type> unsigned int usImagePreScan2D<Type>::getBModeSampleNumber() const
{
  return vpImage<Type>::getHeight();
}
 
template <class Type> void usImagePreScan2D<Type>::setData(const vpImage<Type> image)
{
  vpImage<Type>::operator=(image);
  setScanLineNumber(image.getWidth());
}
 
template <class Type> void usImagePreScan2D<Type>::setScanLineNumber(unsigned int scanLineNumber)
{
  vpImage<Type>::resize(vpImage<Type>::getHeight(), scanLineNumber);
  usTransducerSettings::setScanLineNumber(scanLineNumber);
}
 
template <class Type> void usImagePreScan2D<Type>::resize(const unsigned int h, const unsigned int w)
{
  usTransducerSettings::setScanLineNumber(w);
  vpImage<Type>::resize(h, w);
}
 
template <class Type> void usImagePreScan2D<Type>::resize(const unsigned int h, const unsigned int w, const Type val)
{
  usTransducerSettings::setScanLineNumber(w);
  vpImage<Type>::resize(h, w, val);
}
 
#endif // __usImagePreScan2D_h_