boofcv.struct.convolve.KernelBase Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ip Show documentation

BoofCV is an open source Java library for real-time computer vision and robotics applications.

There is a newer version: 0.26

/*
 * Copyright (c) 2011-2015, Peter Abeles. All Rights Reserved.
 *
 * This file is part of BoofCV (http://boofcv.org).
 *
 * 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 boofcv.struct.convolve;


/**
 * Base class for all convolution kernels.
 *
 * @author Peter Abeles
 */
public abstract class KernelBase {
	/* number of elements in the kernel */
	public int width;

	/** which index is the kernel's origin.  For symmetric kernels with an odd width it is width/2 */
	public int offset;

	protected KernelBase(int width) {
		if (width <= 0)
			throw new IllegalArgumentException("Kernel width must be greater than zero not "+width);
		this.width = width;
		this.offset = width/2;
	}

	protected KernelBase(int width, int offset) {
		if (width <= 0)
			throw new IllegalArgumentException("Kernel width must be greater than zero not "+width);
		if (offset < 0 || offset >= width)
			throw new IllegalArgumentException("The offset must be inside the kernel's bounds");
		this.width = width;
		this.offset = offset;
	}

	protected KernelBase() {
	}

	/**
	 * The kernel's width.  This is an odd number.
	 *
	 * @return Kernel's width.
	 */
	public int getWidth() {
		return width;
	}

	/**
	 * The radius is defined as the width divided by two.
	 *
	 * @return The kernel's radius.
	 */
	public int getRadius() {
		return width / 2;
	}

	/**
	 * Which index is the origin in the kernel
	 */
	public int getOffset() {
		return offset;
	}

	/**
	 * Returns the dimension of this kernel, 1D or 2D.
	 *
	 * @return Kernel's dimension
	 */
	public abstract int getDimension();

	public abstract boolean isInteger();

	public abstract T copy();
}