DD::Image::GeneralTile Class Reference

Inherited by DD::Image::DirectGeneralTile, and DD::Image::RawGeneralTile.

Public Member Functions

int x () const
 
int y () const
 
int r () const
 
int t () const
 
int w () const
 
int h () const
 
int clampy (int y) const
 
int clampx (int x) const
 
 operator const Box & () const
 
const DD::Image::Boxbox () const
 
const ChannelSetchannels () const
 
bool is_zero (Channel z, int y) const
 
bool valid () const
 
 GeneralTile (Iop &input, const Box &box, const ChannelSet &chans, bool forceUnpacked=false, bool mt=false, InterestRatchet *ir=nullptr)
 
 ~GeneralTile ()
 
float at (int x, int y, Channel z)
 
bool aborted () const
 

Static Protected Member Functions

static Box getRequestBox (Iop &input)
 

Protected Attributes

Iop_input
 
PlanarI_planarI
 
LocalPlaneCache * _ipc
 
ChannelSet _channels
 
Box _box
 
RowCacheTile_rowCacheTile
 
bool _ipcIsShared
 
bool _valid
 

Detailed Description

GeneralTile is a Tile-like API for access to image data, that can use both the traditional row-based Tile API and can access ImagePlane data

Unlike Interest/Tile this isn't a Box. Some Box methods are provided for source-compatibility, but it's probably best to use getBox() to get the box instead.

Constructor & Destructor Documentation

DD::Image::GeneralTile::GeneralTile ( Iop input,
const Box box,
const ChannelSet chans,
bool  forceUnpacked = false,
bool  mt = false,
InterestRatchet ir = nullptr 
)

Construct. All image data will be available after this call, unless the calculation has been aborted due to user action or an error. Please check the aborted() state after construction and do not use the pixel data if this is set.

References aborted(), DD::Image::Iop::fetchPlane(), DD::Image::PlanarI::getAllPlanes(), DD::Image::PlanarI::getCache(), DD::Image::PlanarI::getStripeBox(), DD::Image::PlanarI::getStripeCount(), DD::Image::Op::hash(), DD::Image::PlanarI::packedPreference(), DD::Image::ImagePlane::readable(), DD::Image::Iop::requestedBox(), DD::Image::PlanarI::rowToStripeIndex(), and DD::Image::ChannelSet::size().

DD::Image::GeneralTile::~GeneralTile ( )

destructor

Member Function Documentation

int DD::Image::GeneralTile::x ( ) const
inline

accessor for the box's x value (provided for compatibility with DD::Image::RowCacheTile)

int DD::Image::GeneralTile::y ( ) const
inline

accessor for the box's y value (provided for compatibility with DD::Image::RowCacheTile)

int DD::Image::GeneralTile::r ( ) const
inline

accessor for the box's r value (provided for compatibility with DD::Image::RowCacheTile)

int DD::Image::GeneralTile::t ( ) const
inline

accessor for the box's t value (provided for compatibility with DD::Image::RowCacheTile)

int DD::Image::GeneralTile::w ( ) const
inline

accessor for the box's width (provided for compatibility with DD::Image::RowCacheTile)

int DD::Image::GeneralTile::h ( ) const
inline

accessor for the box's height (provided for compatibility with DD::Image::RowCacheTile)

int DD::Image::GeneralTile::clampy ( int  y) const
inline

clamp a y value to within the box (provided for compatibility with DD::Image::RowCacheTile)

int DD::Image::GeneralTile::clampx ( int  x) const
inline

clamp a x value to within the box (provided for compatibility with DD::Image::RowCacheTile)

DD::Image::GeneralTile::operator const Box & ( ) const
inline

cast operator for the box (provided for compatibility with DD::Image::RowCacheTile)

const DD::Image::Box& DD::Image::GeneralTile::box ( ) const
inline

return the box for the tile

const ChannelSet& DD::Image::GeneralTile::channels ( ) const
inline

get the channels for the tile

bool DD::Image::GeneralTile::is_zero ( Channel  z,
int  y 
) const

is this channel/row pair 'zero' (ie is it mapped to no data, rather than checking explicitly whether it is full of zeroes

References DD::Image::Interest::is_zero().

bool DD::Image::GeneralTile::valid ( ) const

whether the GeneralTile is accessible, or had it aborted during construction.

References DD::Image::Interest::valid().

float DD::Image::GeneralTile::at ( int  x,
int  y,
Channel  z 
)
bool DD::Image::GeneralTile::aborted ( ) const

whether this Tile was aborted during construction.

References DD::Image::Op::aborted().

Referenced by GeneralTile().

Box DD::Image::GeneralTile::getRequestBox ( Iop input)
staticprotected

helper function: get the requested box on an input, bypassing Iops that contribute nothing towards the image

References DD::Image::Interest::inputIop(), and DD::Image::Iop::requestedBox().



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