DD::Image::GeneralTile Class Reference

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

List of all members.

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=NULL)
 ~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
bool _ipcIsShared
ChannelSet _channels
Box _box
RowCacheTile_rowCacheTile
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-compatability, 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 = NULL 
)
DD::Image::GeneralTile::~GeneralTile ( )

destructor


Member Function Documentation

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

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

References x().

Referenced by x().

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cast operator for the box (provided for compatability 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) [static, protected]

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().

Referenced by GeneralTile().