MapleFile.H

Go to the documentation of this file.

/*---------------------------------------------------------------------+
 | Library QgarLib, graphics analysis and recognition                  |
 | Copyright (C) 2002  Qgar Project, LORIA                             |
 |                                                                     |
 | This library is free software; you can redistribute it and/or       |
 | modify it under the terms of the GNU Lesser General Public          |
 | License version 2.1, as published by the Free Software Foundation.  |
 |                                                                     |
 | This library is distributed in the hope that it will be useful,     |
 | but WITHOUT ANY WARRANTY; without even the implied warranty of      |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                |
 | See the GNU Lesser General Public License for more details.         |
 |                                                                     |
 | The GNU Lesser General Public License is included in the file       |
 | LICENSE.LGPL, in the root directory of the Qgar packaging. See      |
 | http://www.gnu.org/licenses/lgpl.html for the terms of the licence. |
 | To receive a paper copy, write to the Free Software Foundation,     |
 | Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.       |
 |                                                                     |
 | Contact Project Qgar for any information:                           |
 |   LORIA - équipe Qgar                                               |
 |   B.P. 239, 54506 Vandoeuvre-lès-Nancy Cedex, France                |
 |   email: qgar-contact@loria.fr                                      |
 |   http://www.qgar.org/                                              |
 *---------------------------------------------------------------------*/


#ifndef __MAPLEFILE_H_INCLUDED__
#define __MAPLEFILE_H_INCLUDED__


/**
 * @file    MapleFile.H
 * @brief   Header file of class qgar::MapleFile.
 *
 * @author  <a href="mailto:qgar-develop@loria.fr?subject=Qgar fwd Karl Tombre">Karl Tombre</a>
 * @date    Jul, 3  2001  9:23
 * @since   Qgar 1.0
 */


// For RCS/CVS use: Do not delete
/* $Id: MapleFile.H,v 1.15 2005/07/13 16:29:01 masini Exp $ */



// QGAR
#include <qgarlib/AbstractFile.H>
#include <qgarlib/GenImage.H>
namespace qgar
{
  // Avoid #include's when not necessary
  class Histogram;
}


namespace qgar
{


/**
 * @class MapleFile MapleFile.H "qgarlib/MapleFile.H"
 * @ingroup IO_FILE
 *
 * @brief File containing a Maple program.
 * 
 * @warning Using default destructor.
 *
 * @todo No function to read a Maple file (except MapleFile::readHeader,
 * that is a pure virtual function and <i>must</i> be implemented).
 *
 * @author <a href="mailto:qgar-develop@loria.fr?subject=Qgar fwd Karl Tombre">Karl Tombre</a>
 * @date   Jul, 3  2001  9:23
 * @since  Qgar 1.0
 */
class MapleFile

  : public AbstractFile

{
// -------------------------------------------------------------------
// P U B L I C    M E M B E R S
// -------------------------------------------------------------------
public:

  /** @name Constructors */
  //        ============
  //@{

  /**
   * @brief Initialize from a grey-level image.
   *
   * The file is open in <b>write-only</b> mode.
   * It includes the code to draw the surface of the grey-level
   * image <b>aGlvmg</b>. The axes of the resulting image are set so as to put
   * the surface in the same reference frame as the image is when it is
   * displayed. To visualize the corresponding surface, load the resulting file
   * using Maple command <b>read</b>.
   *
   * @param aFileName    name of the file
   * @param aGlvImg      a grey-level image
   * @param aTesselation sampling rate in the image (default 1)
   */
  MapleFile(char* aFileName,
            GreyLevelImage& aGlvImg,
            int aTesselation = 1);

  /** 
   * @brief Initialize from a float image.
   * 
   * The file is open in <b>write-only</b> mode.
   * It includes the code to draw the surface of the float
   * image <b>aGlvmg</b>. The axes of the resulting image are set so as to put
   * the surface in the same reference frame as the image is when it is
   * displayed. To visualize the corresponding surface, load the resulting file
   * using Maple command <b>read</b>.
   *
   * @param aFileName    name of the file
   * @param aFloatImg    the float image to initialize this instance from
   * @param aTesselation sampling rate in the image (default 1)
   */
  MapleFile(char* aFileName,
            FloatImage& aFloatImg,
            int aTesselation = 1);

  /** 
   * @brief Initialize from a histogram.
   *
   * The file is open in <b>write-only</b> mode.
   * It includes the code to draw the histogram as a curve.
   * image <b>aGlvmg</b>. To visualize the corresponding surface, load the
   * resulting file using Maple command <b>read</b>.
   *
   * @param aFileName    name of the file
   * @param aHistogram   a histogram
   */
  MapleFile(char* aFileName, Histogram& aHistogram);

  //@}


  /** @name Destructor */
  //        ==========
  //@{

  /**
   * @brief Virtual destructor.
   */
  virtual ~MapleFile();

  //@}


// -------------------------------------------------------------------
// P R O T E C T E D    M E M B E R S
// -------------------------------------------------------------------
protected:

  /** @name Input */
  //        =====
  //@{

  /**
   * @brief Read file header.
   */
  virtual void readHeader();

  //@}


  /** @name Output */
  //        ======
  //@{

  /**
   * @brief Write file header.
   */
  virtual void writeHeader();

  /**
   * @brief Write file footer.
   */
  virtual void writeFooter();

  //@}

// -------------------------------------------------------------------
}; // class MapleFile


} // namespace qgar 

#endif /* __MAPLEFILE_H_INCLUDED__ */