SPATMOD::IMAGE::FILTER_MARGIN Class Reference

Filter to automatically buffer "margins" when iterating. More...

#include <spatmod/imagefiltermargin.h>

Inheritance diagram for SPATMOD::IMAGE::FILTER_MARGIN:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FILTER_MARGIN (STAGE *pSourceImage, bool TakeOwnership, UINT32 RowsBefore, UINT32 ColumnsBefore, UINT32 RowsAfter, UINT32 ColumnsAfter)
virtual ~FILTER_MARGIN ()

Detailed Description

Filter to automatically buffer "margins" when iterating.

This is useful in implementing "kernel-based" spatial filters, such as low-pass, high-pass, etc. When reading, the buffer must be a window into a larger buffer to allow space for the defined margins. Note that if there is a margin added after the last row/column then the first and last tile sizes will be adjusted accordingly, resulting in a virtual shift in the tile boundaries. This may have implications when processing concurrently with other images, particularly if any images do not support efficient random access. In addition, the sequence for iterating must exactly match that specified in the call to PullBegin.


Constructor & Destructor Documentation

SPATMOD::IMAGE::FILTER_MARGIN::FILTER_MARGIN ( STAGE pSourceImage,
bool  TakeOwnership,
UINT32  RowsBefore,
UINT32  ColumnsBefore,
UINT32  RowsAfter,
UINT32  ColumnsAfter 
)

Construct with specified margins.

Parameters:
pSourceImage Source image stage
TakeOwnership Filter takes ownership of source stage and will delete when needed
RowsBefore Margin to add before first row in buffer
ColumnsBefore Margin to add before first column in buffer
RowsAfter Margin to add after last row in buffer
ColumnsAfter Margin to add after last column in buffer
virtual SPATMOD::IMAGE::FILTER_MARGIN::~FILTER_MARGIN (  )  [virtual]

The documentation for this class was generated from the following file:

Generated on Sun Oct 7 21:39:49 2012 for TNTsdk 2012 by  doxygen 1.6.1