/*---------------- FILE HEADER ------------------------------------------
This file is part of deegree.
Copyright (C) 2001-2006 by:
EXSE, Department of Geography, University of Bonn
http://www.giub.uni-bonn.de/deegree/
lat/lon GmbH
http://www.lat-lon.de
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Contact:
Andreas Poth
lat/lon GmbH
Aennchenstr. 19
53177 Bonn
Germany
E-Mail: poth@lat-lon.de
Prof. Dr. Klaus Greve
Department of Geography
University of Bonn
Meckenheimer Allee 166
53115 Bonn
Germany
E-Mail: greve@giub.uni-bonn.de
---------------------------------------------------------------------------*/
package org.deegree.processing.raster.classification;
/**
* A RangeRule defines two n-dimensional boundaries (arrays). A data
* vector to classify will be compared to each field of both vectors
* and just if each value of a data vector is >= the corresponding
* field of the min array and <= of the max array it matches the
* rule.<BR>
* This rule is conceptional identical to
* @see org.deegree.processing.raster.classification.FixedValuesRule
*
*
* @version $Revision: 1.2 $
* @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
* @author last edited by: $Author: poth $
*
* @version 1.0. $Revision: 1.2 $, $Date: 2006/08/17 12:20:37 $
*
* @since 2.0
*/
public class RangeRule extends AbstractClassificationRule {
private double[] min;
private double[] max;
private int accuracy = 0;
/**
*
* @param classId
* @param description
* @param representativeValue
* @param min minimum boundary array of a RangeRule
* @param max maximum boundary array of a RangeRule
* @throws ClassificationException
*/
public RangeRule( int classId, String description, double[] representativeValue,
double[] min, double[] max ) throws ClassificationException {
super( classId, description, representativeValue );
this.min = min;
this.max = max;
if ( min.length != max.length ) {
throw new ClassificationException( Messages.getString( "RangeRule.ARRAYLENGTHERROR" ) );
}
}
/**
* returns true if each field of the passed vector is >= the corresponding
* field of the min array and <= of the max array
*
* @param vector
* @throws ClassificationException
*/
public boolean matches( double[] vector )
throws ClassificationException {
if ( vector.length != min.length ) {
throw new ClassificationException( "RangeRule.VECTORLENGTHERROR" );
}
accuracy = 0;
for ( int i = 0; i < vector.length; i++ ) {
if ( vector[i] < min[i] || vector[i] > max[i] ) {
return false;
}
}
accuracy = 1;
return true;
}
/**
* returns a value indicating the accuracy a classified vector matches
* a rule. For @see RangeRule the returned value will be 1 if the vector
* matches a rule and 0 if does not.
*
* @return
*/
public double getAccuracy() {
return accuracy;
}
}
/* ********************************************************************
Changes to this class. What the people have been up to:
$Log: RangeRule.java,v $
Revision 1.2 2006/08/17 12:20:37 poth
implementation completed
Revision 1.1 2006/08/16 21:00:11 poth
initial check in
********************************************************************** */