01: /*
02: * GeoTools - OpenSource mapping toolkit
03: * http://geotools.org
04: * (C) 2003-2006, GeoTools Project Managment Committee (PMC)
05: * (C) 2001, Institut de Recherche pour le Développement
06: *
07: * This library is free software; you can redistribute it and/or
08: * modify it under the terms of the GNU Lesser General Public
09: * License as published by the Free Software Foundation;
10: * version 2.1 of the License.
11: *
12: * This library is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * This package contains documentation from OpenGIS specifications.
18: * OpenGIS consortium's work is fully acknowledged here.
19: */
20: package org.geotools.referencing.operation;
21:
22: // OpenGIS dependencies
23: import org.opengis.referencing.operation.MathTransform;
24: import org.opengis.referencing.operation.Matrix;
25:
26: // Geotools dependencies
27: import org.geotools.referencing.operation.matrix.XMatrix; // For javadoc
28:
29: /**
30: * Interface for linear {@link MathTransform}s. A linear transform can be express as an affine
31: * transform using a {@linkplain #getMatrix matrix}. The {@linkplain Matrix#getNumCol number of
32: * columns} is equals to the number of {@linkplain #getSourceDimensions source dimensions} plus 1,
33: * and the {@linkplain Matrix#getNumRow number of rows} is equals to the number of
34: * {@linkplain #getTargetDimensions target dimensions} plus 1.
35: *
36: * @since 2.0
37: * @source $URL: http://svn.geotools.org/geotools/tags/2.4.1/modules/library/referencing/src/main/java/org/geotools/referencing/operation/LinearTransform.java $
38: * @version $Id: LinearTransform.java 24510 2007-02-19 19:52:21Z desruisseaux $
39: * @author Martin Desruisseaux
40: */
41: public interface LinearTransform extends MathTransform {
42: /**
43: * Returns this transform as an affine transform matrix.
44: */
45: Matrix getMatrix();
46:
47: /**
48: * Tests whether this transform does not move any points, by using the provided
49: * {@code tolerance} value. The signification of <cite>tolerance value</cite> is
50: * the same than in the following pseudo-code:
51: *
52: * <blockquote><pre>
53: * {@linkplain #getMatrix()}.{@linkplain XMatrix#isIdentity(double) isIdentity}(tolerance);
54: * </pre></blockquote>
55: *
56: * @since 2.4
57: */
58: boolean isIdentity(double tolerance);
59: }
|