S2RegionCoverer.Options

Options for the S2RegionCoverer.

class S2RegionCoverer

static

class Options {

enum int DEFAULT_MAX_CELLS;

int maxCells();

void setMaxCells(int max_cells);

int minLevel();

void setMinLevel(int min_level);

int maxLevel();

void setMaxLevel(int max_level);

void setFixedLevel(int level);

int levelMod();

void setLevelMod(int level_mod);

int trueMaxLevel();

string toString();

int _maxCells;

int _minLevel;

int _maxLevel;

int _levelMod;

}

Members

Functions

levelMod int levelMod(): If specified, then only cells where (level - min_level) is a multiple of "level_mod" will be used (default 1). This effectively allows the branching factor of the S2CellId hierarchy to be increased. Currently the only parameter values allowed are 1, 2, or 3, corresponding to branching factors of 4, 16, and 64 respectively.
maxCells int maxCells(): Sets the desired maximum number of cells in the approximation. Note the following:
maxLevel int maxLevel(): Default: S2CellId.MAX_LEVEL
minLevel int minLevel(): Sets the minimum and maximum cell levels to be used. The default is to use all cell levels.
setFixedLevel void setFixedLevel(int level): Convenience function that sets both the maximum and minimum cell levels.
setLevelMod void setLevelMod(int level_mod): Undocumented in source.
setMaxCells void setMaxCells(int max_cells): Undocumented in source. Be warned that the author may not have intended to support it.
setMaxLevel void setMaxLevel(int max_level): Undocumented in source.
setMinLevel void setMinLevel(int min_level): Undocumented in source.
toString string toString(): Undocumented in source. Be warned that the author may not have intended to support it.
trueMaxLevel int trueMaxLevel(): Convenience function that returns the maximum level such that

Variables

DEFAULT_MAX_CELLS enum int DEFAULT_MAX_CELLS;: Undocumented in source.
_levelMod int _levelMod;: Undocumented in source.
_maxCells int _maxCells;: Undocumented in source.
_maxLevel int _maxLevel;: Undocumented in source.
_minLevel int _minLevel;: Undocumented in source.

Meta

Source

See Implementation

s2 s2region_coverer S2RegionCoverer classes

Options

constructors

this

functions

static functions