usImageSettingsXmlParser.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:
 * Marc Pouliquen
 *
 *****************************************************************************/
 
#ifndef __usImageSettingsXmlParser_h_
#define __usImageSettingsXmlParser_h_
 
#include <visp3/core/vpConfig.h>
 
#ifdef VISP_HAVE_XML2
 
#include <iostream>
#include <string>
#include <visp3/core/vpDebug.h>
#include <visp3/core/vpIoTools.h>
#include <visp3/core/vpXmlParser.h>
#include <visp3/io/vpParseArgv.h>
#include <visp3/ustk_core/us.h>
#include <visp3/ustk_core/usImagePostScan2D.h>
#include <visp3/ustk_core/usImagePreScan2D.h>
#include <visp3/ustk_core/usMotorSettings.h>
#include <visp3/ustk_core/usTransducerSettings.h>
 
class VISP_EXPORT usImageSettingsXmlParser : public vpXmlParser
{
public:
  usImageSettingsXmlParser();
  usImageSettingsXmlParser(const usImageSettingsXmlParser &twinparser);
  // usImageSettingsXmlParser(usImageSettingsXmlParser& twinParser);
  usImageSettingsXmlParser &operator=(const usImageSettingsXmlParser &twinparser);
  virtual ~usImageSettingsXmlParser();
 
  typedef enum
  {
    CODE_XML_BAD = -1,
    CODE_XML_SETTINGS,
    CODE_XML_IMAGE_TYPE,
    CODE_XML_SCANLINE_PITCH,
    CODE_XML_TRANSDUCER_RADIUS,
    CODE_XML_IS_TRANSDUCER_CONVEX,
    CODE_XML_FRAME_PITCH,
    CODE_XML_MOTOR_RADIUS,
    CODE_XML_MOTOR_TYPE,
    CODE_XML_AXIAL_RESOLUTION,
    CODE_XML_SAMPLING_FREQUENCY,
    CODE_XML_TRANSMIT_FREQUENCY,
    CODE_XML_HEIGHT_RESOLUTION,
    CODE_XML_WIDTH_RESOLUTION,
    CODE_XML_SCANLINE_NUMBER,
    CODE_XML_FRAME_NUMBER,
    CODE_XML_SPACING_X,
    CODE_XML_SPACING_Y,
    CODE_XML_SPACING_Z,
 
    CODE_XML_ASSOCIATED_IMAGE_FILE_NAME,
    CODE_XML_SEQUENCE_FRAME_RATE,
    CODE_XML_SEQUENCE_FIRST_IMAGE_NUMBER,
    CODE_XML_SEQUENCE_LAST_IMAGE_NUMBER,
  } vpXmlCodeType;
 
  typedef enum { SEQUENCE_OK, SEQUENCE_ERROR } vpXmlCodeSequenceType;
 
  // getters
  double getAxialResolution() const { return m_axialResolution; }
  double getFrameNumber() const { return m_motorSettings.getFrameNumber(); }
  std::string getImageFileName() const { return m_imageFileName; }
  double getHeightResolution() const { return m_heightResolution; }
  us::ImageType getImageType() const { return m_image_type; }
  usMotorSettings getMotorSettings() const { return m_motorSettings; }
  unsigned int getScanLineNumber() const { return m_transducerSettings.getScanLineNumber(); }
  double getSequenceFrameRate() const { return m_sequence_frame_rate; }
  int getSequenceStartNumber() const { return m_sequence_start; }
  int getSequenceStopNumber() const { return m_sequence_stop; }
  double getSpacingX() const { return m_spacingX; }
  double getSpacingY() const { return m_spacingY; }
  double getSpacingZ() const { return m_spacingZ; }
  double getWidthResolution() const { return m_widthResolution; }
  usTransducerSettings getTransducerSettings() const { return m_transducerSettings; }
 
  bool isImage3D() const { return m_is_3D; }
  bool isSequence() const { return m_is_sequence; }
 
  // Data setters
  void setFrameNumber(unsigned int frameNumber) { m_motorSettings.setFrameNumber(frameNumber); }
  void setImageFileName(const std::string &imageFileName);
  void setImageSettings(double transducerRadius, double scanLinePitch, bool isTransducerConvex, double axialResolution,
                        us::ImageType image_type, int samplingFrequency, int transmitFrequency);
  void setImageSettings(double transducerRadius, double scanLinePitch, bool isTransducerConvex,
                        unsigned int scanLineNumber, double widthResolution, double heightResolution,
                        int samplingFrequency, int transmitFrequency);
  void setImageType(us::ImageType image_type) { m_image_type = image_type; }
  void setMotorSettings(const usMotorSettings &motorSettings);
  void setScanLineNumber(unsigned int scanLineNumber) { m_transducerSettings.setScanLineNumber(scanLineNumber); }
  void setSequenceFrameRate(double sequenceFrameRate)
  {
    m_sequence_frame_rate = sequenceFrameRate;
    m_is_sequence = true;
  }
  void setSequenceStartNumber(int sequenceStartNumber)
  {
    m_sequence_start = sequenceStartNumber;
    m_is_sequence = true;
  }
  void setSequenceStopNumber(int sequenceStopNumber)
  {
    m_sequence_stop = sequenceStopNumber;
    m_is_sequence = true;
  }
  void setSequenceType(bool isSequence) { m_is_sequence = isSequence; }
  void setSpacing(double spacingX, double spacingY, double spacingZ)
  {
    m_spacingX = spacingX;
    m_spacingY = spacingY;
    m_spacingZ = spacingZ;
  }
  void setTransducerSettings(const usTransducerSettings transducerSettings);
 
private:
  // basic
  usTransducerSettings m_transducerSettings;
 
  // for 2D post scan images
  double m_widthResolution;
  double m_heightResolution;
 
  // for 3D post scan images
  double m_spacingX;
  double m_spacingY;
  double m_spacingZ;
 
  // for rf / pre-scan
  double m_axialResolution;
 
  // for 3D
  usMotorSettings m_motorSettings;
 
  std::string m_imageFileName;
 
  // to manage different resolution types
  us::ImageType m_image_type;
  bool m_is_3D;
  // to manage usltrasound images sequences
  bool m_is_sequence;
  double m_sequence_frame_rate;
  std::string m_sequence_name;
  int m_sequence_start;
  int m_sequence_stop;
 
protected:
  void readMainClass(xmlDocPtr doc, xmlNodePtr node);
  void writeMainClass(xmlNodePtr node);
};
#endif // __usImageSettingsXmlParser_h_
#endif // VISP_HAVE_XML2