Writes images using the PNM format. More...

#include <ImageWriterPNM.h>

Inheritance diagram for vtkm::io::ImageWriterPNM:

Public Member Functions
	~ImageWriterPNM () noexcept override

	ImageWriterPNM (const ImageWriterPNM &)=delete

ImageWriterPNM &	operator= (const ImageWriterPNM &)=delete

void	Write (vtkm::Id width, vtkm::Id height, const ColorArrayType &pixels) override
	Attempts to write the ImageDataSet to a PNM file. More...

Public Member Functions inherited from vtkm::io::ImageWriterBase
	ImageWriterBase (const char *filename)

	ImageWriterBase (const std::string &filename)
	Construct a writer to save data to the given file. More...

virtual	~ImageWriterBase () noexcept

	ImageWriterBase (const ImageWriterBase &)=delete

ImageWriterBase &	operator= (const ImageWriterBase &)=delete

virtual void	WriteDataSet (const vtkm::cont::DataSet &dataSet, const std::string &colorField={})
	Write the color field of a data set to an image file. More...

PixelDepth	GetPixelDepth () const
	Specify the number of bits used by each color channel. More...

void	SetPixelDepth (PixelDepth depth)
	Specify the number of bits used by each color channel. More...

const std::string &	GetFileName () const

void	SetFileName (const std::string &filename)

Protected Member Functions
template<typename PixelType >
void	WriteToFile (vtkm::Id width, vtkm::Id height, const ColorArrayType &pixels)

Private Types
using	Superclass = vtkm::io::ImageWriterBase

Additional Inherited Members
Public Types inherited from vtkm::io::ImageWriterBase
enum	PixelDepth { PixelDepth::PIXEL_8, PixelDepth::PIXEL_16 }

using	ColorArrayType = vtkm::cont::ArrayHandle< vtkm::Vec4f_32 >

Protected Attributes inherited from vtkm::io::ImageWriterBase
std::string	FileName

PixelDepth	Depth = PixelDepth::PIXEL_8

Detailed Description

Writes images using the PNM format.

ImageWriterPNM is constructed with the name of the file to write. The data is written to the file by calling the WriteDataSet method.

ImageWriterPNM writes images in PNM format (for magic number P6). These files are most commonly stored with a .ppm extension although the .pnm extension is also valid. More details on the PNM format can be found at http://netpbm.sourceforge.net/doc/ppm.html

Member Typedef Documentation

◆ Superclass

using vtkm::io::ImageWriterPNM::Superclass = vtkm::io::ImageWriterBase

private

Constructor & Destructor Documentation

◆ ~ImageWriterPNM()

vtkm::io::ImageWriterPNM::~ImageWriterPNM ( )

overridenoexcept

◆ ImageWriterPNM()

vtkm::io::ImageWriterPNM::ImageWriterPNM ( const ImageWriterPNM & )

delete

Member Function Documentation

◆ operator=()

ImageWriterPNM& vtkm::io::ImageWriterPNM::operator= ( const ImageWriterPNM & )

delete

◆ Write()

void vtkm::io::ImageWriterPNM::Write	(	vtkm::Id	width,
		vtkm::Id	height,
		const ColorArrayType &	pixels
	)

overridevirtual

Attempts to write the ImageDataSet to a PNM file.

The MaxColorValue set in the file with either be selected from the stored MaxColorValue member variable, or from the templated type if MaxColorValue hasn't been set from a read file.

Implements vtkm::io::ImageWriterBase.

◆ WriteToFile()

template<typename PixelType >

void vtkm::io::ImageWriterPNM::WriteToFile	(	vtkm::Id	width,
		vtkm::Id	height,
		const ColorArrayType &	pixels
	)

protected

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

ImageWriterPNM.h

Public Member Functions

Protected Member Functions

Private Types

Additional Inherited Members