System documentation of the GNU Image-Finding Tool

Public Member Functions | List of all members
CWFProbability Class Reference

Method. More...

#include <CWFProbability.h>

Inheritance diagram for CWFProbability:
CWeightingFunction

Public Member Functions

 CWFProbability (const CAcInvertedFile *inAccessor=0, CQueryNormalizer *inQueryNormalizer=0, CQueryNormalizer *inThisNormalizer=0)
virtual double subApply (const double inDocumentFrequency, const double inNormalizingFactor) const
 Apply this on a document frequency.
CWeightingFunctionclone () const
 Virtual copy constructor.
- Public Member Functions inherited from CWeightingFunction
double getQueryFactor () const
 The query factor contains all informatio which depends only on the query.
virtual void preCalculate ()
 Calculate the QueryFactor.
 CWeightingFunction (const CAcInvertedFile *inAccessor=0, CQueryNormalizer *inQueryNormalizer=0, CQueryNormalizer *inThisNormalizer=0)
 Constructor:
void setAccessor (const CAcInvertedFile *)
 Set the accessor (should not be needed)
void setNormalizers (CQueryNormalizer *inQueryNormalizer, CQueryNormalizer *inThisNormalizer)
 Set the query normalizer (should not be needed);.
void setID (TID)
 Set the ID of this feature.
TID getID () const
 get the ID of this feature
void setRelevanceSum (double inPositiveRelevanceSum, double inNegativeRelevanceSum)
 Setting the relevance sum, that is the sum of the absolute values of all relevance levels of all documents of the query.
virtual void addQueryFeature (double inRelevanceLevel, const CDocumentFrequencyElement &inQueryFeature)
 Add a feature.
virtual double getTermFrequency () const
 Giving a pseudo term frequency for normalization.
virtual double apply (const CDocumentFrequencyElement &inResultFeature) const
 Preparing the right parameters for subApply: Apply this on another feature.
double applyOnThis () const
 Preparing the right parameters for subApply: Apply this on itself.
virtual CWeightingFunctionconstructNew (TID inID) const
 For the "prototype pattern": Kinda virtual copy constructor: Gamma/Helm/Johnson/Vlissides p.
virtual ~CWeightingFunction ()
 This virtual destructor is here inorder to call the (inherited) default constructors.

Additional Inherited Members

- Protected Attributes inherited from CWeightingFunction
double mPositiveRelevanceSum
 This value depends on all the elements of the query, which have a positive user-assigned relevance.
double mNegativeRelevanceSum
 This value depends on all the elements of the query, which have a negative user-assigned relevance.
double mPositiveTermFrequency
double mNegativeTermFrequency
int mFeatureDescription
 At present the feature description is a simple integer which expresses if the feature is a histogram feature or not and if it is a texture feature or not.
TID mID
const CAcInvertedFilemAccessor
 The accessor for the file on which the query is performed.
CQueryNormalizermQueryNormalizer
 FIXME THERE IS A GOOD DESCRIPTION MISSING FOR THE NEXT TWO VARIABLES.
CQueryNormalizermThisNormalizer
 A normalizer for apply on self.
double mQueryFactor
 The query usually will separate into a part which is equal for all the query and a part which is to be calculated for each document.
double mDocumentFactor

Detailed Description

Method.


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

Need for discussion? Want to contribute? Contact
help-gift@gnu.org Generated using Doxygen