/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkArrayInterpolate.h
  
-------------------------------------------------------------------------
  Copyright 2008 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/

#ifndef __vtkArrayInterpolate_h
#define __vtkArrayInterpolate_h

#include "vtkTypedArray.h"

class vtkArraySlice;
class vtkArraySlices;
class vtkArrayWeights;

// .SECTION Thanks
// Developed by Timothy M. Shead (tshead@sandia.gov) at Sandia National Laboratories.

// Description:
// Computes the weighted sum of a collection of slices from a source
// array, and stores the results in a slice of a target array.  Note that
// the number of source slices and weights must match, and the extents of
// each source slice must match the extents of the target slice.
//
// Note: The implementation assumes that operator*(T, double) is defined,
// and that there is an implicit conversion from its result back to T.
// 
// If you need to interpolate arrays of T other than double, you will
// likely want to create your own specialization of this function.
//
// The implementation should produce correct results for dense and sparse
// arrays, but may perform poorly on sparse.

template<typename T>
void vtkInterpolate(
  vtkTypedArray<T>* source_array,
  const vtkArraySlices& source_slices,
  const vtkArrayWeights& source_weights,
  const vtkArraySlice& target_slice,
  vtkTypedArray<T>* target_array);

#include "vtkArrayInterpolate.txx"

#endif

