Sketch Class Template Reference
#include <Sketch.h>
Inheritance diagram for Sketch:
Detailed Description
template<typename T>
class DualCoding::Sketch< T >
Smart pointers for referencing.
This is the structure that provides safe user-level access to sketches. It's a smart pointer that does reference counting, and overloads operator-> so it can do validity checking. If the validity check succeeds, operator-> dereferences to a SketchData<T> object.
Definition at line 26 of file Sketch.h.
Public Member Functions | |
| Sketch (SketchSpace &_space, const std::string &_name="(no name)") | |
| Constructor. Allocates a new SketchData<T> to hold the data. | |
| Sketch (const std::string &_name, const SketchRoot &parent) | |
| Constructor. Inherits parent and color information from parent sketch. | |
| Sketch () | |
| Dummy constructor, for use in vector construction. | |
| Sketch (const Sketch &other) | |
| Copy constructor, used in something like. | |
| Sketch (const Sketch &other, const std::string &name, bool viewable) | |
| Shallow copy constructor used by NEW_SKETCH and NEW_SKETCH_N. | |
| virtual | ~Sketch () |
| Destructor. Cleans up and decrements SketchData reference count. | |
| Sketch (const std::string &name, SketchSpace &space) | |
| Retrieve an existing sketch by name. | |
| bool | isValid () const |
| True if this Sketch actually points to a SketchData. | |
| void | checkValid () const |
| Print error message if Sketch fails isValid() test. | |
| SketchData< T > * | operator-> () |
| const SketchData< T > * | operator-> () const |
| T & | operator[] (size_t idx) |
| const T & | operator[] (size_t idx) const |
| const Sketch< T > | operator[] (const Sketch< usint > &indirection) const |
| when passed indirection matrix (e.g. idx_left) returns resampled Sketch | |
| T & | operator() (size_t x, size_t y) |
| const T & | operator() (size_t x, size_t y) const |
| Sketch & | setIndices (const SketchIndices &indices, const T &value) |
| void | bind (const Sketch &other) |
| Make this sketch point to another sketch's SketchData. | |
| Sketch & | operator= (const Sketch &other) |
| Assignment operator: copies the pixels. | |
| Sketch & | operator= (const T &value) |
| Sets all pixels in the Sketch to the specified value. | |
| Sketch< bool > | operator! () const |
| Sketch< T > & | operator+= (const Sketch< T > &other) |
| void | printVals () const |
| operator Sketch () const | |
| operator for implicitly or explicitly converting to Sketch<bool> | |
| operator Sketch () const | |
| operator for implicity or explicitly converting to Sketch<uchar> | |
| operator Sketch () const | |
| operator for implicity or explicitly converting to Sketch<usint> | |
| operator Sketch () const | |
| operator for implicity or explicitly converting to Sketch<float> | |
| Sketch< T > & | operator-= (const Sketch< T > &other) |
| Sketch< T > & | operator *= (const Sketch< T > &other) |
| Sketch< T > & | operator/= (const Sketch< T > &other) |
| Sketch< T > & | operator+= (const T value) |
| Sketch< T > & | operator-= (const T value) |
| Sketch< T > & | operator *= (const T value) |
| Sketch< T > & | operator/= (const T value) |
| Sketch & | operator+= (const int value) |
| Sketch & | operator-= (const int value) |
| Sketch & | operator *= (const int value) |
| Sketch & | operator/= (const int value) |
Public Attributes | |
| int | width |
| int | height |
| SketchData< T > * | data |
| The SketchData object referenced by this Sketch. | |
| std::valarray< T > * | pixels |
| The image resource for the Sketch, owned by the SketchData object. | |
Constructor & Destructor Documentation
| Sketch | ( | SketchSpace & | _space, | |
| const std::string & | _name = "(no name)" | |||
| ) |
| Sketch | ( | const std::string & | _name, | |
| const SketchRoot & | parent | |||
| ) |
| Sketch | ( | ) |
Copy constructor, used in something like.
Sketch<bool> image = original;
Shallow copy constructor used by NEW_SKETCH and NEW_SKETCH_N.
| ~Sketch | ( | ) | [virtual] |
Destructor. Cleans up and decrements SketchData reference count.
| Sketch | ( | const std::string & | name, | |
| SketchSpace & | space | |||
| ) |
Member Function Documentation
| void bind | ( | const Sketch< T > & | other | ) |
Make this sketch point to another sketch's SketchData.
Referenced by visops::fillin(), and visops::labelcc().
| void checkValid | ( | ) | const |
Print error message if Sketch fails isValid() test.
Definition at line 251 of file Sketch.h.
Referenced by Sketch< unsigned short int >::operator()(), Sketch< unsigned short int >::operator->(), Sketch::operator=(), Sketch::operator[](), Sketch< unsigned short int >::operator[](), and Sketch::setIndices().
| bool isValid | ( | ) | const [inline] |
True if this Sketch actually points to a SketchData.
Definition at line 59 of file Sketch.h.
Referenced by Sketch::checkValid(), and Sketch::~Sketch().
| operator Sketch | ( | ) | const |
operator for implicity or explicitly converting to Sketch<float>
| operator Sketch | ( | ) | const |
operator for implicity or explicitly converting to Sketch<usint>
| operator Sketch | ( | ) | const |
operator for implicity or explicitly converting to Sketch<uchar>
| operator Sketch< float > | ( | ) | const |
operator for implicitly or explicitly converting to Sketch<bool>
| const SketchData<T>* operator-> | ( | void | ) | const [inline] |
| SketchData<T>* operator-> | ( | void | ) | [inline] |
| Sketch< T > & operator= | ( | const T & | value | ) |
| Sketch< T > & setIndices | ( | const SketchIndices & | indices, | |
| const T & | value | |||
| ) |
Member Data Documentation
| SketchData<T>* data |
The SketchData object referenced by this Sketch.
Definition at line 31 of file Sketch.h.
Referenced by Sketch< unsigned short int >::isValid(), Sketch< unsigned short int >::operator->(), Sketch::operator[](), SketchRoot::rootGetData(), SketchRoot::rootGetSpace(), Sketch::Sketch(), and Sketch::~Sketch().
| int height |
Definition at line 28 of file Sketch.h.
Referenced by LineData::balanceEndPointVert(), visops::convolve(), DualCoding::countBorderPixelFit(), PointData::extractPoints(), visops::labelcc(), visops::oldlabelcc(), EllipseData::render(), LineData::scanHorizForEndPts(), LineData::scanVertForEndPts(), Sketch::Sketch(), and visops::templateMatch().
| std::valarray<T>* pixels |
The image resource for the Sketch, owned by the SketchData object.
Definition at line 34 of file Sketch.h.
Referenced by visops::copy(), DualCoding::copyPixels(), visops::ifNot(), visops::labelcc(), visops::maskedAssign(), visops::max(), visops::min(), DualCoding::operator &=(), Sketch::operator *=(), Sketch< unsigned short int >::operator()(), Sketch::operator+=(), Sketch::operator-=(), Sketch::operator/=(), Sketch::operator=(), Sketch::operator[](), Sketch< unsigned short int >::operator[](), DualCoding::operator|=(), Sketch::printVals(), Sketch::setIndices(), Sketch::Sketch(), and visops::zeros().
| int width |
Definition at line 28 of file Sketch.h.
Referenced by LineData::balanceEndPointVert(), PolygonData::convexHull(), visops::convolve(), DualCoding::countBorderPixelFit(), PointData::extractPoints(), visops::labelcc(), visops::oldlabelcc(), Sketch< unsigned short int >::operator()(), Sketch::printVals(), EllipseData::render(), LineData::scanHorizForEndPts(), LineData::scanVertForEndPts(), Sketch::Sketch(), and visops::templateMatch().
The documentation for this class was generated from the following file:
