ikonilla merkityt kentät
ovat taulun avainkenttiä, jotka yksikäsitteisesti tunnistavat taulun
jokaisen rivin. 
ikonilla merkityt
kentät taas kuvaavat avainkentistä funktionaalisesti riippuvia
kenttiä.
http://
Last modified .
1. Johdanto
2. Järjestelmän yleiskuvaus
3. Arkkitehtuurin kuvaus
4. Rajapinnat
5. Alijärjestelmäkuvaukset
6. Modulien toteutuksen kuvaus
PicSearch toteutetaan käyttäen C++ -ohjelmointikieltä sekä käyttöliittymän tekoon Tcl/Tk:ta. Tämä mahdollistaa siirrettävyyden ympäristöihin joissa nämä välineet (sekä säikeet ja semaphorat) ovat käytettävissä. Järjestelmä toimitetaan ja testataan LINUX:ssa, mutta ei-formaalisti myös 32-bittisessä Windows:ssa ja UNIX:ssa TKK:n Alpha-koneissa (alpha.hut.fi).
Järjestelmä on jaettu loogisiin alijärjestelmiin, joista kunkin toteutuksesta vastaa yksi vastuuhenkilö. Alijärjestelmät liittyvät toisiinsa rajapintojen kautta. Järjestelmä liittyy ympäristöönsä käyttöliittymän, tiedostojärjestelmän ja tietokannan kautta. Toimitettavassa järjestelmässä fyysinenkin tietokanta on toteutettu osaksi järjestelmää.
Tietokantaan tallennettava tieto on jaettu relaatiotauluihin E-R mallin
perusteella. Entiteeteistä, eli E-R mallin laatikoista, tehtiin omat taulunsa
ja kaikki relaatiot, eli E-R mallin salmiakkikuviot, sisällytettiin näihin
tauluihin paitsi moni-moni relaatiot, joista tehtiin omat taulunsa
(Segmentation, Signature ja SegmSignature).
Relaatiotaulut ja niiden sisällöt on esitetty tarkemmin seuraavassa taulukossa.
Kunkin taulun ikonilla merkityt kentät
ovat taulun avainkenttiä, jotka yksikäsitteisesti tunnistavat taulun
jokaisen rivin. ikonilla merkityt
kentät taas kuvaavat avainkentistä funktionaalisesti riippuvia
kenttiä.
Taulukossa on esitetty jokaisen kentän tietotyyppi, nimi ja lopuksi lyhyt selitys. Tietotyypeistä INT tarkoittaa vähintään 32 bitin tarkkuudella talletettua kokonaislukua, CHAR mielivaltaisen pituista merkkijonoa ja BIN mielivaltaisen kokoista, binäärityyppistä tietoa sisältävää, kenttää.
| ImageInfo | Kuvan yleiset tiedot | |
| INT |
id | Kuvan ID-numero |
| CHAR |
name | Kuvan nimi / lyhyt kuvaus |
| CHAR |
par1 | Vapaavalintainen merkkijono 1 |
| CHAR |
par2 | Vapaavalintainen merkkijono 2 |
| ImageData | Normaalikokoisen kuvan data | |
| INT |
imageId | Kuva, jolle kuvadata kuuluu |
| INT |
width | Kuvan leveys |
| INT |
height | Kuvan korkeus |
| INT |
formatId | Kuvaformaatti |
| CHAR |
filename | Tiedoston nimi, jos kuvadata tallennettu tiedostoon |
| BIN |
data | Kuvadata (jos tiedoston nimeä ei annettu) |
| ScaledImageData | Skaalatun kuvan data | |
| INT |
imageId | Kuva, jolle kuvadata kuuluu |
| INT |
width | Kuvan leveys |
| INT |
height | Kuvan korkeus |
| INT |
formatId | Kuvaformaatti |
| BIN |
data | Kuvadata |
| ImageFormat | Kuvan tallennusformaatti | |
| INT |
id | Kuvaformaatin ID-numero |
| CHAR |
name | Formaatin nimi |
| SearchAlgorithm | Kuvahakualgoritmi | |
| INT
| id | Hakualgoritmin ID-numero |
| CHAR |
name | Algoritmin nimi |
| Signature | Kuvalle laskettu signature | |
| INT |
imageId | Kuva, josta signature on laskettu |
| INT |
algorithmId | Algoritmi, jolla signature on laskettu |
| BIN |
signature | Signature data |
| SegmAlgorithm | Kuvan segmentoinnin suorittava algoritmi | |
| INT |
id | Segmentointialgoritmin ID-numero |
| CHAR |
name | Algoritmin nimi |
| Segmentation | Kuvalle suoritettu segmentointi | |
| INT |
imageId | Kuva, jolle segmentointi on suoritettu |
| INT |
algorithmId | Käytetty segmentointialgoritmi |
| INT |
segments | Segmenttien lukumäärä |
| Segment | Kuvan segmentti | |
| INT |
imageId | Kuva, josta segmentti on laskettu |
| INT |
algorithmId | Käytetty segmentointialgoritmi |
| INT |
segmentNbr | Segmentin numero (1...segmenttien lkm.) |
| BIN |
data | Segmenttidata |
| SegmSignature | Kuvasegmentistä laskettu signature | |
| INT |
imageId | Kuva, josta segmentti on irroitettu |
| INT |
segmAlgId | Käytetty segmentointialgoritmi |
| INT |
segmentNbr | Segmentin numero (1...segmenttien lkm.) |
| INT |
searchAlgId | Hakualgoritmi, jolla signature on laskettu |
| BIN |
signature | Signature data |
| Parameter | Parametrimääritys | |
| CHAR |
name | Parametrin nimi |
| CHAR |
value | Parametrin arvo |
Järjestelmän relaatiotauluista muodostuvaa tietokantaa käytetään PicDb-API tietokantarajapinnan kautta.
PicGUI-alijärjestelmä koostuu käytännössä kahdesta osasta, Tcl/Tk:lla ohjelmoidusta ulospäin näkyvästä käyttöliittymästä ja C++:lla ohjelmoidusta API:sta käyttöliittymän ja ydinohjelman välissä. Vaikka Tcl/Tk onkin alunperin luotu C:llä, se on kuitenkin täysin oma kielensä (oikeastaan kaksi kieltä, "ohjelmointikieli" Tcl ja käyttöliittymänrakennuskieli Tk) ja tämän takia käyttöliittymämoduli on pyritty pitämään mahdollisimman paljon omana itsenäisenä palasenaan, joka vain tarpeen vaatiessa kommunikoi muun järjestelmän kanssa PicGUI:n C++ -osan kautta.
Yksi ohjelmiston toiminnan kannalta tärkeimmistä teknisistä määrityksistä on em. Tcl/Tk -käyttöliittymän ja C++:lla ohjelmoitujen järjestelmän muiden osien välinen kommunikointi, koska lähes kaikki järjestelmän toiminnan kannalta kriittinen tieto kulkee tämän yhteyden kautta. Toteutus on seuraavanlainen:
C++ osa koostuu siis edellisen nojalla "transmit" Tcl-komennon toteutusfunktiosta (ja tämän apukomentojen toteutusfunktioista) sekä muiden järjestelmän osien käytössä olevasta joukosta funktioita, joiden avulla voidaan lähettää tietoa käyttöliittymälle.
Tietokantarajapintaa käytetään luomalla instanssi PicDbConnection luokasta. Tämän jälkeen luodaan yhteys kantaan kutsumalla connect metodia. Käyttämällä luokan jäsenfunktioita voidaan suorittaa tietokantaan haku, lisäys, päivitys, poisto tai koko tietokannan reorganisointi, eli uudelleenjärjestäminen, jolloin tietokannan fyysinen tallennus optimoidaan tilankäytön suhteen. Viimeisenä toimenpiteenä yhteys kantaan pitää aina katkaista disconnect metodilla. Muita luokan metodeita ovat commit ja rollback, joilla sitoudutaan suoritettuun transaktioon tai perutaan se.
Useimmat luokan jäsenfunktiot ottavat parametrikseen referenssin TableEntry luokasta johdettuun luokkaan, joka samalla määrää relaatiotaulun, johon toimenpide kohdistetaan. Nämä kutakin relaatiotaulua kohden johdetut luokat sisältävät muuttujat, joihin voidaan tallettaa kyseisen taulun yhden rivin tiedot. Näin luokkia käytetään esim. välittämään kantaan lisättävän rivin tiedot, tai antamaan haussa käytettävät hakuarvot. Esim. id:llä haku ImageInfo taulusta tapahtuu seuraavasti (taulun ainoalla avainkentällä haku ei tietysti löydä kuin korkeintaan yhden rivin, muuten fetchNext metodilla iteroitaisiin rivi riviltä loputkin saman id:n omaavat taulun rivit):
PicDbConnection connection;
ImageInfoEntry entry; // search from ImageInfo table
PicIntSet fields;
connection.connect();
fields.add(1); // "id" is the search field
entry.id = 123; // search for id 123
if (connection.query(entry, fields)) // Perform the query and get the
// first matching row.
{
do
{
...
} while (connection.fetchNext(entry)) // iterate...
}
connection.commit()
connection.disconnect();
PicDbConnection luokan muita tietokantaoperaatioita käytetään vastaavalla periaattella.
Hakualgoritmeille tarvittavia metodeja ovat:
Jos virhettä nostettaessa se määritellään fataaliksi, lakkaa ohjelman suoritus.
HUOM. Koska Tcl/Tk-tulkki ei ole thread-safe, joudutaan muiden kuin pääsäikeen tiedonsiirto GUI:n suuntaan synkronoimaan pakottamalla pääsäikeen suoritus määrävälein C++:n puolelle, jolloin muut säikeet voivat kutsua sopivia PicGUI:n funktiota.
PicGUI-alijärjestelmä sisältää sekä varsinaisen käyttäjälle näkyvän Tcl/Tk:lla tehdyn käyttöliittymän että tämän ja ydinjärjestelmän välillä tapahtuvan kommunikoinnin toteuttavan C++-luokan. Käyttöliittymä pyrkii toimimaan itsenäisesti aina kuin mahdollista, eli liikenne sen ja ytimen välillä pyritään rajaamaan vain välttämättömiin viesteihin. Toisaalta, ylläpidettävä tieto halutaan pitää vain yhdessä paikassa koodia (ohjelman ytimessä), joten käyttöliittymä ei erikseen pidä yllä yleistä tietoa, vaan kysyy tarvitsemansa asiat ohjelman ytimeltä.
Kuten edellä on jo mainittu, PicGUI-alijärjestelmä jakautuu kahteen selkeään osaan; Tcl/Tk-käyttöliittymään ja C++-osaan. C++ -osa on varsin suppea koostuen yhdestä ainoasta PicGUI-luokasta jäsenfunktioineen. Käyttöliittymä on yksi kokonainen moduli, jonka ikkunat ja ikkunoiden osaset on Tcl:n tyyliin toteutettu strukturoidusti mahdollisimman selkeän esitystavan saavuttamiseksi. Tämä tarkoittaa sitä, että pääikkunasta avautuvat ali-ikkunat ovat myös toteutuksellisesti pääikkuna-objektin aliobjekteja ja ikkunoiden osaset (buttonit jne.) kyseisten ikkunoiden aliobjekteja. Hierarkia näkyy erityisesti nimeämisessä (win; win.subwin; win.subwin.button).
PicGUI:n käyttöliittymäosa sisältää valtaosan toiminnallisessa määrittelyssä kuvatuista toiminnoista (käytännössä kaiken,mitä käyttäjä voi interaktiivisesti "tehdä"). PicGUI:n C++ -luokka sisältää joukon funktioita, jotka mahdollistavat tiedonsiirron käyttöliittymän ja ydinjärjestelmän välillä.
C++-osan suhteen mahdolliset poikeustilanteet ovat tunnistamaton kommunikointitapahtuma tai virheellinen määrä parametreja/virheellinen parametrin sisältö tapahtumassa. Tällaisen sattuessa tapahtuma keskeytetään ja viesti virheestä kirjoitetaan virhelokiin ja mahdollisesti inforuutuun, mikäli debug-optio on PicGUI:n osalta päällä. Itse käyttöliittymän mahdollisia poikkeustilanteita ovat käyttäjän antamat virheelliset syötteet sellaisissa kohdissa, joissa käyttäjä itse voi syöttää dataa järjestelmään. Näistä virheistä informoidaan inforuudussa tai erillisellä dialogi-ikkunalla.
C++-osan yleinen toimivuus on varsin helppo testata tekemällä mikä tahansa toiminto, joka aiheuttaa kommunikointia ydinohjelman kanssa. Sen sijaan kaikkien kommunikointitapahtumien yksityiskohtaisen toimivuuden tarkistaminen vaatii järjestelmällisen toimintojen läpikäynnin. Tosin eri kommunikointitapahtumat pyritään ohjelmoimaan teknisesti niin samankaltaisiksi, että muutaman kommunikointitapahtuman testaaminen tuo jo melkoisen varmuuden toiminnasta.
Käyttöliittymän testaamiseen riittää käyttöliittymän sisällä olevien datarakenteiden toimivuuden ja ajantasalla olemisen testaus, sillä muut käyttöliittymässä mahdollisesti olevat virheet näkyvät suoraan käyttäjälle ohjelman ulkonäössä.
PicGUI:n C++ -osa on lähes pelkästään kommunikoinnin toteutusta käyttöliittymän ja ydinohjelman välillä. Tätä kommunikointia tapahtuu luonnollisesti molempiin suuntiin. Kommunikoinnin yksityiskohtaisempi toteutuskuvaus on löytyy kohdasta 4.1 Käyttöliittymärajapinta PicGUI-API. Mahdolliset kommunikointitapahtumat ja niissä siirtyvät parametrit on listattu seuraavassa suunnittain. Listaustapa on:
Teknisessä mielessä PicGUI:n C++-osa on varsin simppeli joskin "rönsyilevä" kommunikointitapahtumien määrästä johtuen. Järjestelmällisyys on siis tärkeää toteutuksessa, että jokainen kommunikointivaihtoehto tulee koodiin oikein mukaan. Samoin Tcl/Tk-puolella tulee käyttää järjestelmällisyyttä aina objektien ja muuttujien nimeämisestä lähtien, sillä ikkunoita/dialogeja ja järjestelmän tilatietoja ylläpitäviä dataobjekteja on melkoinen määrä.
Kustakin algoritmityypistä toteutetaan vähintään yksi algoritmi (segmentoinnista ainoastaan "dummy").
PicDb:n palveluilla toteutetaan järjestelmän kuvien fyysinen tallennus. Tietokannassa pidetään myös muuta järjestelmän tarvitsemaa pysyvää tietoa, kuten erilaisia ohjelman toimintaan vaikuttavia parametreja.
Itse tietokantamoottori, jota rajapinnan kautta käytetään, on mahdollisimman yksinkertainen relaatiotauluperiaatetta noudattava tiedonhallintajärjestelmä. Tämä tarkoittaa sitä, että kukin tietokannan relaatiotaulu sijaitsee omassa tiedostossaan, jossa tietueet, eli relaatiotaulun rivit, on tallennettuna peräkkäin.
PicDb käyttää suorasaantia tietueiden hakemiseen fyysiseltä tallennusmedialta, jolloin yksittäinen tietua saadaan tiedostosta käymättä läpi suurinta osaa tiedoston tietueista. Suorasaanti toteutetaan käyttämällä erillistä indeksitiedostoa kullekin relaatiotaululle.
Source code documentation
PicLib-luokkakirjasto koostuu alla esitetyn listan mukaisista luokista. # merkitsee abstraktia kantaluokkaa, sisennys kuvaa mistä kantaluokasta kukin luokka on johdettu, hakasuluissa esitetty luokan sisältämät attribuutit
BaseDate [PICUSHORT theYear, theMonth, theDay]
BaseTime [PICUSHORT theHour, theMinute, theSecond]
BaseDateTime [BaseDate date, BaseTime time]
BaseReal [PICFLOAT imp, PICUSHORT flags]
BaseString [PICSIZE alloc, size, count, char *rep]
PicClass [const char *className, PICUSHORT instSize]
PicVirtClass [PicVirtClass *base, *derived, *nextSibling, *prevSibling]
PicObjectClass [PICFCREATENEW *createNew]
#PicVirtObject
#PicObject
#PicPrimitive
PicDate : publib BaseDate
PicDateTime [ BaseDateTime dt ]
PicInteger [PICLONG imp, PICBOOL isNullInteger]
PicLogic [PICSHORT val]
PicTime : publib BaseTime
PicString : publib BaseString
PicAssoc [PICINDEX ind, PicObject* obj]
#BaseCollection [PicGenArrayInfo *info, char *content, PICSIZE alloc, ub]
BaseStringArray
PicObjectPtrArray
PicAssocArray
PicNamAssocArray [NameBuffer *names]
#PicObject
#PicCollection
#PicIxCollect
#PicKeyIxCollect
#PicIxMapObject [PicAssocArray assocs]
PicIxMap
PicSortedIxMap [PICIXSORTER* order]
#PicSeqIxCollect
#PicArrayObject [PicObjectPtrArray array]
PicArray
PicSortedArray [PICOBJSORTER* order]
#PicNmCollect
#PicNmMapObject [PicNamAssocArray assocs]
PicNmMap
PicSortedNmMap [PICNMSORTER* order]
PicIterator [PICLONG current]
PicIteratorImp
PicIntSet [PicIntSetData* content]
PicIntArray [PICINT* content, PICSIZE allob, lb, ub]
PicErrorText [BaseString errorText, PicClass* errorClass,
PICUSHORT errorStatus, errorLine,
char* errorFile]
PicFmtErrorText [PicStringStream strStream, PicFmtText fmtText]
PicRaiseFmtError
PicHoldFmtError
PicRaiseFatalError
PicError [BaseString errorText, PicClass* errorClass,
PICUSHORT errorStatus, errorLine, errorNum,
char* errorFile, PicErrorManager* manager,
PicError* next, *last]
PicErrMgrParam
#PicNotifier
PicDefaultNotifier
PicErrorContext [PicErrorContext* previous, PicError* error]
PicTestContext
#PicErrorManager [PICBOOL memoryError, PicErrorContext* currentContext,
PicNotifier* pNotifier]
PicL1ErrorManager
PicErrorLog
#PicVirtObject
#PicStream
PicChainStream [PicChainStream* chain, PicStream* stream]
PicInStringStream [BaseString *stream, PICPOSITION current]
PicStringStream
PicInCharStream [char* stream, PICSIZE stmSize, PICOFFSET current]
PicCharStream
#PicBufferStream [char* buffer, PICOFFSET bufPtr, PICSIZE bufSize]
PicFileStream [PicFile theFile, PICHFILE fHandle
PICBOOL endOfFile, PicOpenMode saveOpenFlags]
PicTextFmt [PicStream *stream, char* format, PICSIZE indent]
PicText [PicStream *theStream]
PicFmtText [char* fmt, PicWrObjArray* pending, PICSIZE indentSize]
BaseString
PicStringText [PicStringStream strStream, PicFmtText fmtText]
PicEnvironment
PicFile [BaseString fName]
PicFileIterator [PicFile file, [OS-depedent handle], PICUINT attr]
PicSemaphore [[OS-depedent data]]
PicThread [PicSemaphore semMutex, PicSemaphore semReady,
PICUSHORT useCount, PICTHREADRESULT res,
PicThreadState tState, PicPriority priority,
PICUSHORT tId, [OS-depedent data]]
PicThreadPointer [PicThread *t]
PicCritSec [PicSemaphore* sem]
Source code documentation
Pääohjelma alustaa ohjelman luomalla tarvittavat yleiset muuttujat. Seuraavaksi käynnistetään käyttöliittymä kutsumalla PicGUI-objektin start-metodia. GUI:n käynnistyttyä luodaan yhteys tietokantaan. Jos järjestelmässä on ohjelmoituna algoritmeja, joita ei tietokannan mukaan ole, lisätään näistä tieto tietokantaan ja käynnistetään tietokannan päivityssäie (DbUpdateThread). Tämän jälkeen toiminta jatkuu PicGUI:n viestien välityksellä PicMain-objektin metodeissa. PicMain-luokka on pääpiirteiltään seuraavan mukainen:
class PicMain
{
public:
PicMain();
PICBOOL startGUI(int argc, char *argv[]);
static void guiHasStarted(void);
static PICBOOL changeSearchType(BaseString searchTypeName);
static PICBOOL newExampleImage(PICULONG listIndex);
static PICBOOL exImageClosed(PICULONG listIndex);
static PICBOOL exImageCleared(PICULONG listIndex);
static PICBOOL setImageAttributes(PicIxCollect ¶ms,
PICULONG listIndex);
static PICBOOL loadImage(BaseString filename,
PicPicture &resultImage,
PICULONG listIndex,
PICBOOL updating);
static PICBOOL saveImage(BaseString filename,
PicPicture &image,
PICULONG listIndex,
PICUSHORT buttonNbr);
static BaseString getSignatureImage(BaseString algName,
PICULONG listIndex);
static PICBOOL getSegmAlgParams(BaseString algName,
PicIxCollect ¶ms);
static PICBOOL setSegmAlgParams(BaseString algName,
PicIxCollect ¶ms);
static PICBOOL segmentImage(BaseString algName,
PicPicture &image,
PICULONG listIndex);
static BaseString getSegment(BaseString algName,
PICULONG listIndex,
PICUSHORT &segNum);
static PICBOOL getImProcAlgParams(BaseString algName,
PicIxCollect ¶ms);
static PICBOOL processImage(BaseString algName,
PicPicture &image,
PicIxCollect ¶ms,
PICUSHORT buttonNbr);
static PICBOOL getSearhAlgParams(BaseString algName,
PicIxCollect ¶ms);
static PICBOOL setSearhAlgParams(BaseString algName,
PicIxCollect ¶ms);
static PICBOOL query(BaseString algName,
PicSeqIxCollect *exImages);
static PICBOOL browseQueryResults(PICUSHORT numOfFirst);
static PICBOOL suspendQuery();
static PICBOOL resumeQuery();
static void setNumOfDbFrames(PICUSHORT frames);
static PICBOOL insertImageToDb(PicPicture &image,
PICULONG listIndex,
PICUSHORT buttonNbr);
static PICBOOL readImageFromDb(PICULONG imageId,
PICULONG listIndex,
PicPicture &resultImage);
static PICBOOL deleteImageFromDb(PICULONG imageId,
PICUSHORT buttonNbr);
static PICBOOL batchInsert(BaseString filename,
PICUSHORT buttonNbr);
static PICBOOL getParams(PicIxCollect ¶ms);
static PICBOOL setParams(PicIxCollect ¶ms);
static PICBOOL exitProgram(PICUSHORT buttonNbr);
static PicMainSharedData globData;
private:
static PicArray examplePics;
static PicArray exampleListIndexes;
static PicGUI gui;
static PicMainDbUser db;
static PicQueryThread queryThread;
static PicMassInsertThread batchThread;
static PicDbUpdateThread dbUpdateThread;
};
Source code documentation
PicGUI koostuu kahdesta päämodulista: Tcl/Tk-käyttöliittymästä ja C++-luokasta. C++:n PicGUI-luokan konstruktori luo ja käynnistää Tcl/Tk-tulkin, joka puolestaan suorittaa määrätyt valmistelut Tcl/Tk:ta varten (uusien käskyjen määrittelyt, tarvittavien muuttujien trace jne.), lukee sisään Tcl/Tk-koodin ja tulkkaa sen.
Luokan muut jäsenfunktiot toteuttavat kommunikaation käyttöliittymän ja ydinohjelman välillä. On huomattava, että kommukaatio suunnassa käyttöliittymä => ydinohjelma toteutetaan itse luodulla uudella Tcl-käskyllä, joten tämän käskyn toteutusfunktio tulee laittaa luokan yksityiseksi jäseneksi, koska käyttöliittymän Tcl/Tk-koodi (tai käytännössä tulkki) on ainoa, jolla on lupa käyttää tätä funktiota. Samoin tämän uuden käskyn C++ - puolen alifunktiot ovat yksityisiä jäseniä. Ohjelmoitavat kommunikaatiotapahtumat ja niissä käytettävät parametrit näkyvät luvun 5.3 Käyttöliittymäosuus -- PicGUI kohdassa "kommunikointi". PicGUI-luokka on pääpiirteiltään seuraavan mukainen:
class PicGUI
{
public:
PicGUI();
~PicGUI ();
PICBOOL start(int argc, char *argv[]);
static PICBOOL sendQueryAdvance(PICUSHORT percentage);
static PICBOOL sendQueryResults(const PicIxCollect &pics);
static PICBOOL infoPrint(BaseString message);
static PICUSHORT simpleDialog(BaseString type, BaseString title, \
BaseString text, BaseString bnames);
static PICBOOL setSearchTypes(BaseStringArray &names);
static PICBOOL setSearchAlgorithms(BaseStringArray &names);
static PICBOOL setSegmentationAlgorithms(BaseStringArray &names);
static PICBOOL setImageProcessingAlgorithms(BaseStringArray &names);
private:
static PICINT transmitCmd(ClientData clientdata, Tcl_Interp *interp, \
PICINT argc, char *argv[]);
static void tr_query(PICINT argc, char *argv[]);
static void tr_load(char *fullname, char *listindex, char *uflag);
static void tr_save(char *fullname, char *listindex, char *dflag);
static void tr_insert(char *name, char *listindex, char *dflag);
static void tr_copy(char *imageid, char *listindex);
static void tr_delete(char *imageid);
static void tr_scroll(int argc, char *argv[]);
static void tr_imageAttr(char *listindex, char *imageparams);
static void tr_options_set(int argc, char *argv[]);
static void tr_options_get(void);
static void tr_process(char *algname, char *picname, \
char *algparams, char *pflag);
static void tr_processParams(char *algname);
static void tr_started(void);
static void tr_algParams_get(char *algname);
static void tr_algParams_set(char *algname, char *algparams);
static void tr_segalgParams_get(char *algname);
static void tr_segalgParams_set(char *algname, char *algparams);
};
Tcl/Tk-koodi on jaoteltu alimoduleihin siten, että pääikkuna muodostaa yhden hierarkisen kokonaisuuden (picsearch.tk & geometry.tk), piirtoikkuna on toinen alimoduli (editor.tk) ja muut pienemmät ikkunat/dialogit kolmas alimoduli (subwins.tk). Tämä jaottelu vastaa siis pääpiirteittäin koodin tiedostoihinjakoa (edellämainittujen tiedostojen lisäksi on olemassa subprocs.tk, joka sisältää yleisfunktioita ja pääikkunan toimintafunktioita). Itse käyttöliittymän toteutus Tcl/Tk:lla on varsin mekaaninen toimenpide, eikä näin vaadi erityistä teknistä dokumentointia. Käyttöliittymän ulkonäkö, toiminnot ja toimintojen sijoittelu näkyvät Toiminnallinen määrittely -dokumentissa. Mainittakoon tässä kuitenkin, että käyttöliittymäobjektien sijoittelussa käytetään kauttaaltaan "place" -geometriamanageria, koska tämä sallii objektien sijoittelun pikselin tarkkuudella ja näin antaa siisteimmän lopputuloksen. Käyttöliittymässä käytetään tavallisia Tk4.1-widgettejä.
Source code documentation
class PicImageFormat : public PicObject
{
public:
virtual PicRawPicture *readPicture(BaseString filename);
virtual PICBOOL writePicture(BaseString filename, PicRawPicture *);
virtual PicRawPicture *readPicture(PicStream &from, PICULONG size) = 0;
virtual PICBOOL writePicture(PicStream &to, PicRawPicture *) = 0;
BaseString name;
PICULONG id;
BaseStringArray fileExtensions;
PICBOOL isLossy;
};
Fyysisesti kuvadata pidetään PicRawPicture-objekteissa.
class PicRawPicture : public PicObject
{
public:
PICUSHORT getWidth() const;
void setWidth(PICUSHORT newWidth);
PICUSHORT getHeight() const;
void setHeight(PICUSHORT newHeight);
unsigned char* getDataPtr() const;
void setDataPtr(unsigned char* newPtr);
private:
Tk_PhotoImageBlock rawImage; // defined in tk.h
};
Loogiset kuvat ovat pääpiirteiltään seuraavanlaisessa luokassa:
class PicPicture : public PicObject
{
public:
PICBOOL loadFromFile(BaseString filename);
PICBOOL writeToFile(BaseString filename);
void setRaw(PicRawPicture *newRaw);
PICULONG id;
BaseString name;
BaseString par1;
BaseString par2;
BaseString filename;
PicArray signatures;
PicArray segmentations;
PicImageFormat *format;
PicRawPicture *raw;
PicBin origData;
PICBOOL identicalToFilename;
BaseString matchRate;
PICUSHORT matchRanking;
};
class PicSearchAlgorithm : public PicObject
{
public:
BaseString name;
PICULONG id;
virtual PICBOOL getParams(PicIxCollect ¶ms)=0;
virtual PICBOOL setParams(PicIxCollect ¶ms)=0;
virtual PICUSHORT compare(PicSignature &firstSig, PicSignature &secSig)=0;
virtual PicSignature *computeSignature(PicPicture &pic)=0;
};
Kullekin hakualgoritmille luodaan normaalisti oma signature-luokka
pääpiirteiltään seuraavanlaisesta kantaluokasta johdettuma:
class PicSignature : public PicObject
{
public:
virtual char *getBin(PICULONG &size) const = 0;
virtual PICBOOL setBin(const char *data, PICULONG size) = 0;
virtual PICULONG algId() const = 0;
virtual BaseString getImage() const;
};
Source code documentation
"fetchNext" metodi hakee "entry" parametriin seuraavan hakuehdot täyttävän rivin.
"insert" funktio lisää "entry" parametrin määräämään relaatiotauluun sisältämänsä rivin.
"remove" funktio toimii vastaavasti kuin "query" funktio, mutta poistaa löytyneet rivit relaatiotaulusta.
"update" funktio toimii niinikään vastaavasti kuin "query", mutta löytyneet relaatiotaulun rivit, eli tietueet, päivitetään annetuilla parametreilla.
"reorganize" järjestää tietokannan levyllä uudestaan. "update" ja "remove" funktioiden jäljiltä relaatiotaulujen tietueet sisältävissä tiedostoissa saattaa olla "aukkoja", eli käyttämättömiä alueita. Tiedostot järjestetään uudelleen, siten että aukot poistuvat. Samalla indeksitiedostot päivitetään vastaavasti.
"connect" ja "disconnect" toteutettavassa, äärimmäisen yksinkertaisessa, tietokantajärjestelmässä ovat lähinnä muodon vuoksi, koska yhteyden voi luoda vain yhteen ja samaan tietokantaan. Nämä metodit ovatkin mukana lähinnä tulevaisuutta ajatellen, jos halutaan siirtyä kehittyneempään tietokantajärjestelmään, jossa voi olla useita tietokantoja.
"commit" ja "rollback" toteutetaan käyttämällä lokitiedostoja, joihin kaikki kantaan kohdistetun muutokset talletetaan. "commit" ja "rollback" aiheuttavat joko lokitiedostoissa olevien tietueiden tallentamisen tietokantaan tai lokitiedostojen tietueiden hylkäämisen. Näiden operaatioiden toteuttaminen projektin puitteissa yksinkertaistettuun tietokantamoottoriin saattaa osoittautua liian työlääksi verrattuna saavutettavaan hyötyyn. Operaatioita käytetään joka tapauksessa ydinohjelmassa tulevaisuuden varalta, jolloin tietokanta mahdollisesti korvataan näitä operaatioita tukevalla tietokannalla.
Jokaista relaatiotaulun tietueita sisältävää tiedostoa kohti PicDbEngine ylläpitää toista tiedostoa, indeksitiedostoa. Siinä on kutakin relaatiotaulun tietuetta kohden indeksiarvo, eli yhdiste avainkenttien arvoista, sekä kyseisen tietueen pituus ja sijainti varsinaisessa tietokantatiedostossa. Näin tietueet voidaan hakea tiedostoista suorasaannilla.