geotrellis.raster.mapalgebra.local.Max.scala Maven / Gradle / Ivy

Go to download
/*
 * 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.raster.mapalgebra.local

import geotrellis.raster._
import geotrellis.util.MethodExtensions


/**
 * Gets maximum values.
 *
 * @note          Max handles NoData values such that taking the Max
 *                between a value and NoData returns NoData.
 */
object Max extends LocalTileBinaryOp {
  def combine(z1:Int,z2:Int) =
    if (isNoData(z1) || isNoData(z2)) NODATA
    else math.max(z1,z2)

  def combine(z1:Double,z2:Double) =
    if (isNoData(z1) || isNoData(z2)) Double.NaN
    else math.max(z1,z2)
}

trait MaxMethods extends MethodExtensions[Tile] {
  /** Max a constant Int value to each cell. */
  def localMax(i: Int): Tile = Max(self, i)
  /** Max a constant Double value to each cell. */
  def localMax(d: Double): Tile = Max(self, d)
  /** Max the values of each cell in each raster.  */
  def localMax(r: Tile): Tile = Max(self, r)
  /** Max the values of each cell in each raster.  */
  def localMax(rs: Traversable[Tile]): Tile = Max(self +: rs.toSeq)
}