Pyramid (Groovy Documentation)

geoscript.layer.Pyramid

@groovy.transform.EqualsAndHashCode
@groovy.transform.ToString(includeNames: true, excludes: [grids, minGrid, maxGrid])
class Pyramid
extends java.lang.Object

The Tile Pyramid

Authors:: Jared Erickson

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static enum`	`Pyramid.Origin`	The Origin enumeration

Properties Summary

Properties
Type	Name and description
`Bounds`	`bounds` The Bounds
`java.util.List<Grid>`	`grids` The List of Grids
`Pyramid.Origin`	`origin` The Origin
`Projection`	`proj` The Projection
`int`	`tileHeight` The tile height
`int`	`tileWidth` The tile width

Constructor Summary

Constructors
Constructor and description
`Pyramid()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Bounds`	`bounds(Point p, long z, int width, int height)` Find the Bounds around a Point at a given zoom level for a canvas of a given width and height
	`Bounds`	`bounds(Tile t)` Calculate the Bounds for the given Tile
	`static Pyramid`	`createGlobalGeodeticPyramid(Map options)` Create a Pyramid with Grids for common global geodetic tile sets.
	`static Pyramid`	`createGlobalMercatorPyramid(Map options)` Create a Pyramid with Grids for common global web mercator tile sets.
	`static Pyramid`	`fromString(java.lang.String str)` Create a Pyramid from a String.
	`Grid`	`getMaxGrid()` Get the max Grid by zoom level
	`Grid`	`getMinGrid()` Get the min Grid by zoom level
	`Map`	`getTileCoordinates(Bounds b, long z)` Get Tile coordinates (minX, minY, maxX, maxY) for the given Bounds and zoom level
	`Map`	`getTileCoordinates(Bounds b, Grid g)` Get Tile coordinates (minX, minY, maxX, maxY) for the given Bounds and Grid
	`Grid`	`grid(long z)` Find the Grid for the given zoom level
	`Grid`	`grid(Bounds b, double resX, double resY)` Find the best Grid for the given Bounds and XY resolutions
	`Grid`	`grid(Bounds b, int w, int h)` Find the best Grid for the given Bounds and image width and height

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - Bounds bounds
    
    The Bounds
  - java.util.List<Grid> grids
    
    The List of Grids
  - Pyramid.Origin origin
    
    The Origin
  - Projection proj
    
    The Projection
  - int tileHeight
    
    The tile height
  - int tileWidth
    
    The tile width
- Constructor Detail
  - Pyramid()
- Method Detail
  - Bounds bounds(Point p, long z, int width, int height)
    
    Find the Bounds around a Point at a given zoom level for a canvas of a given width and height
    Parameters:
    p - The Point (in the Pyramid's projection)
    z - The zoom level
    width - The canvas width
    height - The canvas height
    Returns:
    a Bounds
  - Bounds bounds(Tile t)
    
    Calculate the Bounds for the given Tile
    Parameters:
    t - The Tile
    Returns:
    A Bounds
  - static Pyramid createGlobalGeodeticPyramid(Map options)
    
    Create a Pyramid with Grids for common global geodetic tile sets. http://wiki.osgeo.org/wiki/Tile_Map_Service_Specification#global-geodetic
    Parameters:
    options - The optional named parameters:
    
    maxZoom = The max zoom level (defaults to 19)
    Returns:
    A Pyramid
  - static Pyramid createGlobalMercatorPyramid(Map options)
    
    Create a Pyramid with Grids for common global web mercator tile sets. http://wiki.openstreetmap.org/wiki/Zoom_levels
    Parameters:
    options - The optional named parameters:
    
    origin = The Pyramid Origin (defaults to bottom left)
    
    maxZoom = The max zoom level (defaults to 19)
    Returns:
    A Pyramid
  - static Pyramid fromString(java.lang.String str)
    
    Create a Pyramid from a String. The String can be a well known name (GlobalMercator or GlobalMercatorBottomLeft), a JSON String or File, an XML String or File, or a CSV String or File
    Parameters:
    str - A Pyramid String or File
    Returns:
    A Pyramid or null
  - Grid getMaxGrid()
    
    Get the max Grid by zoom level
    Returns:
    THe max Grid by zoom level
  - Grid getMinGrid()
    
    Get the min Grid by zoom level
    Returns:
    The min Grid by zoom level
  - Map getTileCoordinates(Bounds b, long z)
    
    Get Tile coordinates (minX, minY, maxX, maxY) for the given Bounds and zoom level
    Parameters:
    b - The Bounds
    z - The zoom level
    Returns:
    A Map with tile coordinates (minX, minY, maxX, maxY)
  - Map getTileCoordinates(Bounds b, Grid g)
    
    Get Tile coordinates (minX, minY, maxX, maxY) for the given Bounds and Grid
    Parameters:
    b - The Bounds
    g - The Grid
    Returns:
    A Map with tile coordinates (minX, minY, maxX, maxY)
  - Grid grid(long z)
    
    Find the Grid for the given zoom level
    Parameters:
    z - The zoom level
    Returns:
    The Grid or null
  - Grid grid(Bounds b, double resX, double resY)
    
    Find the best Grid for the given Bounds and XY resolutions
    Parameters:
    b - The Bounds
    resX - The x resolution
    resY - The y resolution
    Returns:
    A best Grid or null
  - Grid grid(Bounds b, int w, int h)
    
    Find the best Grid for the given Bounds and image width and height
    Parameters:
    b - The Bounds
    w - The image width
    h - The image height
    Returns:
    The best Grid or null

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Pyramid

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

Bounds bounds

java.util.List<Grid> grids

Pyramid.Origin origin

Projection proj

int tileHeight

int tileWidth

Constructor Detail

Pyramid()

Method Detail

Bounds bounds(Point p, long z, int width, int height)

Bounds bounds(Tile t)

static Pyramid createGlobalGeodeticPyramid(Map options)

static Pyramid createGlobalMercatorPyramid(Map options)

static Pyramid fromString(java.lang.String str)

Grid getMaxGrid()

Grid getMinGrid()

Map getTileCoordinates(Bounds b, long z)

Map getTileCoordinates(Bounds b, Grid g)

Grid grid(long z)

Grid grid(Bounds b, double resX, double resY)

Grid grid(Bounds b, int w, int h)