this class holds the runtime settings for Frog More...
#include <FrogAPI.h>
Public Member Functions | |
| FrogOptions () | |
Public Attributes | |
| bool | doTok |
| should we run the tokenizer? More... | |
| bool | doLemma |
| should we run the lemmatizer? More... | |
| bool | doMorph |
| should we run the morphological analyzer? More... | |
| bool | doDeepMorph |
| do we want a deep morphological analysis? More... | |
| bool | doMwu |
| should we resolve Multi Word Units? More... | |
| bool | doIOB |
| should we run the IOB Chuker? More... | |
| bool | doNER |
| should we run the Named Entity recognizer? More... | |
| bool | doParse |
| should we run the Dependency Parser? More... | |
| bool | doTagger |
| should we run the Dependency Parser? More... | |
| bool | doSentencePerLine |
| do we want a sentence per line? More... | |
| bool | doQuoteDetection |
| enable quote detection (NOT USED) More... | |
| bool | doRetry |
| set retry mode (MISNOMER) More... | |
| bool | noStdOut |
| do we want output to stdout? More... | |
| bool | doXMLin |
| do we have FoLiA input? More... | |
| bool | doXMLout |
| do we want FoLiA output? More... | |
| bool | doJSONin |
| do we have JSON input? More... | |
| bool | doJSONout |
| do we want JSON output? More... | |
| bool | doServer |
| do we want to run as a server? More... | |
| bool | doKanon |
| do we want FoLiA to be output in a canonical way? More... | |
| bool | test_API |
| do we want to run some tests? More... | |
| bool | hide_timers |
| should we output timing information? More... | |
| bool | interactive |
| are we running from the command line? More... | |
| bool | doAlpinoServer |
| should we try to connect to an Alpino server? More... | |
| bool | doAlpino |
| should we directly run Alpino? More... | |
| int | numThreads |
| limit for the number of threads More... | |
| int | debugFlag |
| value for the generic debug level More... | |
| int | JSON_pp |
| for JSON output, use this value to format. More... | |
| std::string | encoding |
| which input-encoding do we expect More... | |
| std::string | uttmark |
| the string which separates Utterances More... | |
| std::string | listenport |
| determines the port to run the Frog Server on More... | |
| std::string | docid |
| the FoLiA document ID on output. More... | |
| std::string | inputclass |
| the textclass to use on FoLiA input More... | |
| std::string | outputclass |
| the textclass to use on FoLiA output More... | |
| std::string | default_language |
| what is our default language More... | |
| std::set< std::string > | languages |
| all languages to take into account More... | |
| std::string | textredundancy |
| determines how much text is added in the FoLiA More... | |
| bool | correct_words |
| should we allow the tokenizer to correct words? More... | |
| unsigned int | maxParserTokens |
| limit the number of words to Parse More... | |
| std::string | command |
| stores the original command that invoked Frog More... | |
Detailed Description
this class holds the runtime settings for Frog
Constructor & Destructor Documentation
◆ FrogOptions()
| FrogOptions::FrogOptions | ( | ) |
Member Data Documentation
◆ command
| std::string FrogOptions::command |
stores the original command that invoked Frog
◆ correct_words
| bool FrogOptions::correct_words |
should we allow the tokenizer to correct words?
When true, the tokenizer might split words changing the number of words and the text value of the above structure(s). e.g '1984!' to '1984 !'
◆ debugFlag
| int FrogOptions::debugFlag |
value for the generic debug level
This value is used as the debug level for EVERY module. It is however possible to set specific levels per module too.
◆ default_language
| std::string FrogOptions::default_language |
what is our default language
◆ doAlpino
| bool FrogOptions::doAlpino |
should we directly run Alpino?
This assumes that Alpinois installed locally and the Alpino command is working.
◆ doAlpinoServer
| bool FrogOptions::doAlpinoServer |
should we try to connect to an Alpino server?
this assumes that an Alpino Server is set up and running and that it's location is configured correctly.
◆ docid
| std::string FrogOptions::docid |
the FoLiA document ID on output.
◆ doDeepMorph
| bool FrogOptions::doDeepMorph |
do we want a deep morphological analysis?
◆ doIOB
| bool FrogOptions::doIOB |
should we run the IOB Chuker?
◆ doJSONin
| bool FrogOptions::doJSONin |
do we have JSON input?
This is only supported for the Server mode of Frog, it implies JSON output too.
◆ doJSONout
| bool FrogOptions::doJSONout |
do we want JSON output?
◆ doKanon
| bool FrogOptions::doKanon |
do we want FoLiA to be output in a canonical way?
This can be conveniant for testing purposes as it makes sure that nodes from several modules are always in the same order in the XML
◆ doLemma
| bool FrogOptions::doLemma |
should we run the lemmatizer?
◆ doMorph
| bool FrogOptions::doMorph |
should we run the morphological analyzer?
◆ doMwu
| bool FrogOptions::doMwu |
should we resolve Multi Word Units?
◆ doNER
| bool FrogOptions::doNER |
should we run the Named Entity recognizer?
◆ doParse
| bool FrogOptions::doParse |
should we run the Dependency Parser?
◆ doQuoteDetection
| bool FrogOptions::doQuoteDetection |
enable quote detection (NOT USED)
should we enable Quote Detection. This value MUST be false. Quote Detection is NOT supported
◆ doRetry
| bool FrogOptions::doRetry |
set retry mode (MISNOMER)
when TRUE, we assume we are retrying one ore more inputfiles, and we skip those input files for which an outputfile already exists.
◆ doSentencePerLine
| bool FrogOptions::doSentencePerLine |
do we want a sentence per line?
should we see every input-line as a separate sentence?
◆ doServer
| bool FrogOptions::doServer |
do we want to run as a server?
currently only TCP servers are supported
◆ doTagger
| bool FrogOptions::doTagger |
should we run the Dependency Parser?
◆ doTok
| bool FrogOptions::doTok |
should we run the tokenizer?
◆ doXMLin
| bool FrogOptions::doXMLin |
do we have FoLiA input?
◆ doXMLout
| bool FrogOptions::doXMLout |
do we want FoLiA output?
◆ encoding
| std::string FrogOptions::encoding |
which input-encoding do we expect
using the capabilities of the Ucto tokenizer, Frog can handle a lot of input encodings. The default is UTF8. The output will always be in UTF8.
◆ hide_timers
| bool FrogOptions::hide_timers |
should we output timing information?
normaly Frog outputs timing information for the several modules, but it may be usefull to skip that
◆ inputclass
| std::string FrogOptions::inputclass |
the textclass to use on FoLiA input
◆ interactive
| bool FrogOptions::interactive |
are we running from the command line?
◆ JSON_pp
| int FrogOptions::JSON_pp |
for JSON output, use this value to format.
normally JSON will be outputted as one (very long) line. Using a value of JSON_pp >0 it wil be 'pretty-printed' indented with that value.
◆ languages
| std::set<std::string> FrogOptions::languages |
all languages to take into account
◆ listenport
| std::string FrogOptions::listenport |
determines the port to run the Frog Server on
◆ maxParserTokens
| unsigned int FrogOptions::maxParserTokens |
limit the number of words to Parse
◆ noStdOut
| bool FrogOptions::noStdOut |
do we want output to stdout?
◆ numThreads
| int FrogOptions::numThreads |
limit for the number of threads
◆ outputclass
| std::string FrogOptions::outputclass |
the textclass to use on FoLiA output
◆ test_API
| bool FrogOptions::test_API |
do we want to run some tests?
This will run some generic tests and then stop. No real frogging is done!
◆ textredundancy
| std::string FrogOptions::textredundancy |
determines how much text is added in the FoLiA
possible values are 'full', 'minimal' and 'none'.
'none': no text (<t>) nodes are added to higher structure nodes like <s> and <p>.
'minimal': text is added to the structure above <w>. Mostly <s> nodes
'full': text is added to all structure nodes. This might result in a lot of (redundant) text.
◆ uttmark
| std::string FrogOptions::uttmark |
the string which separates Utterances
The documentation for this class was generated from the following files:
- include/frog/FrogAPI.h
- src/FrogAPI.cxx
