SampleValue Class Reference
the value of a sample in a CvrStgFile
More...
#include <SampleValue.h>
Inheritance diagram for SampleValue:
List of all members.
Detailed Description
This is the abstract base class for all AuSampleValue, BmpSampleValue, etc. classes
For two sample values s1 and s2:
s1->calcDistance(s2) == s2->calcDistance(s1) is always true.
s1->isNeighbour(s2) == s2->isNeighbour(s1) is always true.
s1 and s2 are called opposite if s1->getBit() != s2->getBit()
s1 and s2 are called neighbours if s1->isNeighbour(s2) is true
s1->getKey() == s2->getKey() iff s1 == s2
s1 == s2 implies s1->getDistance(s2) == 0 BUT: s1->getDistance(s2) == 0 does not imply s1 == s2 example: 8-bit bmp palette image - same color value for two different indices
s1 == s2 implies s1->getBit() == s2->getBit()
s1->getDistance(s2) == 0 implies s1->getBit() == s2->getBit()
NOTE: SampleValue and all derived classes rely on the Globals object pointed to by the Globs pointer. This means that it must be set correctly before using any method of a SampleValue (or derived) object.
Constructor & Destructor Documentation
SampleValue::SampleValue |
( |
void |
|
) |
|
|
Member Function Documentation
void SampleValue::decNumEdges |
( |
EmbValue |
t |
) |
|
|
EmbValue SampleValue::getEmbeddedValue |
( |
void |
|
) |
const [inline] |
|
|
get the value that is embedded in this sample value (must be >=0 and <EmbValueModulus) - Returns:
- the embedded value
|
UWORD32 SampleValue::getKey |
( |
void |
|
) |
const [inline] |
|
|
get the key for this sample - Returns:
- a key which must be different for two different samples values.
|
unsigned long SampleValue::getLabel |
( |
void |
|
) |
const [inline] |
|
virtual std::string SampleValue::getName |
( |
void |
|
) |
const [pure virtual] |
|
virtual SampleValue* SampleValue::getNearestTargetSampleValue |
( |
EmbValue |
t |
) |
const [pure virtual] |
|
void SampleValue::incNumEdges |
( |
EmbValue |
t |
) |
|
|
bool SampleValue::isNeighbour |
( |
const SampleValue * |
s |
) |
const [virtual] |
|
|
is the sample value s a neighbour of this sample value ? - Returns:
- true iff this and s are neighbours
This is implemented as (calcDistance() <= Radius) but may be overridden by derived classes.
Reimplemented in DummySampleValue. |
bool SampleValue::operator!= |
( |
const SampleValue & |
sv |
) |
const [inline] |
|
bool SampleValue::operator< |
( |
const SampleValue & |
sv |
) |
const [inline] |
|
bool SampleValue::operator== |
( |
const SampleValue & |
sv |
) |
const [inline] |
|
|
two sample values are equal iff their keys are equal |
void SampleValue::print |
( |
unsigned short |
spc = 0 |
) |
const |
|
void SampleValue::setLabel |
( |
unsigned long |
l |
) |
[inline] |
|
Member Data Documentation
|
NumEdges[t] contains the number of edges that are added to a vertex if this sample value with corresponding target value t is added to the vertex |
The documentation for this class was generated from the following files:
Generated on Thu Nov 13 23:44:24 2003 for steghide by
1.3.3