ImageSampler.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

// MOOSE includes
#include "FileRangeBuilder.h"
#include "ConsoleStream.h"

#include "libmesh/bounding_box.h"
#include <array>

// VTK includes
#ifdef LIBMESH_HAVE_VTK

// Some VTK header files have extra semi-colons in them, and clang
// loves to warn about it...
#include "libmesh/ignore_warnings.h"

// If VTK is built without an external nlohmann, then it assumes it
// will never be compiled against another nlohmann, and it includes
// its own copy but modified with macro tricks.  We have probably
// already included nlohmann headers, which we didn't tamper with
// because OF COURSE NOT, but now we need to take care not to let the
// include guards prevent them from including their copy with their
// different namespace.
#ifndef MOOSE_VTK_UNDEF_NLOHMANNJSON_HEADER_GUARDS
#define MOOSE_VTK_UNDEF_NLOHMANNJSON_HEADER_GUARDS 0
// Detect if VTK built with external nlohmann
#ifdef __has_include
#if __has_include("vtk_nlohmannjson.h")
#include "vtk_nlohmannjson.h"
#if !VTK_MODULE_USE_EXTERNAL_vtknlohmannjson
#undef MOOSE_VTK_UNDEF_NLOHMANNJSON_HEADER_GUARDS
#define MOOSE_VTK_UNDEF_NLOHMANNJSON_HEADER_GUARDS 1
#endif // !VTK_MODULE_USE_EXTERNAL_vtknlohmannjson
#endif // __has_include("vtk_nlohmannjson.h")
#else  // __has_include
#error "Could not auto-detect whether VTK built with external nlohmann json. \
Define MOOSE_VTK_UNDEF_NLOHMANNJSON_HEADER_GUARDS=1 if built with vendored nlohmann \
, otherwise define MOOSE_VTK_UNDEF_NLOHMANNJSON_HEADER_GUARDS=0"
#endif // __has_include
#endif // MOOSE_VTK_UNDEF_NLOHMANNJSON_HEADER_GUARDS

#if MOOSE_VTK_UNDEF_NLOHMANNJSON_HEADER_GUARDS && !defined(MOOSE_VTK_NLOHMANN_INCLUDED)
#undef INCLUDE_NLOHMANN_JSON_FWD_HPP_
#define MOOSE_VTK_NLOHMANN_INCLUDED
#endif

#include "vtkSmartPointer.h"
#include "vtkPNGReader.h"
#include "vtkTIFFReader.h"
#include "vtkImageData.h"
#include "vtkStringArray.h"
#include "vtkImageThreshold.h"
#include "vtkImageNormalize.h"
#include "vtkImageCast.h"
#include "vtkImageShiftScale.h"
#include "vtkImageMagnitude.h"
#include "vtkImageFlip.h"

// If VTK is built without an external nlohmann, then it assumes it
// will never be compiled against another nlohmann, and it defines an
// nlohmann macro to point to its vtknlohmann copy.  In MOOSE their
// assumption is wrong.
#undef nlohmann

#include "libmesh/restore_warnings.h"

#endif

class MooseMesh;

class ImageSampler : public FileRangeBuilder
{
public:
  static InputParameters validParams();

  ImageSampler(const InputParameters & parameters);

  virtual libMesh::Real sample(const libMesh::Point & p) const;

  virtual void setupImageSampler(MooseMesh & mesh);

protected:
  void vtkShiftAndScale();

  void vtkThreshold();

  void vtkMagnitude();

private:
#ifdef LIBMESH_HAVE_VTK

  vtkSmartPointer<vtkStringArray> _files;

  vtkImageData * _data;

  vtkAlgorithmOutput * _algorithm;

  vtkSmartPointer<vtkImageReader2> _image;

  vtkSmartPointer<vtkImageThreshold> _image_threshold;

  vtkSmartPointer<vtkImageShiftScale> _shift_scale_filter;

  vtkSmartPointer<vtkImageMagnitude> _magnitude_filter;
#endif

  libMesh::Point _origin;

  std::vector<int> _dims;

  libMesh::Point _physical_dims;

  std::vector<double> _voxel;

#ifdef LIBMESH_HAVE_VTK
  unsigned int _component;
#endif

  libMesh::BoundingBox _bounding_box;

  const InputParameters & _is_pars;

  ConsoleStream _is_console;

  std::array<bool, 3> _flip;
};