VTK-m  2.2
Public Member Functions | Protected Member Functions | Private Types | List of all members
vtkm::io::ImageReaderHDF5 Class Reference

Reading images using HDF5 Image format. More...

#include <ImageReaderHDF5.h>

Inheritance diagram for vtkm::io::ImageReaderHDF5:
vtkm::io::ImageReaderBase

Public Member Functions

 ~ImageReaderHDF5 () noexcept override
 
 ImageReaderHDF5 (const ImageReaderHDF5 &)=delete
 
ImageReaderHDF5operator= (const ImageReaderHDF5 &)=delete
 
- Public Member Functions inherited from vtkm::io::ImageReaderBase
 ImageReaderBase (const char *filename)
 
 ImageReaderBase (const std::string &filename)
 Construct a reader to load data from the given file. More...
 
virtual ~ImageReaderBase () noexcept
 
 ImageReaderBase (const ImageReaderBase &)=delete
 
ImageReaderBaseoperator= (const ImageReaderBase &)=delete
 
const vtkm::cont::DataSetReadDataSet ()
 Load data from the file and return it in a DataSet object. More...
 
const vtkm::cont::DataSetGetDataSet () const
 
const std::string & GetPointFieldName () const
 Get the name of the output field that will be created to hold color data. More...
 
void SetPointFieldName (const std::string &name)
 Set the name of the output field that will be created to hold color data. More...
 
const std::string & GetFileName () const
 
void SetFileName (const std::string &filename)
 

Protected Member Functions

void Read () override
 
- Protected Member Functions inherited from vtkm::io::ImageReaderBase
void InitializeImageDataSet (const vtkm::Id &width, const vtkm::Id &height, const ColorArrayType &pixels)
 Resets the DataSet to hold the given pixels. More...
 

Private Types

using Superclass = ImageReaderBase
 

Additional Inherited Members

- Public Types inherited from vtkm::io::ImageReaderBase
using ColorArrayType = vtkm::cont::ArrayHandle< vtkm::Vec4f_32 >
 
- Protected Attributes inherited from vtkm::io::ImageReaderBase
std::string FileName
 
std::string PointFieldName = "color"
 
vtkm::cont::DataSet DataSet
 

Detailed Description

Reading images using HDF5 Image format.

ImageReaderHDF5 extends vtkm::io::ImageWriterBase and implements writing image HDF5 file format. It conforms to the HDF5 Image Specification https://portal.hdfgroup.org/display/HDF5/HDF5+Image+and+Palette+Specification%2C+Version+1.2

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ ~ImageReaderHDF5()

vtkm::io::ImageReaderHDF5::~ImageReaderHDF5 ( )
overridenoexcept

◆ ImageReaderHDF5()

vtkm::io::ImageReaderHDF5::ImageReaderHDF5 ( const ImageReaderHDF5 )
delete

Member Function Documentation

◆ operator=()

ImageReaderHDF5& vtkm::io::ImageReaderHDF5::operator= ( const ImageReaderHDF5 )
delete

◆ Read()

void vtkm::io::ImageReaderHDF5::Read ( )
overrideprotectedvirtual

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