QweakSimFieldMap< value_t, value_n > Class Template Reference

A multi-dimensional grid of values with interpolation methods. More...

#include <QweakSimFieldMap.hh>

Public Types
enum	debug_t { kError, kWarning, kVerbose, kDebug }
	Debug level. More...

Public Member Functions
	QweakSimFieldMap (const unsigned int ndim=1)
	Constructor with number of dimensions. More...
	QweakSimFieldMap (const std::vector< coord_t > &min, const std::vector< coord_t > &max, const std::vector< coord_t > &step)
	Constructor with minimum, maximum, and step size. More...
	QweakSimFieldMap (const std::string &filename)
	Constructor with file name. More...
virtual	~QweakSimFieldMap ()
	Destructor. More...
void	SetDebugLevel (debug_t debug)
	Set debug level. More...
void	SetDimensions (const unsigned int ndim)
	Set the number of coordinate dimensions and resize vectors. More...
void	SetMinimumMaximumStep (const coord_t min, const coord_t max, const coord_t step)
	Set minimum, maximum, and step size to single values. More...
void	SetMinimumMaximumStep (const std::vector< coord_t > &min, const std::vector< coord_t > &max, const std::vector< coord_t > &step)
	Set minimum, maximum, and step size to different values. More...
coord_t	GetMinimum (const unsigned int dim) const
	Get minimum in dimension. More...
coord_t	GetMaximum (const unsigned int dim) const
	Get maximum in dimension. More...
coord_t	GetStepSize (const unsigned int dim) const
	Get minimum in dimension. More...
unsigned int	GetMaximumEntries () const
	Get the maximum number of entries. More...
unsigned int	GetCurrentEntries () const
	Get the current number of entries. More...
unsigned int	GetWrapCoordinate (const unsigned int dim) const
	Get wrapping coordinate. More...
void	SetWrapCoordinate (const unsigned int dim, const size_t wrap=1)
	Set wrapping coordinate. More...
void	SetWrapCoordinate (const std::vector< size_t > &wrap)
int	GetDataReductionFactor (const unsigned int dim) const
	Get data reduction factor. More...
void	SetDataReductionFactor (const unsigned int dim, const unsigned int redux)
	Set data reduction factor. More...
void	SetDataReductionFactor (const unsigned int redux)
void	SetDataReductionFactor (const std::vector< unsigned int > &redux)
void	SetInterpolationMethod (const EInterpolationMethod method)
	Set the interpolation method. More...
EInterpolationMethod	GetInterpolationMethod () const
	Get the interpolation method. More...
void	PrintCoverage (const unsigned int dim)
	Print coverage map for all bins in one dimension. More...
bool	InBounds (const coord_t *coord) const
	Return true if the coordinate is in bounds. More...
Functions to write grid values
bool	Set (const coord_t &coord, const value_t &value)
	Set a single value at a coordinate (false if not possible) More...
bool	Set (const coord_t *coord, const value_t &value)
	Set a single value at a coordinate (false if not possible) More...
bool	Set (const coord_t *coord, const value_t *value)
	Set a set of values at a coordinate (false if not possible) More...
bool	Set (const unsigned int linear_index, const value_t &value)
	Set a single value at a linearized index (false if not possible) More...
bool	Set (const unsigned int linear_index, const value_t *value)
	Set a set of values at a linearized index (false if not possible) More...
bool	Set (const unsigned int *cell_index, const value_t &value)
	Set a single value at a grid point (false if out of bounds) More...
bool	Set (const unsigned int *cell_index, const value_t *value)
	Set a set of values at a grid point (false if out of bounds) More...
Functions to retrieve interpolated values
value_t	GetValue (const coord_t &coord) const
	Get the interpolated value at coordinate (zero if out of bounds) More...
value_t	GetValue (const coord_t *coord) const
	Get the interpolated value at coordinate (zero if out of bounds) More...
bool	GetValue (const coord_t *coord, double &value) const
	Get the interpolated value at coordinate (zero if out of bounds) More...
bool	GetValue (const coord_t *coord, double *value) const
	Get the interpolated value at coordinate (zero if out of bounds) More...
File reading and writing
bool	WriteText (std::ostream &stream) const
	Write the grid as text. More...
bool	WriteTextFile (const std::string &filename) const
	Write the grid to text file. More...
bool	WriteTextScreen () const
	Write the grid to screen. More...
bool	ReadText (std::istream &stream)
	Read the grid from text. More...
bool	ReadTextFile (const std::string &filename)
	Read the grid from text file. More...
bool	WriteBinaryFile (const std::string &filename) const
	Write the grid values to binary file. More...
bool	ReadBinaryFile (const std::string &filename)
	Read the grid values from binary file. More...
Indexing functions (publicly available and unchecked)
unsigned int	Index (const coord_t *coord) const
	Return the linearized index based on the point coordinates (unchecked) More...
unsigned int	Index (const unsigned int *cell_index) const
	Return the linearized index based on the cell indices (unchecked) More...
unsigned int	Index (const unsigned int *cell_index, const unsigned int offset) const
	Return the linearized index based on the cell indices and offset (unchecked) More...
void	Cell (const coord_t coord, unsigned int &cell_index, double &cell_local, const unsigned int dim) const
	Return the cell index and local coordinates in one dimension (unchecked) More...
void	Cell (const coord_t *coord, unsigned int *cell_index, double *cell_local) const
	Return the cell index and local coordinates (unchecked) More...
void	Cell (const coord_t *coord, unsigned int *cell_index) const
	Return the cell index (unchecked) More...
void	Cell (unsigned int linear_index, unsigned int *cell_index) const
	Return the cell index based on the linearized index (unchecked) More...
void	Coord (const unsigned int *cell_index, coord_t *coord) const
	Return the coordinates based on the cell index (unchecked) More...
void	Coord (const unsigned int linear_index, coord_t *coord) const
	Return the coordinates based on the linearized index (unchecked) More...

Data Fields
enum QweakSimFieldMap::debug_t	fDebug

Private Member Functions
void	Nearest (const coord_t *coord, unsigned int *cell_index) const
	Return the cell index closest to the coordinate (could be above) (unchecked) More...
bool	Linear (const coord_t *coord, value_t *value) const
	Linear interpolation (unchecked) More...
bool	NearestNeighbor (const coord_t *coord, value_t *value) const
	Nearest-neighbor (unchecked) More...
bool	Check (const coord_t *coord) const
	Check for boundaries with coordinate argument. More...
bool	Check (const unsigned int *cell_index) const
	Check for boundaries with cell index argument. More...
bool	Check (const unsigned int linear_index) const
	Check for boundaries with linearized index argument. More...
value_t	Get (const unsigned int *cell_index) const
	Get a single value by cell index (unchecked) More...
value_t	Get (const unsigned int index) const
	Get a single value by linearized index (unchecked) More...
bool	Get (const unsigned int index, value_t *value) const
	Get a vector value by linearized index (unchecked) More...

Private Attributes
unsigned int	fNDim
	Number of dimensions in coordinates. More...
std::vector< coord_t >	fMin
	Minimum in each dimension. More...
std::vector< coord_t >	fMax
	Maximum in each dimension. More...
std::vector< coord_t >	fStep
	Step size in each dimension. More...
std::vector< size_t >	fSize
	Number of points in each dimension. More...
std::vector< size_t >	fWrap
	Wrap around this coordinate. More...
std::vector< size_t >	fRedux
	Data reduction factor. More...
std::vector< size_t >	fExtent
std::vector< value_t >	fValues [value_n]
	Table with pointers to arrays of values. More...
unsigned int	fCurrentEntries
	Number of values read in. More...
unsigned int	fMaximumEntries
	Maximum number of values. More...
EInterpolationMethod	fInterpolationMethod
	Interpolation method. More...

Detailed Description

template<class value_t = float, unsigned int value_n = 1>
class QweakSimFieldMap< value_t, value_n >

A multi-dimensional grid of values with interpolation methods.

This class provides various interpolation methods on a multi-dimensional grid of multi-dimensional values. Linear interpolation and nearest-neighbor are implemented for all dimensions.

The template arguments are the internal storage data type (defaults to float) and the number of dimensions of the stored data at each grid point (defaults to one). The dimension of the grid itself is set through the constructor. To describe a double vector field with 5 components on a 3-dimensional grid, you would write

* QwInterpolate<float,5> *field = new QweakSimFieldMap<float,5>(3);
* 

The minimum, maximum, and step size of the grid have to be known before the values are filled.

Definition at line 51 of file QweakSimFieldMap.hh.

Member Enumeration Documentation

template<class value_t = float, unsigned int value_n = 1>

enum QweakSimFieldMap::debug_t

Debug level.

Enumerator
kError
kWarning
kVerbose
kDebug

Definition at line 78 of file QweakSimFieldMap.hh.

{kError, kWarning, kVerbose, kDebug} fDebug;

Constructor & Destructor Documentation

template<class value_t = float, unsigned int value_n = 1>

QweakSimFieldMap< value_t, value_n >::QweakSimFieldMap ( const unsigned int  ndim = 1 )

inline

Constructor with number of dimensions.

Definition at line 56 of file QweakSimFieldMap.hh.

References kMultiLinear, QweakSimFieldMap< value_t, value_n >::SetDimensions(), and QweakSimFieldMap< value_t, value_n >::SetInterpolationMethod().

                                                  {
      SetDimensions(ndim);
      SetInterpolationMethod(kMultiLinear);
    };

Here is the call graph for this function:

template<class value_t = float, unsigned int value_n = 1>

QweakSimFieldMap< value_t, value_n >::QweakSimFieldMap ( const std::vector< coord_t > &  min, const std::vector< coord_t > &  max, const std::vector< coord_t > &  step  )

inline

Constructor with minimum, maximum, and step size.

Definition at line 61 of file QweakSimFieldMap.hh.

References kMultiLinear, QweakSimFieldMap< value_t, value_n >::SetDimensions(), QweakSimFieldMap< value_t, value_n >::SetInterpolationMethod(), and QweakSimFieldMap< value_t, value_n >::SetMinimumMaximumStep().

                                        {
      SetDimensions(min.size());
      SetInterpolationMethod(kMultiLinear);
      SetMinimumMaximumStep(min,max,step);
    };

Here is the call graph for this function:

template<class value_t = float, unsigned int value_n = 1>

QweakSimFieldMap< value_t, value_n >::QweakSimFieldMap ( const std::string &  filename )

inline

Constructor with file name.

Definition at line 69 of file QweakSimFieldMap.hh.

References kMultiLinear, QweakSimFieldMap< value_t, value_n >::ReadBinaryFile(), and QweakSimFieldMap< value_t, value_n >::SetInterpolationMethod().

                                                {
      ReadBinaryFile(filename);
      SetInterpolationMethod(kMultiLinear);
    };

Here is the call graph for this function:

template<class value_t = float, unsigned int value_n = 1>

virtual QweakSimFieldMap< value_t, value_n >::~QweakSimFieldMap ( )

inlinevirtual

Destructor.

Definition at line 74 of file QweakSimFieldMap.hh.

{ };

Member Function Documentation

template<class value_t , unsigned int value_n>

void QweakSimFieldMap< value_t, value_n >::Cell ( const coord_t  coord, unsigned int &  cell_index, double &  cell_local, const unsigned int  dim  ) const

inline

Return the cell index and local coordinates in one dimension (unchecked)

Return the cell index and local coordinates in one dimension (unchecked)

Parameters

coord	Point coordinate in one dimension
cell_index	Cell index of the point (reference)
cell_local	Local coordinates in cell (reference)
dim	Dimension

Definition at line 723 of file QweakSimFieldMap.hh.

Referenced by QweakSimFieldMap< value_t, value_n >::Index(), QweakSimFieldMap< value_t, value_n >::Nearest(), and QweakSimFieldMap< value_t, value_n >::PrintCoverage().

{
  // Normalize coordinate (positive, with integers on grid points)
  double norm_coord = (coord - fMin[dim]) / fStep[dim];
  // Split in fractional and integer part
  double frac_part, int_part;
  frac_part = modf(norm_coord, &int_part);
  cell_local = frac_part;
  cell_index = static_cast<int>(int_part); // cast to integer
  // Wrap index
  if (fWrap[dim] > 0) cell_index %= (fSize[dim] - fWrap[dim]);
}

Here is the caller graph for this function:

template<class value_t , unsigned int value_n>

void QweakSimFieldMap< value_t, value_n >::Cell ( const coord_t *  coord, unsigned int *  cell_index, double *  cell_local  ) const

inline

Return the cell index and local coordinates (unchecked)

Return the cell index and local coordinates (unchecked)

Parameters

coord	Point coordinates
cell_index	Cell index of the point (reference)
cell_local	Local coordinates in cell (reference)

Definition at line 747 of file QweakSimFieldMap.hh.

{
  // Get cell index and local coordinates in each dimension
  for (unsigned int dim = 0; dim < fNDim; dim++)
    Cell(coord[dim], cell_index[dim], cell_local[dim], dim);
}

template<class value_t , unsigned int value_n>

void QweakSimFieldMap< value_t, value_n >::Cell ( const coord_t *  coord, unsigned int *  cell_index  ) const

inline

Return the cell index (unchecked)

Return the cell index (unchecked)

Parameters

coord	Point coordinates
cell_index	Cell index of the point (reference)

Definition at line 763 of file QweakSimFieldMap.hh.

{
  // Get cell index and ignore local coordinates
  double* cell_local = new double[fNDim];
  Cell(coord, cell_index, cell_local);
  delete[] cell_local;
}

template<class value_t , unsigned int value_n>

void QweakSimFieldMap< value_t, value_n >::Cell ( unsigned int  linear_index, unsigned int *  cell_index  ) const

inline

Return the cell index based on the linearized index (unchecked)

Return the cell index based on the linearized index (unchecked)

Parameters

linear_index	Linearized index
cell_index	Cell index (reference)

Definition at line 779 of file QweakSimFieldMap.hh.

{
  // This does not work with unsigned int, because that is always >= 0 and wraps
  for (int dim = fNDim-1; dim >= 0; dim--) {
    cell_index[dim] = linear_index / fExtent[dim];
    linear_index -= cell_index[dim] * fExtent[dim];
  }
}

template<class value_t , unsigned int value_n>

bool QweakSimFieldMap< value_t, value_n >::Check ( const coord_t *  coord ) const

inlineprivate

Check for boundaries with coordinate argument.

Check whether the point is inside the valid region

Parameters

coord

Point coordinates

Returns

True if the coordinates are in the valid region

Definition at line 619 of file QweakSimFieldMap.hh.

References mycout, and myendl.

Referenced by QweakSimFieldMap< value_t, value_n >::GetValue(), QweakSimFieldMap< value_t, value_n >::InBounds(), and QweakSimFieldMap< value_t, value_n >::Set().

{
  for (unsigned int dim = 0; dim < fNDim; dim++) {
    if (fWrap[dim] == 0 && (coord[dim] < fMin[dim] || coord[dim] > fMax[dim])) {
      if (fDebug >= kDebug) {
        mycout << "QweakSimFieldMap::Check(coord_t*): "
               << "coord[" << dim << "] out of bounds "
               << fMin[dim] << "-" << fMax[dim] << "." << myendl;
      }
      return false;
    }
  }
  // Otherwise
  return true;
}

Here is the caller graph for this function:

template<class value_t , unsigned int value_n>

bool QweakSimFieldMap< value_t, value_n >::Check ( const unsigned int *  cell_index ) const

inlineprivate

Check for boundaries with cell index argument.

Check whether the cell index is inside the valid region

Parameters

cell_index

Cell index

Returns

True if the cell index is in the valid region

Definition at line 641 of file QweakSimFieldMap.hh.

References mycout, and myendl.

{
  for (unsigned int dim = 0; dim < fNDim; dim++) {
    if (cell_index[dim] >= fSize[dim]) {
      if (fDebug >= kDebug) {
        mycout << "QweakSimFieldMap::Check(unsigned int*): "
               << "cell index[" << dim << "] " << cell_index[dim] << " larger "
               << "than maximum " << fSize[dim] << "." << myendl;
      }
      return false;
    }
  }
  // Otherwise
  return true;
}

template<class value_t , unsigned int value_n>

bool QweakSimFieldMap< value_t, value_n >::Check ( const unsigned int  linear_index ) const

inlineprivate

Check for boundaries with linearized index argument.

Check whether the linearized index is inside the valid region

Parameters

linear_index

Linearized index

Returns

True if the cell index is in the valid region

Definition at line 663 of file QweakSimFieldMap.hh.

References mycout, and myendl.

{
  if (linear_index >= fMaximumEntries) {
    if (fDebug >= kDebug) {
      mycout << "QweakSimFieldMap::Check(unsigned int): "
             << "linear index " << linear_index << " larger "
             << "than maximum " << fMaximumEntries << "." << myendl;
    }
    return false;
  }
  // Otherwise
  return true;
}

template<class value_t , unsigned int value_n>

void QweakSimFieldMap< value_t, value_n >::Coord ( const unsigned int *  cell_index, coord_t *  coord  ) const

inline

Return the coordinates based on the cell index (unchecked)

Return the coordinates based on the cell index (unchecked)

Parameters

cell_index	Cell index
coord	Point coordinates (reference)

Definition at line 796 of file QweakSimFieldMap.hh.

Referenced by QweakSimFieldMap< value_t, value_n >::PrintCoverage().

{
  for (unsigned int dim = 0; dim < fNDim; dim++)
    coord[dim] = fMin[dim] + cell_index[dim] * fStep[dim];
}

Here is the caller graph for this function:

template<class value_t , unsigned int value_n>

void QweakSimFieldMap< value_t, value_n >::Coord ( const unsigned int  linear_index, coord_t *  coord  ) const

inline

Return the coordinates based on the linearized index (unchecked)

Return the coordinates based on the linearized index (unchecked)

Parameters

linear_index	Linearized index
coord	Point coordinates (reference)

Definition at line 810 of file QweakSimFieldMap.hh.

{
  unsigned int* cell_index = new unsigned int[fNDim];
  Cell(linear_index,cell_index);
  Coord(cell_index,coord);
  delete[] cell_index;
}

template<class value_t = float, unsigned int value_n = 1>

value_t QweakSimFieldMap< value_t, value_n >::Get ( const unsigned int *  cell_index ) const

inlineprivate

Get a single value by cell index (unchecked)

Definition at line 526 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fValues, QweakSimFieldMap< value_t, value_n >::Index(), mycerr, and myendl.

Referenced by QweakSimFieldMap< value_t, value_n >::PrintCoverage().

                                                      {
      if (value_n != 1) {
        mycerr << "QweakSimFieldMap::Get(unsigned int*): "
               << "only valid for one-dimensional fields." << myendl;
        return 0;
      }
      return fValues[0][Index(cell_index)];
    };

Here is the call graph for this function:

Here is the caller graph for this function:

template<class value_t = float, unsigned int value_n = 1>

value_t QweakSimFieldMap< value_t, value_n >::Get ( const unsigned int  index ) const

inlineprivate

Get a single value by linearized index (unchecked)

Definition at line 536 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fValues, mycerr, and myendl.

                                                {
      if (value_n != 1) {
        mycerr << "QweakSimFieldMap::Get(unsigned int): "
               << "only valid for one-dimensional fields." << myendl;
        return 0;
      }
      return fValues[0][index];
    };

template<class value_t = float, unsigned int value_n = 1>

bool QweakSimFieldMap< value_t, value_n >::Get ( const unsigned int  index, value_t *  value  ) const

inlineprivate

Get a vector value by linearized index (unchecked)

Definition at line 545 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fValues.

                                                             {
      for (unsigned int i = 0; i < value_n; i++)
        value[i] = fValues[i][index];
      return true;
    };

template<class value_t = float, unsigned int value_n = 1>

unsigned int QweakSimFieldMap< value_t, value_n >::GetCurrentEntries ( ) const

inline

Get the current number of entries.

Definition at line 172 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fCurrentEntries.

{ return fCurrentEntries; };

template<class value_t = float, unsigned int value_n = 1>

int QweakSimFieldMap< value_t, value_n >::GetDataReductionFactor ( const unsigned int  dim ) const

inline

Get data reduction factor.

Definition at line 186 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fRedux.

      { return fRedux.at(dim); }

template<class value_t = float, unsigned int value_n = 1>

EInterpolationMethod QweakSimFieldMap< value_t, value_n >::GetInterpolationMethod ( ) const

inline

Get the interpolation method.

Definition at line 204 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fInterpolationMethod.

      { return fInterpolationMethod; };

template<class value_t = float, unsigned int value_n = 1>

coord_t QweakSimFieldMap< value_t, value_n >::GetMaximum ( const unsigned int  dim ) const

inline

Get maximum in dimension.

Definition at line 166 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fMax.

{ return fMax.at(dim); };

template<class value_t = float, unsigned int value_n = 1>

unsigned int QweakSimFieldMap< value_t, value_n >::GetMaximumEntries ( ) const

inline

Get the maximum number of entries.

Definition at line 170 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fMaximumEntries.

{ return fMaximumEntries; };

template<class value_t = float, unsigned int value_n = 1>

coord_t QweakSimFieldMap< value_t, value_n >::GetMinimum ( const unsigned int  dim ) const

inline

Get minimum in dimension.

Definition at line 164 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fMin.

{ return fMin.at(dim); };

template<class value_t = float, unsigned int value_n = 1>

coord_t QweakSimFieldMap< value_t, value_n >::GetStepSize ( const unsigned int  dim ) const

inline

Get minimum in dimension.

Definition at line 168 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fStep.

{ return fStep.at(dim); };

template<class value_t = float, unsigned int value_n = 1>

value_t QweakSimFieldMap< value_t, value_n >::GetValue ( const coord_t &  coord ) const

inline

Get the interpolated value at coordinate (zero if out of bounds)

Definition at line 347 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fNDim, mycerr, and myendl.

Referenced by QweakSimFieldMap< value_t, value_n >::GetValue().

                                                 {
      if (value_n != 1) {
        mycerr << "QweakSimFieldMap::GetValue(coord_t&): "
               << "only valid for one-dimensional fields." << myendl;
        return false;
      }
      if (fNDim != 1) {
        mycerr << "QweakSimFieldMap::GetValue(coord_t&): "
               << "only valid for one-dimensional grids." << myendl;
        return false;
      }
      value_t value;
      if (GetValue(&coord, &value)) return value;
      else return 0; // interpolation failed
    };

Here is the caller graph for this function:

template<class value_t = float, unsigned int value_n = 1>

value_t QweakSimFieldMap< value_t, value_n >::GetValue ( const coord_t *  coord ) const

inline

Get the interpolated value at coordinate (zero if out of bounds)

Definition at line 363 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::GetValue(), mycerr, and myendl.

                                                 {
      if (value_n != 1) {
        mycerr << "QweakSimFieldMap::GetValue(coord_t*): "
               << "only valid for one-dimensional fields." << myendl;
        return false;
      }
      value_t value;
      if (GetValue(coord, &value)) return value;
      else return 0; // interpolation failed
    };

Here is the call graph for this function:

template<class value_t = float, unsigned int value_n = 1>

bool QweakSimFieldMap< value_t, value_n >::GetValue ( const coord_t *  coord, double &  value  ) const

inline

Get the interpolated value at coordinate (zero if out of bounds)

Definition at line 374 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::GetValue(), mycerr, and myendl.

                                                             {
      if (value_n != 1) {
        mycerr << "QweakSimFieldMap::GetValue(coord_t*,value_t&): "
               << "only valid for one-dimensional fields." << myendl;
        return false;
      }
      return GetValue(coord, &value);
    };

Here is the call graph for this function:

template<class value_t = float, unsigned int value_n = 1>

bool QweakSimFieldMap< value_t, value_n >::GetValue ( const coord_t *  coord, double *  value  ) const

inline

Get the interpolated value at coordinate (zero if out of bounds)

Definition at line 383 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::Check(), QweakSimFieldMap< value_t, value_n >::fDebug, QweakSimFieldMap< value_t, value_n >::fInterpolationMethod, QweakSimFieldMap< value_t, value_n >::kDebug, kMultiLinear, kNearestNeighbor, QweakSimFieldMap< value_t, value_n >::Linear(), mycerr, myendl, and QweakSimFieldMap< value_t, value_n >::NearestNeighbor().

                                                             {
      for (unsigned int i = 0; i < value_n; i++) value[i] = 0.0; // zero
      if (! Check(coord)) {
        if (fDebug >= kDebug) {
          mycerr << "QweakSimFieldMap::GetValue(coord_t*,value_t*): "
                 << "coordinate is out of boundary." << myendl;
        }
        return false; // out of bounds
      }
      value_t result[value_n]; // we need a local copy of type value_t
      switch (fInterpolationMethod) {
        // return interpolation status
        case kMultiLinear:
          if (! Linear(coord, result)) {
            if (fDebug >= kDebug) {
              mycerr << "QweakSimFieldMap::GetValue(coord_t*,value_t*): "
                     << "linear interpolation failed." << myendl;
            }
            return false;
          }
          break;
        case kNearestNeighbor:
          if (! NearestNeighbor(coord, result)) {
            if (fDebug >= kDebug) {
              mycerr << "QweakSimFieldMap::GetValue(coord_t*,value_t*): "
                     << "nearest-neighbor interpolation failed." << myendl;
            }
            return false;
          }
          break;
        default:
          mycerr << "QweakSimFieldMap::GetValue(coord_t*,value_t*): "
                 << "unknown interpolation method." << myendl;
          return false;
      }
      for (unsigned int i = 0; i < value_n; i++) value[i] = result[i]; // cast
      return true;
    };

Here is the call graph for this function:

template<class value_t = float, unsigned int value_n = 1>

unsigned int QweakSimFieldMap< value_t, value_n >::GetWrapCoordinate ( const unsigned int  dim ) const

inline

Get wrapping coordinate.

Definition at line 175 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fWrap.

      { return fWrap.at(dim); }

template<class value_t = float, unsigned int value_n = 1>

bool QweakSimFieldMap< value_t, value_n >::InBounds ( const coord_t *  coord ) const

inline

Return true if the coordinate is in bounds.

Definition at line 241 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::Check().

                                              {
      return Check(coord);
    };

Here is the call graph for this function:

template<class value_t = float, unsigned int value_n = 1>

unsigned int QweakSimFieldMap< value_t, value_n >::Index ( const coord_t *  coord ) const

inline

Return the linearized index based on the point coordinates (unchecked)

Definition at line 473 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::Cell(), and QweakSimFieldMap< value_t, value_n >::fNDim.

Referenced by QweakSimFieldMap< value_t, value_n >::Get(), and QweakSimFieldMap< value_t, value_n >::Set().

                                                   {
      unsigned int* cell_index = new unsigned int[fNDim];
      Cell(coord, cell_index);
      unsigned int index = Index(cell_index);
      delete[] cell_index;
      return index;
    };

Here is the call graph for this function:

Here is the caller graph for this function:

template<class value_t , unsigned int value_n>

unsigned int QweakSimFieldMap< value_t, value_n >::Index ( const unsigned int *  cell_index ) const

inline

Return the linearized index based on the cell indices (unchecked)

Return the linearized index based on the cell indices (unchecked)

Parameters

cell_index

Index in each dimension

Returns

Linearized index

Definition at line 683 of file QweakSimFieldMap.hh.

{
  unsigned int linear_index = 0;
  // Loop over dimensions
  for (unsigned int dim = 0; dim < fNDim; dim++)
    // ... and use the stored extents for every dimensions
    linear_index += fExtent[dim] * cell_index[dim];
  return linear_index;
}

template<class value_t , unsigned int value_n>

unsigned int QweakSimFieldMap< value_t, value_n >::Index ( const unsigned int *  cell_index, const unsigned int  pattern  ) const

inline

Return the linearized index based on the cell indices and offset (unchecked)

Return the linearized index based on the cell indices and offset (unchecked)

Parameters

cell_index	Index in each dimension
pattern	Bit pattern with offsets in each dimension

Returns

Linearized index

Definition at line 701 of file QweakSimFieldMap.hh.

{
  unsigned int linear_index = 0;
  // Loop over dimensions
  for (unsigned int dim = 0; dim < fNDim; dim++) {
    // Add offset of one based on the bit at position dim
    unsigned int offset = (pattern >> dim) & 0x1;
    linear_index += fExtent[dim] * (cell_index[dim] + offset);
  }
  return linear_index;
}

template<class value_t , unsigned int value_n>

bool QweakSimFieldMap< value_t, value_n >::Linear ( const coord_t *  coord, value_t *  value  ) const

inlineprivate

Linear interpolation (unchecked)

Perform the multi-dimensional linear interpolation (unchecked)

Parameters

coord	Point coordinates
value	Interpolated value (reference)

Definition at line 561 of file QweakSimFieldMap.hh.

References mycout, and myendl.

Referenced by QweakSimFieldMap< value_t, value_n >::GetValue().

{
  // Get cell and local normalized coordinates
  unsigned int* cell_index = new unsigned int[fNDim];
  double* cell_local = new double[fNDim];
  Cell(coord, cell_index, cell_local);
  // Initialize to zero
  for (unsigned int i = 0; i < value_n; i++) value[i] = 0.0;
  // Calculate the interpolated value
  // by summing the 2^fNDim = 1 << fNDim neighbor points (1U is unsigned one)
  for (unsigned int offset = 0; offset < (1U << fNDim); offset++) {
    value_t neighbor[value_n];
    if (! Get(Index(cell_index,offset), neighbor)) {
      if (fDebug >= kDebug) {
        mycout << "QweakSimFieldMap::Linear(coord_t*,value_t*): "
               << "neighbor " << offset << " could not be found " << myendl;
      }
      return false;
    }
    // ... with appropriate weighting factors (1 - cell_local or cell_local)
    double fac = 1.0;
    for (unsigned int dim = 0; dim < fNDim; dim++)
      fac *= ((offset >> dim) & 0x1)? cell_local[dim] : (1 - cell_local[dim]);
    // ... for all vector components
    for (unsigned int i = 0; i < value_n; i++)
      value[i] += fac * neighbor[i];
  }
  delete[] cell_index;
  delete[] cell_local;
  return true;
}

Here is the caller graph for this function:

template<class value_t = float, unsigned int value_n = 1>

void QweakSimFieldMap< value_t, value_n >::Nearest ( const coord_t *  coord, unsigned int *  cell_index  ) const

inlineprivate

Return the cell index closest to the coordinate (could be above) (unchecked)

Definition at line 504 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::Cell(), and QweakSimFieldMap< value_t, value_n >::fNDim.

Referenced by QweakSimFieldMap< value_t, value_n >::Set().

                                                                       {
      double* cell_local = new double[fNDim];
      Cell(coord, cell_index, cell_local);
      // Loop over all dimensions and add one if larger than 0.5
      for (unsigned int dim = 0; dim < fNDim; dim++)
        if (cell_local[dim] > 0.5) cell_index[dim]++;
      delete[] cell_local;
    };

Here is the call graph for this function:

Here is the caller graph for this function:

template<class value_t , unsigned int value_n>

bool QweakSimFieldMap< value_t, value_n >::NearestNeighbor ( const coord_t *  coord, value_t *  value  ) const

inlineprivate

Nearest-neighbor (unchecked)

Perform the nearest-neighbor interpolation (unchecked)

Parameters

coord	Point coordinates
value	Interpolated value (reference)

Definition at line 601 of file QweakSimFieldMap.hh.

Referenced by QweakSimFieldMap< value_t, value_n >::GetValue().

{
  // Get nearest cell
  unsigned int* cell_index = new unsigned int[fNDim];
  Nearest(coord, cell_index);
  bool status = Get(Index(cell_index), value);
  delete[] cell_index;
  return status;
}

Here is the caller graph for this function:

template<class value_t = float, unsigned int value_n = 1>

void QweakSimFieldMap< value_t, value_n >::PrintCoverage ( const unsigned int  dim )

inline

Print coverage map for all bins in one dimension.

Definition at line 209 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::Cell(), QweakSimFieldMap< value_t, value_n >::Coord(), QweakSimFieldMap< value_t, value_n >::fMaximumEntries, QweakSimFieldMap< value_t, value_n >::fNDim, QweakSimFieldMap< value_t, value_n >::fSize, QweakSimFieldMap< value_t, value_n >::Get(), mycout, and myendl.

                                               {
      // Initialize coverage
      unsigned int* cover = new unsigned int[fSize[dim]];
      unsigned int* total = new unsigned int[fSize[dim]];
      for (unsigned int i = 0; i < fSize[dim]; i++) {
        cover[i] = 0;
        total[i] = 0;
      }
      // Loop over all entries
      value_t value[value_n];
      unsigned int* cell_index = new unsigned int[fNDim];
      for (unsigned int linear_index = 0; linear_index < fMaximumEntries; linear_index++) {
        Cell(linear_index,cell_index);
        total[cell_index[dim]]++;
        if (Get(linear_index,value) && value[0] != 0)
          cover[cell_index[dim]]++; // non-zero field
      }
      // Print coverage
      coord_t* coord = new coord_t[fNDim];
      for (size_t i = 0; i < fSize[dim]; i++) {
        cell_index[dim] = i;
        Coord(cell_index,coord);
        mycout << "bin " << i << ", coord " << coord[dim] << ": "
            << double(cover[i]) / double(total[i]) * 100 << "%"<< myendl;
      }
      delete[] cell_index;
      delete[] coord;
      delete[] cover;
      delete[] total;
    }

Here is the call graph for this function:

template<class value_t , unsigned int value_n>

bool QweakSimFieldMap< value_t, value_n >::ReadBinaryFile ( const std::string &  filename )

inline

Read the grid values from binary file.

Read the grid values from binary file (should be 64-bit safe, untested)

Parameters

filename

File name

Returns

True if read successfully

Definition at line 967 of file QweakSimFieldMap.hh.

References mycerr, mycout, and myendl.

Referenced by QweakSimFieldMap< value_t, value_n >::QweakSimFieldMap().

{
  std::ifstream file(filename.c_str(), std::ios::binary);
  if (! file.is_open()) {
    mycerr << "QweakSimFieldMap::ReadBinaryFile(string&): "
           << "unable to open file " << filename << "." << myendl;
    return false;
  }
  // Informational message
  mycout << "Reading binary file: ";
  // Go to end and store length (could also use std::ios::ate)
  file.seekg(0, std::ios::end);
  // Go to begin and start reading template parameters
  file.seekg(0, std::ios::beg);
  uint32_t n, size;
  file.read(reinterpret_cast<char*>(&n), sizeof(n));
  file.read(reinterpret_cast<char*>(&size), sizeof(size));
  if (n != value_n) {
    mycerr << "QweakSimFieldMap::ReadBinaryFile(string&): "
           << "incompatible field dimension in stream." << myendl;
    return false;
  }
  if (size != sizeof(value_t)) {
    mycerr << "QweakSimFieldMap::ReadBinaryFile(string&): "
           << "incompatible precision of field values.." << myendl;
    return false;
  }
  // Read grid parameters
  uint32_t ndim;
  file.read(reinterpret_cast<char*>(&ndim), sizeof(ndim));
  SetDimensions(ndim);
  // Read sizes
  for (unsigned int dim = 0; dim < fNDim; dim++) {
    file.read(reinterpret_cast<char*>(&fMin[dim]),sizeof(fMin[dim]));
    file.read(reinterpret_cast<char*>(&fMax[dim]),sizeof(fMax[dim]));
    file.read(reinterpret_cast<char*>(&fStep[dim]),sizeof(fStep[dim]));
  }
  SetMinimumMaximumStep(fMin, fMax, fStep); // calculates fMaximumEntries
  // Read values
  uint32_t maximum_entries;
  file.read(reinterpret_cast<char*>(&maximum_entries),sizeof(maximum_entries));
  if (maximum_entries != fMaximumEntries) {
    mycerr << "QweakSimFieldMap::ReadBinaryFile(string&): "
           << "expected number of entries." << myendl;
    return false;
  }
  int value_size = sizeof(value_t);
  unsigned int entries = fValues[0].size();
  for (unsigned int index = 0; index < entries; index++) {
    // Read values
    for (unsigned int i = 0; i < value_n; i++) {
      file.read((char*)(&fValues[i][index]),value_size);
    }
    // Progress bar
    if (index % (entries / 10) == 0)
      mycout << index / (entries / 100) << "%" << std::flush;
    if (index % (entries / 10) != 0
     && index % (entries / 40) == 0)
      mycout << "." << std::flush;
  }
  mycout << myendl;
  file.close();
  return true;
}

Here is the caller graph for this function:

template<class value_t , unsigned int value_n>

bool QweakSimFieldMap< value_t, value_n >::ReadText ( std::istream &  stream )

inline

Read the grid from text.

Read the grid values from a text stream

Parameters

stream

Input stream

Returns

True if successfully read all values

Definition at line 861 of file QweakSimFieldMap.hh.

References mycerr, mycout, and myendl.

Referenced by QweakSimFieldMap< value_t, value_n >::ReadTextFile().

{
  // Informational message
  mycout << "Reading text stream: ";
  // Read the dimensions
  unsigned int n;
  stream >> fNDim >> n;
  if (n != value_n) {
    mycerr << "QweakSimFieldMap::ReadText(istream&): "
           << "incompatible field dimension in stream." << myendl;
    return false;
  }
  SetDimensions(fNDim);
  // Read the grid parameters
  for (unsigned int dim = 0; dim < fNDim; dim++)
    stream >> dim >> fMin[dim] >> fMax[dim] >> fStep[dim];
  SetMinimumMaximumStep(fMin, fMax, fStep);
  // Read the grid values
  unsigned int entries;
  stream >> entries;
  for (unsigned int index = 0; index < entries; index++) {
    // Read values
    for (unsigned int i = 0; i < value_n; i++) {
      stream >> fValues[i][index];
    }
    // Progress bar
    if (index % (entries / 10) == 0)
      mycout << index / (entries / 100) << "%" << std::flush;
    if (index % (entries / 10) != 0
     && index % (entries / 40) == 0)
      mycout << "." << std::flush;
  }
  // Check for end of file
  std::string end;
  stream >> end;
  // Informational message
  mycout << myendl;
  if (end == "end") return true;
  else {
    mycerr << "QweakSimFieldMap::ReadText(istream&): "
           << "stream did not end with keyword 'end'." << myendl;
    return false;
  }
}

Here is the caller graph for this function:

template<class value_t = float, unsigned int value_n = 1>

bool QweakSimFieldMap< value_t, value_n >::ReadTextFile ( const std::string &  filename )

inline

Read the grid from text file.

Definition at line 448 of file QweakSimFieldMap.hh.

References mycerr, myendl, and QweakSimFieldMap< value_t, value_n >::ReadText().

                                                 {
      std::ifstream file(filename.c_str());
      if (! file.is_open()) {
        mycerr << "QweakSimFieldMap::ReadTextFile(string&): "
               << "unable to open file " << filename << "." << myendl;
        return false;
      }
      if (! ReadText(file)) {
        mycerr << "QweakSimFieldMap::ReadTextFile(string&): "
               << "unable to read text stream." << myendl;
        return false;
      }
      file.close();
      return true;
    };

Here is the call graph for this function:

template<class value_t = float, unsigned int value_n = 1>

bool QweakSimFieldMap< value_t, value_n >::Set ( const coord_t &  coord, const value_t &  value  )

inline

Set a single value at a coordinate (false if not possible)

Definition at line 249 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fNDim, mycerr, and myendl.

Referenced by QweakSimFieldMap< value_t, value_n >::Set().

                                                         {
      if (value_n != 1) {
        mycerr << "QweakSimFieldMap::Set(coord_t&,value_t&): "
               << "only valid for one-dimensional values." << myendl;
        return false;
      }
      if (fNDim != 1) {
        mycerr << "QweakSimFieldMap::Set(coord_t&,value_t&): "
               << "only valid for one-dimensional grids." << myendl;
        return false;
      }
      return Set(&coord, &value);
    };

Here is the caller graph for this function:

template<class value_t = float, unsigned int value_n = 1>

bool QweakSimFieldMap< value_t, value_n >::Set ( const coord_t *  coord, const value_t &  value  )

inline

Set a single value at a coordinate (false if not possible)

Definition at line 263 of file QweakSimFieldMap.hh.

References mycerr, myendl, and QweakSimFieldMap< value_t, value_n >::Set().

                                                         {
      if (value_n != 1) {
        mycerr << "QweakSimFieldMap::Set(coord_t*,value_t&): "
               << "only valid for one-dimensional values." << myendl;
        return false;
      }
      return Set(coord, &value);
    };

Here is the call graph for this function:

template<class value_t = float, unsigned int value_n = 1>

bool QweakSimFieldMap< value_t, value_n >::Set ( const coord_t *  coord, const value_t *  value  )

inline

Set a set of values at a coordinate (false if not possible)

Definition at line 272 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::Check(), QweakSimFieldMap< value_t, value_n >::fNDim, QweakSimFieldMap< value_t, value_n >::fSize, QweakSimFieldMap< value_t, value_n >::fWrap, QweakSimFieldMap< value_t, value_n >::Index(), QweakSimFieldMap< value_t, value_n >::Nearest(), and QweakSimFieldMap< value_t, value_n >::Set().

                                                         {
      unsigned int* cell_index = new unsigned int[fNDim];
      Nearest(coord, cell_index); // nearest cell
      if (! Check(cell_index)) return false; // out of bounds
      bool status = true;
      bool written = false;
      unsigned int linear_index;
      for (unsigned int dim = 0; dim < fNDim; dim++) {
        // skip dimensions that are not wrapped around
        if (fWrap[dim] == 0) continue;
        // FIXME only one wrapping coordinate correctly supported in Set()
        if ((cell_index[dim] < fWrap[dim]) ||
            (fSize[dim] - cell_index[dim] - 1 < fWrap[dim])) {
          // there are equivalent grid points
          for (size_t wrap = 0; wrap < fWrap[dim]; wrap++) {
            // at the minimum
            cell_index[dim] = wrap;
            linear_index = Index(cell_index);
            status &= Set(linear_index, value);
            // at the maximum
            cell_index[dim] = fSize[dim] - wrap - 1;
            linear_index = Index(cell_index);
            status &= Set(linear_index, value);
            // set flag
            written = true;
          }
        }
      }
      if (not written) {
        // this is an unambiguous grid point
        linear_index = Index(cell_index);
        status &= Set(linear_index, value);
      }
      delete[] cell_index;
      return status;
    };

Here is the call graph for this function:

template<class value_t = float, unsigned int value_n = 1>

bool QweakSimFieldMap< value_t, value_n >::Set ( const unsigned int  linear_index, const value_t &  value  )

inline

Set a single value at a linearized index (false if not possible)

Definition at line 310 of file QweakSimFieldMap.hh.

References mycerr, myendl, and QweakSimFieldMap< value_t, value_n >::Set().

                                                                    {
      if (value_n != 1) {
        mycerr << "QweakSimFieldMap::Set(unsigned int,value_t&): "
               << "only valid for one-dimensional values." << myendl;
        return false;
      }
      return Set(linear_index, &value);
    };

Here is the call graph for this function:

template<class value_t = float, unsigned int value_n = 1>

bool QweakSimFieldMap< value_t, value_n >::Set ( const unsigned int  linear_index, const value_t *  value  )

inline

Set a set of values at a linearized index (false if not possible)

Definition at line 319 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::Check(), QweakSimFieldMap< value_t, value_n >::fCurrentEntries, and QweakSimFieldMap< value_t, value_n >::fValues.

                                                                    {
      if (! Check(linear_index)) return false; // out of bounds
      for (unsigned int i = 0; i < value_n; i++)
        fValues[i][linear_index] = value[i];
      fCurrentEntries++;
      return true;
    };

Here is the call graph for this function:

template<class value_t = float, unsigned int value_n = 1>

bool QweakSimFieldMap< value_t, value_n >::Set ( const unsigned int *  cell_index, const value_t &  value  )

inline

Set a single value at a grid point (false if out of bounds)

Definition at line 328 of file QweakSimFieldMap.hh.

References mycerr, myendl, and QweakSimFieldMap< value_t, value_n >::Set().

                                                                   {
      if (value_n != 1) {
        mycerr << "QweakSimFieldMap::Set(unsigned int*,value_t&): "
               << "only valid for one-dimensional values." << myendl;
        return false;
      }
      return Set(cell_index, &value);
    };

Here is the call graph for this function:

template<class value_t = float, unsigned int value_n = 1>

bool QweakSimFieldMap< value_t, value_n >::Set ( const unsigned int *  cell_index, const value_t *  value  )

inline

Set a set of values at a grid point (false if out of bounds)

Definition at line 337 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::Check(), QweakSimFieldMap< value_t, value_n >::Index(), and QweakSimFieldMap< value_t, value_n >::Set().

                                                                   {
      if (! Check(cell_index)) return false; // out of bounds
      return Set(Index(cell_index),value);
    };

Here is the call graph for this function:

template<class value_t = float, unsigned int value_n = 1>

void QweakSimFieldMap< value_t, value_n >::SetDataReductionFactor ( const unsigned int  dim, const unsigned int  redux  )

inline

Set data reduction factor.

Definition at line 189 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fRedux.

Referenced by QweakSimFieldMap< value_t, value_n >::SetDataReductionFactor().

      { fRedux.at(dim) = redux; }

Here is the caller graph for this function:

template<class value_t = float, unsigned int value_n = 1>

void QweakSimFieldMap< value_t, value_n >::SetDataReductionFactor ( const unsigned int  redux )

inline

Definition at line 191 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fNDim, and QweakSimFieldMap< value_t, value_n >::SetDataReductionFactor().

                                                          {
      for (unsigned int dim = 0; dim < fNDim; dim++)
        SetDataReductionFactor(dim,redux);
    }

Here is the call graph for this function:

template<class value_t = float, unsigned int value_n = 1>

void QweakSimFieldMap< value_t, value_n >::SetDataReductionFactor ( const std::vector< unsigned int > &  redux )

inline

Definition at line 195 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fNDim, and QweakSimFieldMap< value_t, value_n >::fRedux.

                                                                      {
      if (redux.size() != fNDim) return;
      fRedux = redux;
    }

template<class value_t = float, unsigned int value_n = 1>

void QweakSimFieldMap< value_t, value_n >::SetDebugLevel ( debug_t  debug )

inline

Set debug level.

Definition at line 81 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fDebug.

{ fDebug = debug; };

template<class value_t = float, unsigned int value_n = 1>

void QweakSimFieldMap< value_t, value_n >::SetDimensions ( const unsigned int  ndim )

inline

Set the number of coordinate dimensions and resize vectors.

Definition at line 120 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fExtent, QweakSimFieldMap< value_t, value_n >::fMax, QweakSimFieldMap< value_t, value_n >::fMin, QweakSimFieldMap< value_t, value_n >::fNDim, QweakSimFieldMap< value_t, value_n >::fSize, QweakSimFieldMap< value_t, value_n >::fStep, QweakSimFieldMap< value_t, value_n >::fWrap, mycerr, and myendl.

Referenced by QweakSimFieldMap< value_t, value_n >::QweakSimFieldMap(), and QweakSimFieldMap< value_t, value_n >::SetMinimumMaximumStep().

                                                {
      if (ndim == 0) {
        mycerr << "QweakSimFieldMap::SetDimensions: "
               << "Dimensions of the grid should be strictly positive!" << myendl;
        return;
      }
      fNDim = ndim;
      fMin.resize(fNDim); fMax.resize(fNDim); fStep.resize(fNDim); fWrap.resize(fNDim);
      fSize.resize(fNDim); fExtent.resize(fNDim+1);
    };

Here is the caller graph for this function:

template<class value_t = float, unsigned int value_n = 1>

void QweakSimFieldMap< value_t, value_n >::SetInterpolationMethod ( const EInterpolationMethod  method )

inline

Set the interpolation method.

Definition at line 201 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fInterpolationMethod.

Referenced by QweakSimFieldMap< value_t, value_n >::QweakSimFieldMap().

      { fInterpolationMethod = method; };

Here is the caller graph for this function:

template<class value_t = float, unsigned int value_n = 1>

void QweakSimFieldMap< value_t, value_n >::SetMinimumMaximumStep ( const coord_t  min, const coord_t  max, const coord_t  step  )

inline

Set minimum, maximum, and step size to single values.

Definition at line 131 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fNDim.

Referenced by QweakSimFieldMap< value_t, value_n >::QweakSimFieldMap().

                                                                                         {
      SetMinimumMaximumStep(std::vector<coord_t>(fNDim,min),
          std::vector<coord_t>(fNDim,max),
          std::vector<coord_t>(fNDim,step));
    };

Here is the caller graph for this function:

template<class value_t = float, unsigned int value_n = 1>

void QweakSimFieldMap< value_t, value_n >::SetMinimumMaximumStep ( const std::vector< coord_t > &  min, const std::vector< coord_t > &  max, const std::vector< coord_t > &  step  )

inline

Set minimum, maximum, and step size to different values.

Definition at line 137 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fCurrentEntries, QweakSimFieldMap< value_t, value_n >::fExtent, QweakSimFieldMap< value_t, value_n >::fMax, QweakSimFieldMap< value_t, value_n >::fMaximumEntries, QweakSimFieldMap< value_t, value_n >::fMin, QweakSimFieldMap< value_t, value_n >::fNDim, QweakSimFieldMap< value_t, value_n >::fSize, QweakSimFieldMap< value_t, value_n >::fStep, QweakSimFieldMap< value_t, value_n >::fValues, mycerr, myendl, and QweakSimFieldMap< value_t, value_n >::SetDimensions().

                                        {
      // Set the dimensionality
      if (min.size() != fNDim) SetDimensions(min.size());
      // Check the dimensionality and assign boundaries and step size vectors
      if (min.size() != fNDim || min.size() != fNDim || step.size() != fNDim) return;
      fMin = min; fMax = max; fStep = step;
      fExtent[0] = 1;
      for (size_t i = 0; i < fMin.size(); i++) {
        coord_t int_part; // safer to use modf than a direct static cast
        coord_t frac_part = modf((fMax[i] - fMin[i]) / fStep[i] + 1.0, &int_part);
        fSize[i] = static_cast<unsigned int>(int_part) + (frac_part > 0.5 ? 1 : 0);
        fExtent[i+1] = fExtent[i] * fSize[i];
      }
      // Try resizing to allocate memory and initialize with zeroes
      fMaximumEntries = fExtent[fNDim]; fCurrentEntries = 0; // no entries read yet
      for (unsigned int i = 0; i < value_n; i++) {
        try {
          fValues[i].resize(fMaximumEntries,0);
        } catch (std::bad_alloc) {
          mycerr << "QweakSimFieldMap:SetMinimumMaximumStep: "
                 << "could not allocate memory for values!" << myendl;
        }
      }
    };

Here is the call graph for this function:

template<class value_t = float, unsigned int value_n = 1>

void QweakSimFieldMap< value_t, value_n >::SetWrapCoordinate ( const unsigned int  dim, const size_t  wrap = 1  )

inline

Set wrapping coordinate.

Definition at line 178 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fWrap.

      { fWrap.at(dim) = wrap; }

template<class value_t = float, unsigned int value_n = 1>

void QweakSimFieldMap< value_t, value_n >::SetWrapCoordinate ( const std::vector< size_t > &  wrap )

inline

Definition at line 180 of file QweakSimFieldMap.hh.

References QweakSimFieldMap< value_t, value_n >::fNDim, and QweakSimFieldMap< value_t, value_n >::fWrap.

                                                          {
      if (wrap.size() != fNDim) return;
      fWrap = wrap;
    }

template<class value_t , unsigned int value_n>

bool QweakSimFieldMap< value_t, value_n >::WriteBinaryFile ( const std::string &  filename ) const

inline

Write the grid values to binary file.

Write the grid values to binary file (should be 64-bit safe, untested)

Integer data types can be stored differently on 32-bit and 64-bit systems. Fixed-length types uint32_t and u_int32_t are provided in stdint.h and sys/types.h, respectively. The floating point types float and double will always have a length of 32 and 64 bit, per the IEEE convention.

Parameters

filename

File name

Returns

True if written successfully

Definition at line 918 of file QweakSimFieldMap.hh.

References mycerr, mycout, and myendl.

{
  std::ofstream file(filename.c_str(), std::ios::binary);
  if (! file.is_open()) {
    mycerr << "QweakSimFieldMap::WriteBinaryFile(string&): "
           << "unable to open file " << filename << "." << myendl;
    return false;
  }
  // Informational message
  mycout << "Writing binary file: ";
  // Write template parameters
  uint32_t n = value_n; // uint32_t has length of 32 bits on any system
  uint32_t size = sizeof(value_t);
  file.write(reinterpret_cast<const char*>(&n), sizeof(n));
  file.write(reinterpret_cast<const char*>(&size), sizeof(size));
  // Write grid parameters
  uint32_t ndim = fNDim;
  file.write(reinterpret_cast<const char*>(&ndim), sizeof(ndim));
  for (unsigned int dim = 0; dim < fNDim; dim++) {
    file.write(reinterpret_cast<const char*>(&fMin[dim]),sizeof(fMin[dim]));
    file.write(reinterpret_cast<const char*>(&fMax[dim]),sizeof(fMax[dim]));
    file.write(reinterpret_cast<const char*>(&fStep[dim]),sizeof(fStep[dim]));
  }
  uint32_t entries = fValues[0].size();
  file.write(reinterpret_cast<const char*>(&entries),sizeof(entries));
  for (unsigned int index = 0; index < entries; index++) {
    // Write values
    for (unsigned int i = 0; i < value_n; i++) {
      value_t value = fValues[i][index];
      file.write(reinterpret_cast<const char*>(&value),sizeof(value));
    }
    // Progress bar
    if (index % (entries / 10) == 0)
      mycout << index / (entries / 100) << "%" << std::flush;
    if (index % (entries / 10) != 0
     && index % (entries / 40) == 0)
      mycout << "." << std::flush;
  }
  mycout << myendl;
  file.close();
  return true;
}

template<class value_t , unsigned int value_n>

bool QweakSimFieldMap< value_t, value_n >::WriteText ( std::ostream &  stream ) const

inline

Write the grid as text.

Write the grid values to a text stream

Parameters

stream

Output stream

Definition at line 825 of file QweakSimFieldMap.hh.

References mycout, and myendl.

Referenced by QweakSimFieldMap< value_t, value_n >::WriteTextFile(), and QweakSimFieldMap< value_t, value_n >::WriteTextScreen().

{
  // Informational message
  mycout << "Writing text stream: ";
  // Write the dimensions
  stream << fNDim << "\t" << value_n << std::endl;
  // Write the grid parameters
  for (unsigned int dim = 0; dim < fNDim; dim++)
    stream << dim << "\t" << fMin[dim] << "\t" << fMax[dim] << "\t" << fStep[dim] << std::endl;
  // Write the values
  stream << fValues[0].size() << std::endl;
  unsigned int entries = fValues[0].size();
  for (unsigned int index = 0; index < entries; index++) {
    // Write values
    for (unsigned int i = 0; i < value_n; i++) {
      stream << fValues[i][index] << "\t";
    }
    stream << std::endl;
    // Progress bar
    if (index % (entries / 10) == 0)
      mycout << index / (entries / 100) << "%" << std::flush;
    if (index % (entries / 10) != 0
     && index % (entries / 40) == 0)
      mycout << "." << std::flush;
  }
  stream << "end" << std::endl;
  mycout << myendl;
  return true;
}

Here is the caller graph for this function:

template<class value_t = float, unsigned int value_n = 1>

bool QweakSimFieldMap< value_t, value_n >::WriteTextFile ( const std::string &  filename ) const

inline

Write the grid to text file.

Definition at line 429 of file QweakSimFieldMap.hh.

References mycerr, myendl, and QweakSimFieldMap< value_t, value_n >::WriteText().

                                                        {
      std::ofstream file(filename.c_str());
      if (! file.is_open()) {
        mycerr << "QweakSimFieldMap::WriteTextFile(string&): "
               << "unable to open file " << filename << "." << myendl;
        return false;
      }
      WriteText(file);
      file.close();
      return true;
    };

Here is the call graph for this function:

template<class value_t = float, unsigned int value_n = 1>

bool QweakSimFieldMap< value_t, value_n >::WriteTextScreen ( ) const

inline

Write the grid to screen.

Definition at line 441 of file QweakSimFieldMap.hh.

References mycout, and QweakSimFieldMap< value_t, value_n >::WriteText().

                                 {
      WriteText(mycout);
      return true;
    };

Here is the call graph for this function:

Field Documentation

template<class value_t = float, unsigned int value_n = 1>

unsigned int QweakSimFieldMap< value_t, value_n >::fCurrentEntries

private

Number of values read in.

Definition at line 110 of file QweakSimFieldMap.hh.

Referenced by QweakSimFieldMap< value_t, value_n >::GetCurrentEntries(), QweakSimFieldMap< value_t, value_n >::Set(), and QweakSimFieldMap< value_t, value_n >::SetMinimumMaximumStep().

template<class value_t = float, unsigned int value_n = 1>

enum QweakSimFieldMap::debug_t QweakSimFieldMap< value_t, value_n >::fDebug

Referenced by QweakSimFieldMap< value_t, value_n >::GetValue(), and QweakSimFieldMap< value_t, value_n >::SetDebugLevel().

template<class value_t = float, unsigned int value_n = 1>

std::vector<size_t> QweakSimFieldMap< value_t, value_n >::fExtent

private

Linear extent between neighbor points in each dimension (e.g. for the least significant index this will be 1, for the next index the number of points in the first index, etc...)

Definition at line 104 of file QweakSimFieldMap.hh.

Referenced by QweakSimFieldMap< value_t, value_n >::SetDimensions(), and QweakSimFieldMap< value_t, value_n >::SetMinimumMaximumStep().

template<class value_t = float, unsigned int value_n = 1>

EInterpolationMethod QweakSimFieldMap< value_t, value_n >::fInterpolationMethod

private

Interpolation method.

Definition at line 115 of file QweakSimFieldMap.hh.

Referenced by QweakSimFieldMap< value_t, value_n >::GetInterpolationMethod(), QweakSimFieldMap< value_t, value_n >::GetValue(), and QweakSimFieldMap< value_t, value_n >::SetInterpolationMethod().

template<class value_t = float, unsigned int value_n = 1>

std::vector<coord_t> QweakSimFieldMap< value_t, value_n >::fMax

private

Maximum in each dimension.

Definition at line 91 of file QweakSimFieldMap.hh.

Referenced by QweakSimFieldMap< value_t, value_n >::GetMaximum(), QweakSimFieldMap< value_t, value_n >::SetDimensions(), and QweakSimFieldMap< value_t, value_n >::SetMinimumMaximumStep().

template<class value_t = float, unsigned int value_n = 1>

unsigned int QweakSimFieldMap< value_t, value_n >::fMaximumEntries

private

Maximum number of values.

Definition at line 112 of file QweakSimFieldMap.hh.

Referenced by QweakSimFieldMap< value_t, value_n >::GetMaximumEntries(), QweakSimFieldMap< value_t, value_n >::PrintCoverage(), and QweakSimFieldMap< value_t, value_n >::SetMinimumMaximumStep().

template<class value_t = float, unsigned int value_n = 1>

std::vector<coord_t> QweakSimFieldMap< value_t, value_n >::fMin

private

Minimum in each dimension.

Definition at line 89 of file QweakSimFieldMap.hh.

Referenced by QweakSimFieldMap< value_t, value_n >::GetMinimum(), QweakSimFieldMap< value_t, value_n >::SetDimensions(), and QweakSimFieldMap< value_t, value_n >::SetMinimumMaximumStep().

template<class value_t = float, unsigned int value_n = 1>

unsigned int QweakSimFieldMap< value_t, value_n >::fNDim

private

Number of dimensions in coordinates.

Definition at line 81 of file QweakSimFieldMap.hh.

Referenced by QweakSimFieldMap< value_t, value_n >::GetValue(), QweakSimFieldMap< value_t, value_n >::Index(), QweakSimFieldMap< value_t, value_n >::Nearest(), QweakSimFieldMap< value_t, value_n >::PrintCoverage(), QweakSimFieldMap< value_t, value_n >::Set(), QweakSimFieldMap< value_t, value_n >::SetDataReductionFactor(), QweakSimFieldMap< value_t, value_n >::SetDimensions(), QweakSimFieldMap< value_t, value_n >::SetMinimumMaximumStep(), and QweakSimFieldMap< value_t, value_n >::SetWrapCoordinate().

template<class value_t = float, unsigned int value_n = 1>

std::vector<size_t> QweakSimFieldMap< value_t, value_n >::fRedux

private

Data reduction factor.

Definition at line 99 of file QweakSimFieldMap.hh.

Referenced by QweakSimFieldMap< value_t, value_n >::GetDataReductionFactor(), and QweakSimFieldMap< value_t, value_n >::SetDataReductionFactor().

template<class value_t = float, unsigned int value_n = 1>

std::vector<size_t> QweakSimFieldMap< value_t, value_n >::fSize

private

Number of points in each dimension.

Definition at line 95 of file QweakSimFieldMap.hh.

Referenced by QweakSimFieldMap< value_t, value_n >::PrintCoverage(), QweakSimFieldMap< value_t, value_n >::Set(), QweakSimFieldMap< value_t, value_n >::SetDimensions(), and QweakSimFieldMap< value_t, value_n >::SetMinimumMaximumStep().

template<class value_t = float, unsigned int value_n = 1>

std::vector<coord_t> QweakSimFieldMap< value_t, value_n >::fStep

private

Step size in each dimension.

Definition at line 93 of file QweakSimFieldMap.hh.

Referenced by QweakSimFieldMap< value_t, value_n >::GetStepSize(), QweakSimFieldMap< value_t, value_n >::SetDimensions(), and QweakSimFieldMap< value_t, value_n >::SetMinimumMaximumStep().

template<class value_t = float, unsigned int value_n = 1>

std::vector<value_t> QweakSimFieldMap< value_t, value_n >::fValues[value_n]

private

Table with pointers to arrays of values.

Definition at line 107 of file QweakSimFieldMap.hh.

Referenced by QweakSimFieldMap< value_t, value_n >::Get(), QweakSimFieldMap< value_t, value_n >::Set(), and QweakSimFieldMap< value_t, value_n >::SetMinimumMaximumStep().

template<class value_t = float, unsigned int value_n = 1>

std::vector<size_t> QweakSimFieldMap< value_t, value_n >::fWrap

private

Wrap around this coordinate.

Definition at line 97 of file QweakSimFieldMap.hh.

Referenced by QweakSimFieldMap< value_t, value_n >::GetWrapCoordinate(), QweakSimFieldMap< value_t, value_n >::Set(), QweakSimFieldMap< value_t, value_n >::SetDimensions(), and QweakSimFieldMap< value_t, value_n >::SetWrapCoordinate().

---

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

• QweakSimFieldMap.hh