CvrStgFile Class Reference
a cover-/stego-file
More...
#include <CvrStgFile.h>
List of all members.
Detailed Description
file-format specific constants are handled as follows: CvrStgFile contains a protected set-function (e.g. setSamplesPerVertex), a public get-function (e.g. getSamplesPerVertex() const) and a private variable. The public get function does nothing else than returning the private variable, which must be set as soon as possible (if it is not set, it will contain a null value set in CvrStgFile::CvrStgFile).
Member Enumeration Documentation
Constructor & Destructor Documentation
CvrStgFile::CvrStgFile |
( |
void |
|
) |
|
CvrStgFile::~CvrStgFile |
( |
void |
|
) |
[virtual] |
Member Function Documentation
calculate a vector a SampleValueAdjacencyLists
- Parameters:
-
| svs | a vector of unique(!) sample values where svs[i]->getLabel() == i holds for all i |
- Returns:
- a vector of SampleValueAdjacencyLists where retval[i] only contains sample values with getEmbValue() == i
Every row in the adjacency lists must be sorted in the following order: The first sample value has the least distance to the source sample value, the last has the largest distance. If two sample values in one row have the same distance to the source sample value, the order does not matter.
May be overridden in derived class to provide a faster version.
Reimplemented in BmpFile, and WavFile.
BinaryIO* CvrStgFile::getBinIO |
( |
void |
|
) |
const [inline, protected] |
unsigned long CvrStgFile::getCapacity |
( |
void |
|
) |
const |
get the capacity of this cvrstgfile
- Returns:
- the capacity in bytes
get the value that is embedded in the Sample pos
- Parameters:
-
| pos | the position of the sample |
- Returns:
- the value that is embedded in the sample at the given sample position
This is equivalent to getSample(pos)->getEmbeddedValue() and is implemented here like this.
May be overwritten by derived class to provide a faster version.
EmbValue CvrStgFile::getEmbValueModulus |
( |
void |
|
) |
const [inline] |
values that are embedded in samples will be in 0...Modulus-1 (this is a file-format specific constant)
std::string CvrStgFile::getHRCapacity |
( |
void |
|
) |
const |
get the capacity as a human-readable string
get recommended list of matching algorithms
- Parameters:
-
The MatchingAlgorithm objects returned by this function should be deleted by the caller if they are no longer needed.
Reimplemented in AuFile, BmpFile, and WavFile.
const std::string& CvrStgFile::getName |
( |
void |
|
) |
const [inline] |
get the name of this cvrstgfile
virtual std::list<Property> CvrStgFile::getProperties |
( |
void |
|
) |
const [pure virtual] |
UWORD32 CvrStgFile::getRadius |
( |
void |
|
) |
const [inline] |
get the neighbourhood radius (this is a file-format specific constant)
unsigned short CvrStgFile::getSamplesPerVertex |
( |
void |
|
) |
const [inline] |
get the number of samples per vertex (this is a file-format specific constant)
guesses the file format by looking at the first few bytes
bool CvrStgFile::is_std |
( |
void |
|
) |
const [inline] |
void CvrStgFile::read |
( |
BinaryIO * |
io |
) |
[virtual] |
CvrStgFile * CvrStgFile::readFile |
( |
const std::string & |
fn |
) |
[static] |
this function reads the file with name fn and returns a *File object of the correct type casted to CvrStgFile.
void CvrStgFile::setBinIO |
( |
BinaryIO * |
io |
) |
[inline, protected] |
void CvrStgFile::setEmbValueModulus |
( |
EmbValue |
m |
) |
[inline, protected] |
void CvrStgFile::setRadius |
( |
UWORD32 |
r |
) |
[protected] |
set Radius to r unless Args.Radius is set (set Radius to Args.Radius.getValue() then)
void CvrStgFile::setSamplesPerVertex |
( |
unsigned short |
spv |
) |
[inline, protected] |
void CvrStgFile::transform |
( |
const std::string & |
fn |
) |
|
void CvrStgFile::write |
( |
void |
|
) |
[virtual] |
Member Data Documentation
The documentation for this class was generated from the following files: