olb::BlockGifWriter< T > Class Template Reference

BlockGifWriter writes given functor data to image file of format .ppm. More...

#include <blockGifWriter.h>

Collaboration diagram for olb::BlockGifWriter< T >:

Public Member Functions
	BlockGifWriter (std::string const &map="leeloo")
void	write (BlockF2D< T > &f, T minValue, T maxValue, int iT=0, std::string const &name="emptyName")
	writes functor values normed to interval [0,1].
void	write (BlockF2D< T > &f, int iT=0, std::string const &name="emptyName")
	writes functor data and determines its util::min-/maxValue
void	write (int iT=0)
	writes functors stored at pointerVec
void	addFunctor (BlockF2D< T > &f, std::string const &name="emptyName")
	put functor to _pointerVec, to simplify writing process of several functors
void	addFunctor (BlockF2D< T > &f, T minValue, T maxValue, std::string const &name="emptyName")

Detailed Description

template<typename T>
class olb::BlockGifWriter< T >

BlockGifWriter writes given functor data to image file of format .ppm.

There are two different modes

1. mode: image maxValue and minValue are computed every time. this implies that image data is scaled every time exactly to interval [0,1]. this may lead to different scaling of the functor data concerning the time steps
2. mode: image maxValue and minValue are passed by the user once. this static use, prevents a rescaling effect for each time step.

Parameters

map	determines the color of the graphics

Definition at line 48 of file blockGifWriter.h.

Constructor & Destructor Documentation

BlockGifWriter()

template<typename T >

olb::BlockGifWriter< T >::BlockGifWriter

(

std::string const &

map = "leeloo"

)

Definition at line 41 of file blockGifWriter.hh.

  : clout(std::cout, "BlockGifWriter"), _colorRange(1024), _numColors(1024),
    _colorMap(graphics::mapGenerators::generateMap<T>(map)), _minValue(0),
    _maxValue(1)
{ }

Member Function Documentation

addFunctor() [1/2]

template<typename T >

void olb::BlockGifWriter< T >::addFunctor	(	BlockF2D< T > &	f,
		std::string const &	name = "emptyName" )

put functor to _pointerVec, to simplify writing process of several functors

Definition at line 153 of file blockGifWriter.hh.

{
  _pointerVec.push_back(&f);
 
  if ( name == "emptyName") {
    _name.push_back(f.getName() );
  }
  _name.push_back(name);
 
  _autoScale.push_back(true);
  _minValue.push_back(T());
  _maxValue.push_back(T());
}

References olb::GenericF< T, S >::getName().

Here is the call graph for this function:

addFunctor() [2/2]

template<typename T >

void olb::BlockGifWriter< T >::addFunctor	(	BlockF2D< T > &	f,
		T	minValue,
		T	maxValue,
		std::string const &	name = "emptyName" )

Definition at line 168 of file blockGifWriter.hh.

{
  _pointerVec.push_back(&f);
 
  if ( name == "emptyName") {
    _name.push_back(f.getName() );
  }
  _name.push_back(name);
 
  _autoScale.push_back(false);
  _minValue.push_back(minValue);
  _maxValue.push_back(maxValue);
}

References olb::GenericF< T, S >::getName().

Here is the call graph for this function:

write() [1/3]

template<typename T >

void olb::BlockGifWriter< T >::write	(	BlockF2D< T > &	f,
		int	iT = 0,
		std::string const &	name = "emptyName" )

writes functor data and determines its util::min-/maxValue

Definition at line 101 of file blockGifWriter.hh.

{
  // determine util::min-/maxValue
  int i[2] = {0,0};
  // initialize util::min-/maxValue
  T minValue[1];
  T maxValue[1];
  f(minValue,i);
  f(maxValue,i);
  for (i[0] = 1; i[0] < f.getBlockStructure().getNx(); i[0]++) {
    for (i[1] = 1; i[1] < f.getBlockStructure().getNy(); i[1]++) {
      T valueTmp[1];
      f(valueTmp,i);
      if (valueTmp[0] < minValue[0]) {
        minValue[0] = valueTmp[0];
      }
      if (valueTmp[0] > maxValue[0]) {
        maxValue[0] = valueTmp[0];
      }
    }
  }
  if (maxValue[0] <= minValue[0]) {
    minValue[0] = T();
    maxValue[0] = T(1);
  }
  // call write() with util::min-/maxValue
  write(f, minValue[0], maxValue[0], iT, name);
}

References olb::BlockF2D< T >::getBlockStructure().

Here is the call graph for this function:

write() [2/3]

template<typename T >

void olb::BlockGifWriter< T >::write	(	BlockF2D< T > &	f,
		T	minValue,
		T	maxValue,
		int	iT = 0,
		std::string const &	name = "emptyName" )

writes functor values normed to interval [0,1].

imageValue is computed according to : if functorValue >= maxValue then the imageValue is clipped to 1 else imageValue = (minValue - functorValue) / (minValue - maxValue)

Definition at line 48 of file blockGifWriter.hh.

{
  // [!] exeption image(f) != 1
  if ( f.getTargetDim() != 1 ) {
    clout << "Error: Functor targetDim is not 1. " << std::endl;
    exit(-1);
  }
  else {
    if ( singleton::mpi().getRank() == 0 ) {
      std::string fullNamePpm;
      if ( name == "emptyName") {
        fullNamePpm = createFileName( singleton::directories().getImageOutDir(),
                                      f.getName(), iT);
      }
      else {
        fullNamePpm = createFileName( singleton::directories().getImageOutDir(),
                                      name, iT);
      }
      fullNamePpm = fullNamePpm  + ".ppm" ;
      std::ofstream fout( fullNamePpm.c_str() );
 
      // write header
      fout << "P3\n";
      // dimension of image
      fout << f.getBlockStructure().getNx() << " "
           << f.getBlockStructure().getNy() << "\n";
      // dynamic range
      fout << (_colorRange - 1) << "\n";
 
      int i[2] = {0,0};
      for (i[1] = f.getBlockStructure().getNy() - 1; i[1] >= 0; --i[1]) {
        for (i[0] = 0; i[0] < f.getBlockStructure().getNx(); ++i[0]) {
          T evaluated[1];
          f(evaluated,i);
          // scales evaluated in [getMinValue(),getMaxValue()] to [0,1]
          evaluated[0] = (minValue - evaluated[0]) / (minValue - maxValue);
          // sets evaluated notin [getMinValue(),getMaxValue()] to 1
          if ( evaluated[0] >= T(1) ) {
            evaluated[0] = 1;
          }
          graphics::rgb<T> color = _colorMap.get(evaluated[0]);
          fout << (int)(color.r * (_colorRange - 1)) << " "
               << (int)(color.g * (_colorRange - 1)) << " "
               << (int)(color.b * (_colorRange - 1)) << "\n";
        }
      }
      fout.close();
    }
  }
}

References olb::graphics::rgb< T >::b, olb::createFileName(), olb::singleton::directories(), olb::graphics::rgb< T >::g, olb::BlockF2D< T >::getBlockStructure(), olb::GenericF< T, S >::getName(), olb::BlockStructureD< D >::getNx(), olb::BlockStructureD< D >::getNy(), olb::GenericF< T, S >::getTargetDim(), olb::singleton::mpi(), and olb::graphics::rgb< T >::r.

Here is the call graph for this function:

write() [3/3]

template<typename T >

void olb::BlockGifWriter< T >::write

(

int

iT = 0

)

writes functors stored at pointerVec

Definition at line 133 of file blockGifWriter.hh.

{
  if ( _pointerVec.empty() ) {
    // secure code. doesn't appear on console ??
    clout << "Error: Please add functor via addFunctor()";
  }
  else {
    int i = 0;
    for ( auto it = _pointerVec.cbegin(); it != _pointerVec.cend(); ++it, ++i) {
      if (_autoScale[i]) {
        write(**it, iT, _name[i]);
      }
      else {
        write(**it, _minValue[i], _maxValue[i], iT, _name[i]);
      }
    }
  }
}

---

The documentation for this class was generated from the following files:

• src/io/blockGifWriter.h
• src/io/blockGifWriter.hh