Class DefaultMathTransformFactory
- All Implemented Interfaces:
Parser
,MathTransformFactory
,Factory
CRS
or MathTransforms
classes instead.
Standard parameters
MathTransform
instances are created from parameter values.
The parameters expected by each operation available in a default Apache SIS installation is
listed here.
The set of parameters varies for each operation or projection, but the following can be considered typical:
- A semi-major and semi-minor axis length in metres.
- A central meridian and latitude of origin in decimal degrees.
- A scale factor, which default to 1.
- A false easting and false northing in metres, which default to 0.
Each descriptor has many aliases, and those aliases may vary between different projections.
For example, the false easting parameter is usually called "false_easting"
by OGC, while EPSG uses various names like False easting
or Easting at
false origin
.
Dynamic parameters
A few non-standard parameters are defined for compatibility reasons, but delegates their work to standard parameters. Those dynamic parameters are not listed in the parameter values. Dynamic parameters are:"earth_radius"
, which copy its value to the"semi_major"
and"semi_minor"
parameter values."inverse_flattening"
, which compute the"semi_minor"
value from the"semi_major"
parameter value."standard_parallel"
expecting an array of typedouble[]
, which copy its elements to the"standard_parallel_1"
and"standard_parallel_2"
parameter scalar values.
The main purpose of those dynamic parameters is to support some less commonly used conventions without duplicating the most commonly used conventions. The alternative ways are used in netCDF files for example, which often use spherical models instead of ellipsoidal ones.
Mandatory and optional parameters
Parameters are flagged as either mandatory or optional. A parameter may be mandatory and still have a default value. In the context of this package, "mandatory" means that the parameter is an essential part of the projection defined by standards. Such mandatory parameters will always appears in any Well Known Text (WKT) formatting, even if not explicitly set by the user. For example, the central meridian is typically a mandatory parameter with a default value of 0° (the Greenwich meridian).Optional parameters, on the other hand, are often non-standard extensions. They will appear in WKT formatting only if the user defined explicitly a value which is different than the default value.
Operation methods discovery
OperationMethod
describes all the parameters expected for instantiating a particular kind of
math transform. The set of operation methods known to this factory can be obtained in two ways:
The default way is to scan the module path. See MathTransformProvider
for indications about how to add
custom coordinate operation methods in a default Apache SIS installation.
Thread safety
This class is safe for multi-thread usage if all referencedOperationMethod
instances are thread-safe.
There is typically only one MathTransformFactory
instance for the whole application.- Since:
- 0.6
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Deprecated, for removal: This API element is subject to removal in a future version. -
Constructor Summary
ConstructorsConstructorDescriptionCreates a new factory which will discover operation methods with aServiceLoader
.DefaultMathTransformFactory
(Iterable<? extends OperationMethod> methods) Creates a new factory which will use the given operation methods. -
Method Summary
Modifier and TypeMethodDescriptionReturns a builder for a parameterized math transform using the specified operation method.caching
(boolean enabled) Returns a factory for the same transforms as this factory, but with caching potentially disabled.createAffineTransform
(Matrix matrix) Creates an affine transform from a matrix.createBaseToDerived
(CoordinateReferenceSystem baseCRS, ParameterValueGroup parameters, CoordinateSystem derivedCS) Deprecated.Replaced bybuilder(String)
.Creates a transform by concatenating two existing transforms.createCoordinateSystemChange
(CoordinateSystem source, CoordinateSystem target, Ellipsoid ellipsoid) Deprecated, for removal: This API element is subject to removal in a future version.Replaced by the following pattern:var builder = builder("Coordinate system conversion"); builder.setSourceAxes(source, ellipsoid); builder.setTargetAxes(target, ellipsoid); return builder.create();
createFromWKT
(String wkt) Creates a math transform object from a Well Known Text (WKT).createFromXML
(String xml) Deprecated.createParameterizedTransform
(ParameterValueGroup parameters) Deprecated.This constructor is ambiguous when axis directions are parts of the map projection definition as inTransverse Mercator (South Orientated)
.createParameterizedTransform
(ParameterValueGroup parameters, DefaultMathTransformFactory.Context context) Deprecated, for removal: This API element is subject to removal in a future version.Replaced by a builder pattern withbuilder(String)
.createPassThroughTransform
(int firstAffectedCoordinate, MathTransform subTransform, int numTrailingCoordinates) Creates a transform which passes through a subset of coordinates to another transform.getAvailableMethods
(Class<? extends SingleOperation> type) Returns a set of available methods for coordinate operations of the given type.getDefaultParameters
(String method) Deprecated.This way to create parameterized transform is ambiguous.Deprecated.Replaced byMathTransformBuilder.getMethod()
.getOperationMethod
(String identifier) Returns the operation method for the specified name or identifier.provider()
Returns the default provider ofMathTransform
instances.void
reload()
Notifies this factory that the elements provided by theIterable<OperationMethod>
may have changed.swapAndScaleAxes
(MathTransform parameterized, DefaultMathTransformFactory.Context context) Deprecated, for removal: This API element is subject to removal in a future version.Considered internal API because the definition of "normalized" is implementation-dependent.Methods inherited from class AbstractFactory
getVendor, toString
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface Factory
getVendor
-
Constructor Details
-
DefaultMathTransformFactory
public DefaultMathTransformFactory()Creates a new factory which will discover operation methods with aServiceLoader
. TheOperationMethod
implementations shall be listed inmodule-info.java
as provider of theorg.opengis.referencing.operation.OperationMethod
service.DefaultMathTransformFactory
scans the providers of all modules in order to list all available operation methods. Currently, only operation methods implementing theMathTransformProvider
interface can be used by thecreate(…)
methods in this class.- See Also:
-
DefaultMathTransformFactory
Creates a new factory which will use the given operation methods. The given iterable is stored by reference — its content is not copied — in order to allow deferredOperationMethod
constructions. Note that by default, only operation methods that implement theMathTransformProvider
interface can be used by thecreate(…)
methods in this class.Requirements
- The given iterable should not contain duplicated elements.
- The given iterable shall be stable: all elements returned by the first iteration must also be
returned by any subsequent iterations, unless
reload()
has been invoked. OperationMethod
instances should also implementMathTransformProvider
.- All
OperationMethod
instances shall be thread-safe. - The
Iterable
itself does not need to be thread-safe since all usages will be synchronized as below:synchronized (methods) { for (OperationMethod method : methods) { // Use the method here. } }
- Parameters:
methods
- the operation methods to use, stored by reference (not copied).
-
-
Method Details
-
provider
Returns the default provider ofMathTransform
instances. This is the factory used by the Apache SIS library when no non-nullMathTransformFactory
has been explicitly specified. This method can be invoked directly, or indirectly throughServiceLoader.load(MathTransformFactory.class)
.- Returns:
- the default provider of math transforms.
- Since:
- 1.4
- See Also:
-
caching
Returns a factory for the same transforms as this factory, but with caching potentially disabled. By default,DefaultMathTransformFactory
caches theMathTransform
instances for sharing existing instances when transforms are created many times with the same set of parameters. However, this caching may be unnecessarily costly when the transforms to create are known to be short lived. This method allows to get a factory better suited for short-lived objects.This method does not modify the state of this factory. Instead, different factory instances for the different caching policy are returned.
- Parameters:
enabled
- whether caching should be enabled.- Returns:
- a factory for the given caching policy.
- Since:
- 1.1
-
getAvailableMethods
Returns a set of available methods for coordinate operations of the given type. Thetype
argument can be used for filtering the kind of operations described by the returnedOperationMethod
s. The argument is usually (but not restricted to) one of the following types:Conversion
for coordinate operations described by definitions (including map projections).Transformation
for coordinate operations described by empirically derived parameters.-
invalid reference
org.opengis.referencing.operation.PointMotionOperation
SingleOperation
for all coordinate operations.
OperationMethod
elements than requested if thisMathTransformFactory
does not support filtering by the given type.- Specified by:
getAvailableMethods
in interfaceMathTransformFactory
- Parameters:
type
-SingleOperation.class
for fetching all operation methods,Transformation.class
for operations defined by empirical parameters, etc.- Returns:
- methods available in this factory for coordinate operations of the given type.
- See Also:
-
getOperationMethod
Returns the operation method for the specified name or identifier. The given argument shall be either a method name (e.g.Transverse Mercator
) or one of its identifiers (e.g."EPSG:9807"
).The search is case-insensitive. Comparisons against method names can be heuristic.
If more than one method match the given identifier, then the first (according iteration order) non-deprecated matching method is returned. If all matching methods are deprecated, the first one is returned.
- Parameters:
identifier
- the name or identifier of the operation method to search.- Returns:
- the coordinate operation method for the given name or identifier.
- Throws:
NoSuchIdentifierException
- if there is no operation method registered for the specified identifier.- See Also:
-
builder
Returns a builder for a parameterized math transform using the specified operation method. Themethod
argument should be the name or identifier of anOperationMethod
instance returned by
, with the addition of the following pseudo-methods:getAvailableMethods
(null)- "Coordinate system conversion"
- Inferring the
"semi_major"
,"semi_minor"
,"src_semi_major"
,"src_semi_minor"
,"tgt_semi_major"
or"tgt_semi_minor"
parameter values from theEllipsoid
associated to the source or target CRS, if these parameters are not explicitly given and if they are relevant for the coordinate operation method. - Concatenating the parameterized transform with any other transforms required for performing units changes and coordinates swapping.
OperationMethod
, for exampleLongitude rotation
(EPSG:9601) for changing the prime meridian.Upcoming API generalization: the return type of this method may be changed to a newMathTransform.Builder
interface in a future Apache SIS version. This is pending GeoAPI 3.1 release, if approved by OGC.- Parameters:
method
- the case insensitive name or identifier of the desired coordinate operation method.- Returns:
- a builder for a meth transform implementing the formulas identified by the given method.
- Throws:
NoSuchIdentifierException
- if there is no supported method for the given name or identifier.- Since:
- 1.5
- See Also:
-
getDefaultParameters
@Deprecated(since="1.5") public ParameterValueGroup getDefaultParameters(String method) throws NoSuchIdentifierException Deprecated.This way to create parameterized transform is ambiguous. Usebuilder(String)
instead.Returns the default parameter values for a math transform using the given operation method. Themethod
argument is the name of anyOperationMethod
instance returned by
. Valid names are listed here.getAvailableMethods
(SingleOperation.class)This function creates new parameter instances at every call. Parameters are intended to be modified by the user before to be given to the
createParameterizedTransform(…)
method.- Specified by:
getDefaultParameters
in interfaceMathTransformFactory
- Parameters:
method
- the case insensitive name of the coordinate operation method to search for.- Returns:
- a new group of parameter values for the
OperationMethod
identified by the given name. - Throws:
NoSuchIdentifierException
- if there is no method registered for the given name or identifier.- See Also:
-
createParameterizedTransform
@Deprecated(since="1.5") public MathTransform createParameterizedTransform(ParameterValueGroup parameters) throws NoSuchIdentifierException, FactoryException Deprecated.This constructor is ambiguous when axis directions are parts of the map projection definition as inTransverse Mercator (South Orientated)
. Usebuilder(String)
instead for allowing the implementation to resolve such ambiguities.Creates a transform from a group of parameters. The set of expected parameters varies for each operation. The easiest way to provide parameter values is to get an initially empty group for the desired operation by callinggetDefaultParameters(String)
, then to fill the parameter values. Example:ParameterValueGroup group = factory.getDefaultParameters("Transverse_Mercator"); group.parameter("semi_major").setValue(6378137.000); group.parameter("semi_minor").setValue(6356752.314); MathTransform mt = factory.createParameterizedTransform(group);
"semi_major"
and"semi_minor"
parameter values are not explicitly provided, but rather inferred from the geodetic reference frame of the source Coordinate Reference System.- Specified by:
createParameterizedTransform
in interfaceMathTransformFactory
- Parameters:
parameters
- the parameter values. The parameter group name shall be the name of the desired operation method.- Returns:
- the transform created from the given parameters.
- Throws:
NoSuchIdentifierException
- if there is no method for the given parameter group name.FactoryException
- if the object creation failed. This exception is thrown if some required parameter has not been supplied, or has illegal value.- See Also:
-
createParameterizedTransform
@Deprecated(since="1.5", forRemoval=true) public MathTransform createParameterizedTransform(ParameterValueGroup parameters, DefaultMathTransformFactory.Context context) throws NoSuchIdentifierException, FactoryException Deprecated, for removal: This API element is subject to removal in a future version.Replaced by a builder pattern withbuilder(String)
.Creates a transform from a group of parameters and a context.- Parameters:
parameters
- the parameter values.context
- information about the context, ornull
if none.- Returns:
- the transform created from the given parameters.
- Throws:
NoSuchIdentifierException
- if there is no method for the given parameter group name.FactoryException
- if the object creation failed.
-
swapAndScaleAxes
@Deprecated(since="1.5", forRemoval=true) public MathTransform swapAndScaleAxes(MathTransform parameterized, DefaultMathTransformFactory.Context context) throws FactoryException Deprecated, for removal: This API element is subject to removal in a future version.Considered internal API because the definition of "normalized" is implementation-dependent.Given a transform between normalized spaces, creates a transform taking in account axis directions, units of measurement and longitude rotation. This method concatenates the given parameterized transform with any other transform required for performing units changes and coordinates swapping.The given
parameterized
transform shall expect normalized input coordinates and produce normalized output coordinates. SeeAxesConvention
for more information about what Apache SIS means by "normalized".Example
The most typical examples of transforms with normalized inputs/outputs are normalized map projections expecting (longitude, latitude) inputs in degrees and calculating (x, y) coordinates in metres, both of them with (East, North) axis orientations.Controlling the normalization process
Users who need a different normalized space than the default one may find more convenient to override theContext.getMatrix(ContextualParameters.MatrixRole)
method.- Parameters:
parameterized
- a transform for normalized input and output coordinates.context
- source and target coordinate systems in which the transform is going to be used.- Returns:
- a transform taking in account unit conversions and axis swapping.
- Throws:
FactoryException
- if the object creation failed.- Since:
- 0.7
- See Also:
-
createBaseToDerived
@Deprecated(since="0.7") public MathTransform createBaseToDerived(CoordinateReferenceSystem baseCRS, ParameterValueGroup parameters, CoordinateSystem derivedCS) throws NoSuchIdentifierException, FactoryException Deprecated.Replaced bybuilder(String)
.Creates a transform from a base CRS to a derived CS using the given parameters. If this method needs to set the values of"semi_major"
and"semi_minor"
parameters, then it sets those values directly on the givenparameters
instance – not on a clone – for allowing the caller to get back the complete parameter values. However, this method only fills missing values, it never modify existing values.- Specified by:
createBaseToDerived
in interfaceMathTransformFactory
- Parameters:
baseCRS
- the source coordinate reference system.parameters
- the parameter values for the transform.derivedCS
- the target coordinate system.- Returns:
- the parameterized transform from
baseCRS
toderivedCS
, including unit conversions and axis swapping. - Throws:
NoSuchIdentifierException
- if there is no transform registered for the coordinate operation method.FactoryException
- if the object creation failed. This exception is thrown if some required parameter has not been supplied, or has illegal value.
-
createCoordinateSystemChange
@Deprecated(since="1.5", forRemoval=true) public MathTransform createCoordinateSystemChange(CoordinateSystem source, CoordinateSystem target, Ellipsoid ellipsoid) throws FactoryException Deprecated, for removal: This API element is subject to removal in a future version.Replaced by the following pattern:var builder = builder("Coordinate system conversion"); builder.setSourceAxes(source, ellipsoid); builder.setTargetAxes(target, ellipsoid); return builder.create();
Creates a math transform that represent a change of coordinate system. If exactly one argument is an ellipsoidal coordinate systems, then theellipsoid
argument is mandatory. In all other cases (including the case where both coordinate systems are ellipsoidal), the ellipsoid argument is ignored and can benull
.Design note
This method does not accept separated ellipsoid arguments forsource
andtarget
because this method should not be used for datum shifts. If the two given coordinate systems are ellipsoidal, then they are assumed to use the same ellipsoid. If different ellipsoids are desired, then a parameterized transform likeMolodensky
,Geocentric translations
,Coordinate Frame Rotation
orPosition Vector transformation
should be used instead.- Parameters:
source
- the source coordinate system.target
- the target coordinate system.ellipsoid
- the ellipsoid ofEllipsoidalCS
, ornull
if none.- Returns:
- a conversion from the given source to the given target coordinate system.
- Throws:
FactoryException
- if the conversion cannot be created.- Since:
- 0.8
-
createAffineTransform
Creates an affine transform from a matrix. If the transform input dimension isM
, and output dimension isN
, then the matrix will have size[N+1][M+1]
. The +1 in the matrix dimensions allows the matrix to do a shift, as well as a rotation. The[M][j]
element of the matrix will be the j'th coordinate of the moved origin. The[i][N]
element of the matrix will be 0 for i less thanM
, and 1 for i equalsM
.- Specified by:
createAffineTransform
in interfaceMathTransformFactory
- Parameters:
matrix
- the matrix used to define the affine transform.- Returns:
- the affine transform.
- Throws:
FactoryException
- if the object creation failed.- See Also:
-
createConcatenatedTransform
public MathTransform createConcatenatedTransform(MathTransform tr1, MathTransform tr2) throws FactoryException Creates a transform by concatenating two existing transforms. A concatenated transform acts in the same way as applying two transforms, one after the other.The dimension of the output space of the first transform must match the dimension of the input space in the second transform. In order to concatenate more than two transforms, use this constructor repeatedly.
- Specified by:
createConcatenatedTransform
in interfaceMathTransformFactory
- Parameters:
tr1
- the first transform to apply to points.tr2
- the second transform to apply to points.- Returns:
- the concatenated transform.
- Throws:
FactoryException
- if the object creation failed.- See Also:
-
createPassThroughTransform
public MathTransform createPassThroughTransform(int firstAffectedCoordinate, MathTransform subTransform, int numTrailingCoordinates) throws FactoryException Creates a transform which passes through a subset of coordinates to another transform. This allows transforms to operate on a subset of coordinates. The resulting transform will have the following dimensions:int sourceDim = firstAffectedCoordinate + subTransform.getSourceDimensions() + numTrailingCoordinates; int targetDim = firstAffectedCoordinate + subTransform.getTargetDimensions() + numTrailingCoordinates;
Example
Giving (latitude, longitude, height) coordinates, a pass through transform can convert the height values from meters to feet without affecting the (latitude, longitude) values.- Specified by:
createPassThroughTransform
in interfaceMathTransformFactory
- Parameters:
firstAffectedCoordinate
- the lowest index of the affected coordinates.subTransform
- transform to use for affected coordinates.numTrailingCoordinates
- number of trailing coordinates to pass through. Affected coordinates will range fromfirstAffectedCoordinate
inclusive todimTarget-numTrailingCoordinates
exclusive.- Returns:
- a pass through transform.
- Throws:
FactoryException
- if the object creation failed.
-
createFromXML
Deprecated.There is no XML format for math transforms.- Specified by:
createFromXML
in interfaceMathTransformFactory
- Parameters:
xml
- math transform encoded in XML format.- Returns:
- The math transform (never
null
). - Throws:
FactoryException
- if the object creation failed.
-
createFromWKT
Creates a math transform object from a Well Known Text (WKT). If the given text contains non-fatal anomalies (unknown or unsupported WKT elements, inconsistent unit definitions, etc.), warnings may be reported in a logger named"org.apache.sis.io.wkt"
.Note that the WKT format is not always lossless. A
MathTransform
recreated from WKT may be non-invertible even if the original transform was invertible. For example if an "Affine" operation is defined by a non-square matrix, Apache SIS implementation sometimes has "hidden" information about the inverse matrix but those information are lost at WKT formatting time. A similar "hidden" information lost may also happen withWraparoundTransform
, also making that transform non-invertible.- Specified by:
createFromWKT
in interfaceMathTransformFactory
- Specified by:
createFromWKT
in interfaceParser
- Parameters:
wkt
- math transform encoded in Well-Known Text format.- Returns:
- the math transform (never
null
). - Throws:
FactoryException
- if the Well-Known Text cannot be parsed, or if the math transform creation failed from some other reason.
-
getLastMethodUsed
Deprecated.Replaced byMathTransformBuilder.getMethod()
.Returns the operation method used by the latest call to acreate(…)
constructor in the currently running thread. Returnsnull
if not applicable.Invoking
getLastMethodUsed()
can be useful after a call tocreateParameterizedTransform(…)
.- Specified by:
getLastMethodUsed
in interfaceMathTransformFactory
- Returns:
- the last method used by a
create(…)
constructor, ornull
if unknown of unsupported. - See Also:
-
reload
public void reload()Notifies this factory that the elements provided by theIterable<OperationMethod>
may have changed. This method performs the following steps:- Clears all caches.
- If the
Iterable
given at construction time is an instance ofServiceLoader
, invokes itsreload()
method.
- See Also:
-
builder(String)
.