geotrellis.engine.RasterLayer.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of geotrellis-engine_2.11 Show documentation
GeoTrellis is an open source geographic data processing engine for high performance applications.
There is a newer version: 0.10.3
Show newest version
/*
 * Copyright (c) 2014 Azavea.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package geotrellis.engine

import geotrellis._
import geotrellis.raster._
import geotrellis.vector.Extent
import geotrellis.util.Filesystem

import scala.concurrent._
import scala.concurrent.Future
import scala.util._

import akka.actor.ActorSystem
import akka.io.IO
import akka.pattern.ask
import akka.util.Timeout
import scala.concurrent.Await
import scala.concurrent.duration._

import spray.http._
import spray.client.pipelining._

import java.io.File


/**
 * Represents a Raster Layer that can give detailed information
 * about the Raster it represents, cache the raster, and get the
 * raster cropped to an extent or at a different resolution.
 *
 * This represents a layer in a bound Context, not an abstract
 * representation of the Raster. In other words, if you are
 * holding one of these objects, then the code that uses it
 * should only execute on the machine that the RasterLayer is
 * from. If you pass around RasterLayers, you will be passing around
 * the cache as well, which is not ideal.
 *
 * To implement a new RasterLayer, inherit from this class, implement
 * the cache(c: Cache) method for caching the raster layer, and implement
 * the getRaster() (for getting a Raster with it's native RasterExtent) and
 * getRaster(rasterExtent: RasterExtent) (for getting a Raster at a different
 * extent\resolution). Optionally you can override getRaster(extent: Extent),
 * which by default just creates a RasterExtent with that extent snapped to
 * the raster's native resolution.
 */
@deprecated("geotrellis-engine has been deprecated", "Geotrellis Version 0.10")
abstract class RasterLayer(val info: RasterLayerInfo) {
  private var _cache: Option[Cache[String]] = None
  protected def getCache =
    _cache match {
      case Some(c) => c
      case None =>
        sys.error("No cache is currently set. Check isCached before accessing this member.")
    }

  def setCache(c: Option[Cache[String]]) = {
    _cache = c
  }

  private var _isCached = false
  def isCached = _isCached

  def cache(): Unit = {
    _cache match {
      case Some(c) =>
        cache(c)
        _isCached = true
        info.cached = true
      case None => //pass
    }
  }

  protected def cache(c: Cache[String]): Unit

  def getRaster(): Tile = getRaster(None)
  def getRaster(targetExtent: Option[RasterExtent]): Tile

  def getRaster(extent: Extent): Tile =
    getRaster(Some(info.rasterExtent.createAlignedRasterExtent(extent)))

  def getTile(tileCol: Int, tileRow: Int): Tile = getTile(tileCol, tileRow,None)
  def getTile(tileCol: Int, tileRow: Int, targetExtent: Option[RasterExtent]): Tile
}

@deprecated("geotrellis-engine has been deprecated", "Geotrellis Version 0.10")
abstract class UntiledRasterLayer(info: RasterLayerInfo) extends RasterLayer(info) {
  def getTile(tileCol: Int, tileRow: Int, targetExtent: Option[RasterExtent]) =
    getRaster(targetExtent)
}

@deprecated("geotrellis-engine has been deprecated", "Geotrellis Version 0.10")
object RasterLayer {
  /**
   * Build a RasterLayer instance given a path to a JSON file.
   */
  def fromPath(path: String): Try[RasterLayer] =
    try {
      val base = Filesystem.basename(path) + ".json"
      fromJSON(Filesystem.readText(path), base)
    } catch {
      case e: Exception => Failure(e)
    }

  def fromFile(f: File): Try[RasterLayer] = RasterLayer.fromPath(f.getAbsolutePath)

  /**
    * Build a RasterLayer instance given a JSON string.
   */
  def fromJSON(data: String, basePath: String): Try[RasterLayer] =
    try {
      Success(json.RasterLayerParser(data, basePath))
    } catch {
      case e: Exception => Failure(e)
    }

  def fromUrl(jsonUrl: String, d: Duration = 5 seconds)
             (implicit t: Timeout = 5 seconds): Try[RasterLayer] = {
    val (system, shutdown) =
      if(GeoTrellis.isInit)
        // If the GeoTrellis.engine is being used, use it's Actor System
        (GeoTrellis.engine.system, { () => })
      else {
        // otherwise, create a temporary one
        val s = ActorSystem(s"arg_url_request_${java.util.UUID.randomUUID}")
        (s, () => s.shutdown)
      }
    implicit val s = system
    import s.dispatcher

    try {
      val pipeline = sendReceive ~> unmarshal[String]
      val response: Future[String] =
        pipeline(Get(jsonUrl))

      val json = Await.result(response, d)
      fromJSON(json, jsonUrl)
    } catch {
      case e: Exception => Failure(e)
    } finally {
      shutdown()
    }
  }
}