DD::Image::DeepSample Class Reference

#include <DeepSample.h>

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

Detailed Description

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

Note

The channel map object is preserved in the class, which allows for indexing the samples by a given channel. For a lighter version of this class please consider using DeepLightSample.

Constructor & Destructor Documentation

DeepSample()

DD::Image::DeepSample::DeepSample ( 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(), and DD::Image::DeepPixel::getUnorderedSample().