DD::Image::DeepLightSample Class Reference

#include <DeepSample.h>

Public Member Functions
	DeepLightSample (const ChannelMap &map)
	Initialise based on a ChannelMap. Set all samples to zero.
	DeepLightSample (const ChannelMap &map, const DeepPixel &pixel, int sample, bool fetchOrdered=false)
bool	operator== (DeepLightSample &other)
float &	operator() (const ChannelMap &map, Channel z)
	access the sample for a particular channel
float	operator() (const ChannelMap &map, Channel z) const
	access the sample for a particular channel
SampleContainer::iterator	begin ()
SampleContainer::iterator	end ()
SampleContainer::const_iterator	begin () const
SampleContainer::const_iterator	end () const
size_t	size ()
	get number of samples

Detailed Description

Lightweight helper class representing a container of deep sample, one element per channel in a set. The sample value is represented in a single precision floating-point type.

Note

The channel map object isn't preserved in the class. For indexing a sample by a given channel the same channel map needs to be provided along with the channel, which was used for the initialization of the class. For a version of this class which preserves the channel map object, please consider using DeepSample.

Constructor & Destructor Documentation

DeepLightSample()

DD::Image::DeepLightSample::DeepLightSample ( const ChannelMap &  map, const DeepPixel &  pixel, int  sample, bool  fetchOrdered = false  )

inline

Initialise based on a sample from a DeepPixel. If fetchOrdered is true it will use getOrderedSample, otherwise getUnorderedSample.

References DD::Image::DeepPixel::channels(), DD::Image::ChannelMap::contains(), DD::Image::DeepPixel::getOrderedSample(), DD::Image::DeepPixel::getUnorderedSample(), and DD::Image::ChannelMap::size().