vlvolinfo.h

Go to the documentation of this file.

// $Id: vlvolinfo.h,v 1.20 2004/08/19 11:14:33 slfrank Exp $
//
// OpenVL - A Library for working with volumetric datasets.
//          http://openvl.sf.net
//
// Copyright (C) 2000-2002  Sarang Lakare <sarang#users.sf.net>
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Library General Public
// License as published by the Free Software Foundation; either
// version 2 of the License, or (at your option) any later version.
//
// 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
// Library General Public License for more details.
//
// You should have received a copy of the GNU Library General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA.
//
// Please report all bugs and problems to openvl-devel@lists.sf.net or
// at the OpenVL website.
//

#ifndef _vlVolInfo_h
#define _vlVolInfo_h

// C/C++ includes
#include <string>
#include <vector>
#include <iostream>

// OpenVL includes
#include "vlenums.h"
#include "vldim.h"
#include "vlpoint.h"
#include "vlunit.h"
#include "vlstep.h"
#include "vlvarlistadmin.h"

class vlVolInfo {
// Member functions
public:
  vlVolInfo();

  virtual ~vlVolInfo();

  bool isValid() const;

  vlDim dim() const { return m_dim; };

  vlDim origFileDim() const { return m_origFileDim; };

  vlStep stepping() const { return m_step; };

  vlUnit units() const { return m_units; };

  vlPoint3ui origFilePos() const { return m_position; };


  uint16 bitsPerVoxel() const { return m_bitsPerVoxel; };

  uint16 bytesPerVoxel() const { return m_bytesPerVoxel; };

  uint16 memSize() const { return m_bytesPerVoxel*m_dim.x()*m_dim.y()*m_dim.z(); };

  vlDataType dataType() const { return m_dataType; };

  vlLayoutType dataLayout() const { return m_layout; };

  vlLayoutType nonInterleaved() const { return m_noninterleavedRGB; };

  uint32 headerSize() const { return m_headerSize; };

  const vlVarList * extraInfo() const { return (&m_extraInfo); };

  vlVarList * extraInfoRW() { return (&m_extraInfo); };

  void setOrigFilePos(const vlPoint3ui & position) { m_position = position; };

  void setDim(const vlDim & dim) { m_dim = dim; };

        void setOrigFileDim(const vlDim & dim) { m_origFileDim = dim; };

  void setStepping(const vlStep & step) { m_step = step; };

  void setUnits(const vlUnit & units) { m_units = units; };

  void setBitsPerVoxel(const uint16 bitsPerVoxel) { m_bitsPerVoxel = bitsPerVoxel; };

  void setBytesPerVoxel(const uint16 bytesPerVoxel) { m_bytesPerVoxel = bytesPerVoxel; };

  void setDataType(const vlDataType type) { m_dataType = type; };

  void setDataLayout(const vlLayoutType type) { m_layout = type; };

  void setNonInterleaved(const bool ni) { m_noninterleavedRGB = ni; };

  void setHeaderSize(const uint32 size) { m_headerSize = size; };

  void setExtraInfo(const vlVarList * extraInfo)
  {
    m_extraInfo.clear(); m_extraInfo = *extraInfo;
  };

  friend std::ostream & operator << (std::ostream & os, vlVolInfo const & info) {
    return (os<<"Volume Info:  \nDim:"<<info.m_dim<<"\nUnits:"<<info.m_units<<"\nBits/Voxel: "<<info.m_bitsPerVoxel
            <<"\nBytes/Voxel: " <<info.m_bytesPerVoxel<<"  ");
  }

protected:
  vlDim m_dim;

  vlDim m_origFileDim;

  vlStep m_step;

  vlUnit m_units;

  unsigned short m_bitsPerVoxel;

  unsigned short m_bytesPerVoxel;

  vlDataType m_dataType;

  vlLayoutType m_layout;

  bool m_noninterleavedRGB;

  unsigned long m_headerSize;

  vlPoint3ui m_position;

  vlVarListAdmin m_extraInfo;

private:

};


#endif // _vlVolInfo_h

---