org.openimaj.image.mask.AbstractMaskedObject Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of core-image Show documentation

Core definitions of images, pixels and connected components. Also contains interfaces for processors for these basic types. Includes loading, saving and displaying images.

There is a newer version: 1.3.10

Show newest version

/**
 * Copyright (c) 2011, The University of Southampton and the individual contributors.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 *   * 	Redistributions of source code must retain the above copyright notice,
 * 	this list of conditions and the following disclaimer.
 *
 *   *	Redistributions in binary form must reproduce the above copyright notice,
 * 	this list of conditions and the following disclaimer in the documentation
 * 	and/or other materials provided with the distribution.
 *
 *   *	Neither the name of the University of Southampton nor the names of its
 * 	contributors may be used to endorse or promote products derived from this
 * 	software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.openimaj.image.mask;

import org.openimaj.image.Image;

/**
 * Abstract base implementation of a {@link MaskedObject}.
 * 
 * @author Jonathon Hare ([email protected])
 *
 * @param  The {@link Image} type of the mask.
 */
public abstract class AbstractMaskedObject> implements MaskedObject {
	protected M mask;
	
	/**
	 * Default constructor with a null mask.
	 */
	public AbstractMaskedObject() {}
	
	/**
	 * Construct with the given mask.
	 * @param mask the mask.
	 */
	public AbstractMaskedObject(M mask) {
		this.mask = mask;
	}
	
	/* (non-Javadoc)
	 * @see org.openimaj.image.processor.MaskedImageProcessor#getMask()
	 */
	@Override
	public M getMask() {
		return mask;
	}
	
	/* (non-Javadoc)
	 * @see org.openimaj.image.processor.MaskedImageProcessor#setMask(org.openimaj.image.Image)
	 */
	@Override
	public void setMask(M mask) {
		this.mask = mask;
	}
}