evDataset.h

Go to the documentation of this file.

/*
 *
 * EVITA: Efficient Visualization of Terascale Datasets
 * Copyright (C) 2000-2016  Team Evita
 * 
 * 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., 675 Mass Ave, Cambridge,
 * MA 02139, USA.
 *
 */


#ifndef __evDataset_h
#define __evDataset_h


#include "evDataObject.h"
#include "evROIList.h"
#include "evCodec.h"
#include "evProgressReporter.h"


class evDataset : public evDataObject
{
 public:
  evDataset(void);
  virtual ~evDataset(void);
  
  virtual const evString GetClassName(void) const
    {
      return(evString("evDataset"));
    }

  void Free(void);
  
  int Copy(const evDataset &dataset);

  int SetSize(const evAddress &address);
  void SetGridType(const int grid_type);
  void SetVectorDimension(const unsigned int num_components,
                          const unsigned int *vector_dimension);
  void SetComponentName(const unsigned int component,
                        const evString component_name);

  int GetNumDimensions(void) const;
  int GetSize(const int index) const;
  evAddress GetSize(void) const;
  unsigned int GetTotalSize(void) const;
  int GetGridType(void) const;
  //  int HasExplicitGrid(void) const;
  unsigned int GetNumComponents(void) const;
  unsigned int GetVectorDimension(const unsigned int component) const;
  const unsigned int *GetVectorDimension(void) const;
  evString GetComponentName(const unsigned int component) const;

  int ReadHeader(evFile &infile, evString &compression_method);
  int Read(const evString filename,
           evProgressReporter *progress_reporter = NULL);
  int WriteHeader(evFile &outfile, const evString &compression_method) const;
  int Write(const evString filename,
            evProgressReporter *progress_reporter = NULL);
  
  int SetCodec(const evString compression_method);
  evCodec *GetCodec(void) const;
  
  evROIList *GetROIList(void);
  const evROIList *GetROIList(void) const;

  int AllocateSingleROI(void);

  int Segment(const evSegmentationMap &segmentation_map,
              const unsigned int tile_size,
              evProgressReporter *progress_reporter = NULL);
  int Composite(unsigned int component, evVectorField &field) const;

  double DistortionMSE(const unsigned int component,
                       const evDataset &dataset) const;

  virtual void PrintSelf(const int tabbing) const;

 protected:
  
 private:
  unsigned int NumDimensions;
  evAddress Size;
  unsigned int TotalSize;

  int GridType;

  unsigned int NumComponents;
  unsigned int *VectorDimension;
  std::vector<evString> ComponentName;

  evROIList ROIList;
  evCodec *Codec;

  void Initialize(void);
  
  int Encode(evBitBuffer &output_buffer,
             evProgressReporter *progress_reporter = NULL);
  int Decode(evBitBuffer &input_buffer,
             evProgressReporter *progress_reporter = NULL);

};


inline void evDataset::SetGridType(const int grid_type)
{
  this->GridType = grid_type;
}


inline void evDataset::SetComponentName(const unsigned int component,
                                        const evString component_name)
{
  if (component >= this->NumComponents)
    return;
  this->ComponentName[component] = component_name;
}


inline int evDataset::GetGridType(void) const
{
  return(this->GridType);
}


/*
inline int evDataset::HasExplicitGrid(void) const
{
  return(evROI::HasExplicitGrid(this->GridType));
}
*/


inline int evDataset::GetNumDimensions(void) const
{
  return(this->NumDimensions);
}


inline int evDataset::GetSize(const int index) const
{
  return(this->Size.Get(index));
}


inline evAddress evDataset::GetSize(void) const
{
  return(this->Size);
}


inline unsigned int evDataset::GetTotalSize(void) const
{
  return(this->TotalSize);
}


inline unsigned int evDataset::GetNumComponents(void) const
{
  return(this->NumComponents);
}


inline unsigned int evDataset::GetVectorDimension(const unsigned int component)
  const
{
  if ((this->VectorDimension == NULL) || (component >= this->NumComponents))
    return(0);

  return(this->VectorDimension[component]);
}


inline const unsigned int *evDataset::GetVectorDimension(void) const
{
  return(this->VectorDimension);
}


inline evString evDataset::GetComponentName(const unsigned int component) const
{
  evString component_name;
  
  if (component < this->NumComponents)
    component_name = this->ComponentName[component];

  return(component_name);
}


inline evCodec *evDataset::GetCodec(void) const
{
  return(this->Codec);
}


inline evROIList *evDataset::GetROIList(void)
{
  return(&this->ROIList);
}


inline const evROIList *evDataset::GetROIList(void) const
{
  return(&this->ROIList);
}


#endif