org.openimaj.image.mask

Class AbstractMaskedObject<M extends Image<?,M>>

java.lang.Object

org.openimaj.image.mask.AbstractMaskedObject<M>

Type Parameters:

M - The Image type of the mask.

All Implemented Interfaces:

MaskedObject<M>

Direct Known Subclasses:

AvgBrightness, HueStats, MaskedRobustContrastEqualisation, Naturalness, Saturation, SaturationVariation, Sharpness, SharpnessVariation

public abstract class AbstractMaskedObject<M extends Image<?,M>>
extends Object
implements MaskedObject<M>

Abstract base implementation of a MaskedObject.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
protected M	mask

Constructor Summary

Constructors

Constructor and Description
AbstractMaskedObject() Default constructor with a null mask.
AbstractMaskedObject(M mask) Construct with the given mask.

Method Summary

Methods

Modifier and Type	Method and Description
M	getMask()
void	setMask(M mask) Set the mask image.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mask

protected M extends Image<?,M> mask

Constructor Detail

AbstractMaskedObject

public AbstractMaskedObject()

Default constructor with a null mask.

AbstractMaskedObject

public AbstractMaskedObject(M mask)

Construct with the given mask.

Parameters:

mask - the mask.

Method Detail

getMask

public M getMask()

Specified by:

getMask in interface MaskedObject<M extends Image<?,M>>

Returns:

the mask image.

setMask

public void setMask(M mask)

Description copied from interface: MaskedObject

Set the mask image.

Specified by:

setMask in interface MaskedObject<M extends Image<?,M>>

Parameters:

mask - the mask.