www.mooseframework.org
ImageFunction.h
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 #ifndef IMAGEFUNCTION_H
16 #define IMAGEFUNCTION_H
17 
18 // MOOSE includes
19 #include "Function.h"
20 #include "ImageSampler.h"
21 
22 // Forward declarations
23 class ImageFunction;
24 
25 template <>
27 
31 class ImageFunction : public ImageSampler, public Function
32 {
33 public:
39 
43  virtual ~ImageFunction();
44 
48  virtual void initialSetup() override;
49 
55  virtual Real value(Real t, const Point & p) override;
56 };
57 
58 #endif // IMAGEFUNCTION_H
virtual void initialSetup() override
Initialize the ImageSampler.
Definition: ImageFunction.C:37
Base class for function objects.
Definition: Function.h:46
A function for extracting data from an image or stack of images.
Definition: ImageFunction.h:31
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
ImageFunction(const InputParameters &parameters)
Class constructor.
Definition: ImageFunction.C:29
A helper class for reading and sampling images using VTK.
Definition: ImageSampler.h:57
virtual Real value(Real t, const Point &p) override
Return the pixel value for the given point.
Definition: ImageFunction.C:45
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:53
virtual ~ImageFunction()
Class destructor.
Definition: ImageFunction.C:34
InputParameters validParams< ImageFunction >()
Definition: ImageFunction.C:20