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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of geotrellis-raster_2.11 Show documentation

GeoTrellis is an open source geographic data processing engine for high performance applications.

The 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.raster.mapalgebra.local

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


/**
 * Xor's cell values of rasters or Int values.
 *
 * @note        NoData values will cause the results of this operation
 *              to be NODATA.
 * @note        If used with Double typed rasters, the values
 *              will be rounded to Ints.
 */
object Xor extends LocalTileBinaryOp {
  def combine(z1: Int, z2: Int) =
    if (isNoData(z1) || isNoData(z2)) NODATA
    else z1 ^ z2

  def combine(z1: Double, z2: Double) =
    if(isNoData(z1) || isNoData(z2)) Double.NaN
    else i2d(d2i(z1) ^ d2i(z2))
}

trait XorMethods extends MethodExtensions[Tile] {
  /** Xor a constant Int value to each cell. */
  def localXor(i: Int): Tile = Xor(self, i)
  /** Xor a constant Int value to each cell. */
  def ^(i: Int): Tile = localXor(i)
  /** Xor a constant Int value to each cell. */
  def ^:(i: Int): Tile = localXor(i)
  /** Xor the values of each cell in each raster.  */
  def localXor(r: Tile): Tile = Xor(self, r)
  /** Xor the values of each cell in each raster. */
  def ^(r: Tile): Tile = localXor(r)
  /** Xor the values of each cell in each raster. */
  def localXor(rs: Traversable[Tile]): Tile = Xor(self +: rs.toSeq)
  /** Xor the values of each cell in each raster. */
  def ^(rs: Seq[Tile]): Tile = localXor(rs)
}