usImageIo.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 __usImageIo_h_
#define __usImageIo_h_
 
#include <string>
 
#include <visp3/ustk_core/usImagePostScan2D.h>
#include <visp3/ustk_core/usImagePostScan3D.h>
#include <visp3/ustk_core/usImagePreScan2D.h>
#include <visp3/ustk_core/usImagePreScan3D.h>
#include <visp3/ustk_core/usImageRF2D.h>
#include <visp3/ustk_core/usImageRF3D.h>
#include <visp3/ustk_core/usImageSettingsXmlParser.h>
#include <visp3/ustk_core/usMetaHeaderParser.h>
 
class VISP_EXPORT usImageIo
{
private:
  static std::string getExtension(const std::string &filename);
 
public:
  static void read(usImageRF2D<short int> &imageRf2D, const std::string &headerFileName);
  static void read(usImageRF3D<short> &rfImage3D, const std::string &headerFileName);
 
  static void write(const usImageRF2D<short> &rfImage, const std::string &headerFileName,
                    const std::string &imageExtension2D);
  static void write(const usImageRF2D<short> &rfImage, const std::string &headerFileName);
  static void write(const usImageRF3D<short> &rfImage3D, const std::string &headerFileName,
                    const std::string &imageExtension2D);
  static void write(const usImageRF3D<short> &rfImage3D, const std::string &headerFileName);
 
 
  static void read(usImagePreScan2D<unsigned char> &preScanImage, const std::string &headerFileName);
  static void read(usImagePreScan3D<unsigned char> &preScanImage3D, const std::string &headerFileName);
 
  // Doubles types writing not implemented
  static void read(usImagePreScan2D<double> &preScanImage, const std::string &headerFileName);
  static void read(usImagePreScan3D<double> &preScanImage3D, const std::string &headerFileName);
 
  static void write(const usImagePreScan2D<unsigned char> &preScanImage, const std::string &headerFileName,
                    const std::string &imageExtension2D);
  static void write(const usImagePreScan2D<unsigned char> &preScanImage, const std::string &headerFileName);
 
  static void write(const usImagePreScan3D<unsigned char> &preScanImage3D, const std::string &headerFileName,
                    const std::string &imageExtension2D);
  static void write(const usImagePreScan3D<unsigned char> &preScanImage3D, const std::string &headerFileName);
 
  // Doubles types writing not implemented
  static void write(const usImagePreScan2D<double> &preScanImage, const std::string &headerFileName,
                    const std::string &imageExtension2D);
  static void write(const usImagePreScan2D<double> &preScanImage, const std::string &headerFileName);
  static void write(const usImagePreScan3D<double> &preScanImage3D, const std::string &headerFileName,
                    const std::string &imageExtension2D);
  static void write(const usImagePreScan3D<double> &preScanImage3D, const std::string &headerFileName);
 
  static void read(usImagePostScan2D<unsigned char> &postScanImage, const std::string &headerFileName);
  static void read(usImagePostScan3D<unsigned char> &postScanImage3D, const std::string &headerFileName);
 
  static void write(const usImagePostScan2D<unsigned char> &postScanImage, const std::string &headerFileName,
                    const std::string &imageExtension2D);
  static void write(const usImagePostScan2D<unsigned char> &postScanImage, const std::string &headerFileName);
  static void write(const usImagePostScan3D<unsigned char> &postScanImage3D, const std::string &headerFileName,
                    const std::string &imageExtension2D);
  static void write(const usImagePostScan3D<unsigned char> &postScanImage3D, const std::string &headerFileName);
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  struct VolHeader {
    int type;     // Data type(0: prescan B, 1 : postscan B, 2 : rf, 3 : vel / var, 5 = B + flow RGB)
    int volumes;  // Number of volumes in the file
    int fpv;      // Number of frames per volumes
    int w;        // frame width
    int h;        // frame height
    int ss;       // sample size in bits
    int degPerFr; // degree step between frames
  };
 
  struct FrameHeader {
    int type;   // data type
    int frames; // number of frames in file
    int w;      // width (number of scanlines or pixels)
    int h;      // height (number of samples or pixels)
    int ss;     // sample size in bits
    int ulx;    // roi - upper left (x) (unused in Propello)
    int uly;    // roi - upper left (y) (unused in Propello)
    int urx;    // roi - upper right (x) (unused in Propello)
    int ury;    // roi - upper right (y) (unused in Propello)
    int brx;    // roi - bottom right (x) (unused in Propello)
    int bry;    // roi - bottom right (y) (unused in Propello)
    int blx;    // roi - bottom left (x) (unused in Propello)
    int bly;    // roi - bottom left (y) (unused in Propello)
    int probe;  // probe identifier
    int txf;    // transmit frequency in Hz
    int sf;     // sampling frequency in Hz
    int dr;     // data rate (always fps)
    int ld;     // line density (number of scanlines at 100% sector)
    int extra;  // extra information (always 0 in Propello)
  };
#endif // DOXYGEN_SHOULD_SKIP_THIS
 
  typedef enum { FORMAT_XML, FORMAT_MHD, FORMAT_VOL, FORMAT_RF, HEADER_FORMAT_UNKNOWN } usHeaderFormatType;
 
  static usHeaderFormatType getHeaderFormat(const std::string &headerfilename);
};
 
#endif // __usImageIo_h_