celeritas::ImageInterface Class Reference

Access data from an image. More...

#include <ImageInterface.hh>

Inheritance diagram for celeritas::ImageInterface:

Public Types
Type aliases
using	int_type = int
using	SpanInt = Span< int_type >
using	SPConstParams = std::shared_ptr< ImageParams const >

Public Member Functions
virtual	~ImageInterface ()=default
	Default virtual destructor.
virtual SPConstParams const &	params () const =0
	Access image properties.
virtual void	copy_to_host (SpanInt) const =0
	Copy the image to the host.

Protected Member Functions
	CELER_DEFAULT_COPY_MOVE (ImageInterface)

Detailed Description

Access data from an image.

Images currently are arrays of integer pixels.

Member Function Documentation

copy_to_host()

virtual void celeritas::ImageInterface::copy_to_host ( SpanInt  ) const

pure virtual

Copy the image to the host.

Implemented in celeritas::Image< M >.

params()

virtual SPConstParams const & celeritas::ImageInterface::params ( ) const

pure virtual

Access image properties.

Implemented in celeritas::Image< M >.

---

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

• ImageInterface.hh