ImageSerializer.h

Go to the documentation of this file.

/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLCore/src/ICLCore/ImageSerializer.h                  **
** Module : ICLCore                                                **
** Authors: Christof Elbrechter                                    **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.GPL  **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/

#pragma once

#include <ICLCore/ImgBase.h>
#include <ICLCore/Types.h>
#include <ICLUtils/Exception.h>
#include <ICLUtils/Time.h>
#include <vector>

namespace icl{
  namespace core{
    

    struct ImageSerializer{
      
      typedef std::vector<icl8u> ImageHeader;
      
      static int getHeaderSize();
      
      static int estimateImageDataSize(const ImgBase *image) throw (utils::ICLException);
  
      static int estimateSerializedSize(const ImgBase *image, bool skipMetaData=false) throw (utils::ICLException);
      
      static ImageHeader createHeader(const ImgBase *image) throw (utils::ICLException);
  
      static void serialize(const ImgBase *image, icl8u *dst, 
                            const ImageHeader &header=ImageHeader(),
                            bool skipMetaData=false) throw (utils::ICLException);
      
      static void serialize(const ImgBase *image, std::vector<icl8u> &data,
                            const ImageHeader &header=ImageHeader(),
                            bool skipMetaData=false) throw (utils::ICLException);
      
      static void deserialize(const icl8u *data, ImgBase **dst) throw (utils::ICLException);
  
      static utils::Time deserializeTimeStamp(const icl8u *data) throw (utils::ICLException);
  
    };
  } // namespace core
}