DD::Image::DeepOutputPixel Class Reference

Inherits DD::Image::DeepPixel.

Public Member Functions

 DeepOutputPixel (const DD::Image::ChannelMap &channels, float *pixels, size_t dataCount, Ordering ordering)
 
float * writable () const
 
float * getWritableUnorderedSample (size_t sampNo)
 
float & getWritableUnorderedSample (size_t sampNo, DD::Image::Channel channel)
 
float & getWritableOrderedSample (size_t depthIdx, DD::Image::Channel channel)
 
- Public Member Functions inherited from DD::Image::DeepPixel
 DeepPixel (const DD::Image::ChannelMap &channels, const float *pixels, size_t dataCount, Ordering ordering)
 
const ChannelMapchannels () const
 
size_t getSampleCount () const
 
const float * data () const
 
size_t getDataCount () const
 
const float * getUnorderedSample (size_t sampNo) const
 
const float & getUnorderedSample (size_t sampNo, DD::Image::Channel channel) const
 
const float & getOrderedSample (size_t depthIdx, DD::Image::Channel channel) const
 

Additional Inherited Members

- Public Types inherited from DD::Image::DeepPixel
enum  Ordering { eUnordered, eZAscending, eZDescending }
 
- Static Public Member Functions inherited from DD::Image::DeepPixel
static Ordering SwapOrdering (Ordering ordering)
 
- Protected Member Functions inherited from DD::Image::DeepPixel
void makeSampleOrder () const
 
- Protected Attributes inherited from DD::Image::DeepPixel
const DD::Image::ChannelMap_channels
 
const float * _data
 
size_t _dataCount
 
size_t _chanCount
 
size_t _sampleCount
 
Ordering _ordering
 
std::vector< size_t > _sampleOrder
 
bool _doneSampleOrder
 

Detailed Description

DeepOutputPixel is used to write to DeepInPlaceOutputPlanes.

It allows direct access to the samples in DeepPlaneData. At a particular x,y position in a DeepOutputPlane, a DeepOutputPixel provides methods for direct access to the plane's data. It remains valid for only as long as the DeepOutputPlane it is associated with exists.

Constructor & Destructor Documentation

DD::Image::DeepOutputPixel::DeepOutputPixel ( const DD::Image::ChannelMap channels,
float *  pixels,
size_t  dataCount,
Ordering  ordering 
)
inline

DeepOutputPixel constructor

Member Function Documentation

float * DD::Image::DeepOutputPixel::writable ( ) const

Get a writable the pointer to this DeepPixel's DeepOutputPlane's data

float* DD::Image::DeepOutputPixel::getWritableUnorderedSample ( size_t  sampNo)
inline

Get a writable pointer to the pixel data for a particular sample number. Data will be the channels present in channels(), ordered by numeric channel id. Samples are in whatever order they happen to be in the pixel.

float& DD::Image::DeepOutputPixel::getWritableUnorderedSample ( size_t  sampNo,
DD::Image::Channel  channel 
)
inline

Get a writable reference to a particular sample's channel. Samples are in whatever order they happen to be in the pixel.

float & DD::Image::DeepOutputPixel::getWritableOrderedSample ( size_t  depthIdx,
DD::Image::Channel  channel 
)

Get a writable reference to a particular sample (by depth) and channel. Samples will be ordered so that if depthIdx == 0, it will fetch the sample with the lowest Z.

References DD::Image::DeepPixel::getOrderedSample().



©2021 The Foundry Visionmongers, Ltd. All Rights Reserved.
www.thefoundry.co.uk