System documentation of the GNU Image-Finding Tool

CAcIFFileSystem.h

/* -*- mode: c++ -*- 
*/
/* 

    GIFT, a flexible content based image retrieval system.
    Copyright (C) 1998, 1999, 2000, 2001, 2002, CUI University of Geneva

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

*/
// -*- mode: c++ -*-


class CXMLElement;

/*
*
* 
*  This class manages the access to the inverted file as well 
*    as its generation
*
*
*
* modification history:
*
* WM   1099 changed documentation format
*           completed documentation
* HM 090399 created the documentation
* WM   1098 created the file
*
*
*
* compiler defines used:
*
*
*/

#ifndef _CACIFFILESYSTEM
#define _CACIFFILESYSTEM
#include "libGIFTAcInvertedFile/include/uses-declarations.h"
#include <string>
#include "libMRML/include/TID.h"
#include "libMRML/include/CSelfDestroyPointer.h"
#include "libMRML/include/CArraySelfDestroyPointer.h"
#include "libGIFTAcInvertedFile/include/CDocumentFrequencyList.h"
#include "libMRML/include/CMutex.h" // multi threading
//#include "CCollectionFrequencyList.h"
#include "libGIFTAcInvertedFile/include/CADIHash.h"
#include "libGIFTAcURL2FTS/include/CAcURL2FTS.h"
#include "libGIFTAcInvertedFile/include/CAcInvertedFile.h"
#include <iostream>
#include <fstream>
#include <map>
#include <vector>
#ifdef HAS_HASH_MAP
#include <hash_map>
#define HASH_MAP hash_map
#else
#define HASH_MAP map
#endif
#include <functional>
#include <algorithm>

#include "libMRML/include/CMagic.h"


typedef TID TFeatureID ;

class CAcIFFileSystem:public CAcInvertedFile{  

protected:
  CMutex mMutex;
  CSelfDestroyPointer<CAcURL2FTS> mURL2FTS;
  TID mMaximumFeatureID;
#ifndef V295
  string mInvertedFileBuffer;
#else
  CArraySelfDestroyPointer<char> mInvertedFileBuffer;
#endif

  string mTemporaryIndexingFileBase;
  mutable CSelfDestroyPointer<istream> mInvertedFile;

  mutable ifstream mOffsetFile;

  ifstream mFeatureDescriptionFile;

  string mInvertedFileName;

  string mOffsetFileName;

  string mFeatureDescriptionFileName;

  typedef HASH_MAP<TID,streampos> CIDToOffset;//new hash
  CIDToOffset mIDToOffset;

  mutable HASH_MAP<TID,double> mFeatureToCollectionFrequency;//new hash

  HASH_MAP<TID,unsigned int> mFeatureDescription;//new hash_

  CADIHash mDocumentInformation;

  void writeOffsetFileElement(TID inFeatureID,
                              streampos inPosition,
                              ostream& inOpenOffsetFile);
  CDocumentFrequencyList* getFeatureFile(string inFileName)const;
public:
  bool operator()()const;

  CAcIFFileSystem(const CXMLElement& inCollectionElement);
  bool init(bool);

  ~CAcIFFileSystem();
  
  string IDToURL(TID inID)const;

  CDocumentFrequencyList* FeatureToList(TFeatureID)const;

  CDocumentFrequencyList* URLToFeatureList(string inURL)const;

  CDocumentFrequencyList* DIDToFeatureList(TID inDID)const;



  double FeatureToCollectionFrequency(TFeatureID)const;

  unsigned int getFeatureDescription(TID inFeatureID)const;

  double DIDToMaxDocumentFrequency(TID)const;

  double DIDToDFSquareSum(TID)const;

  double DIDToSquareDFLogICFSum(TID)const;

  /*@name Inverted File Generation and Consistency Checking*/

  bool generateInvertedFile();

  bool newGenerateInvertedFile();

  bool checkConsistency();

  bool findWithinStream(TID inFeatureID,
                        TID inDocumentID,
                        double inDocumentFrequency)const;
  

  virtual pair<bool,TID> URLToID(const string& inURL)const;
  
  void getAllIDs(list<TID>&)const;
  void getAllAccessorElements(list<CAccessorElement>&)const;
  void getRandomIDs(list<TID>&,
                    list<TID>::size_type)const;
  void getRandomAccessorElements(list<CAccessorElement>& outResult,
                                  list<CAccessorElement>::size_type inSize)const;
  int size()const;

  TID getMaximumFeatureID()const;
  list<TID>* getAllFeatureIDs()const;
  virtual pair<bool,CAccessorElement> IDToAccessorElement(TID inID)const;
  operator bool()const;

};

#endif

---

Need for discussion? Want to contribute? Contact