celeritas::ImageParamsScalars Struct Reference

Scalar properties for building a rasterized image. More...

#include <ImageData.hh>

Public Member Functions
CELER_FUNCTION	operator bool () const
	Whether the interface is initialized.

Public Attributes
Real3	origin {}
	Upper left corner.
Real3	down {}
	Downward basis vector.
Real3	right {}
	Rightward basis vector (increasing i, track movement)
real_type	pixel_width {}
	Width of a pixel.
Size2	dims {}
	Image dimensions (rows, columns)
real_type	max_length {}
	Maximum distance along rightward to trace.

Detailed Description

Scalar properties for building a rasterized image.

These properties specify a "window" that's a slice of a 3D geometry. It uses graphics conventions of making the upper left corner the origin.

The down basis vector corresponds to increasing j and is used for track initialization. The right basis vector corresponds to increasing i and is used for track movement. Because the user-specified window may not have an integer ratio of the two sides, we have a "max length" for raytracing to the right. This also lets us round up the image dimensions to a convenient alignment.

All units are "native" length.

---

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

• ImageData.hh