Interface MapTransformDescriptor
-
- All Known Implementing Classes:
AffineTransformDescriptor
,AlbersEqualAreaConicDescriptor
,IdentityTransformDescriptor
,LambertConformalConicDescriptor
,StereographicDescriptor
,TransverseMercatorDescriptor
@Deprecated public interface MapTransformDescriptor
Deprecated.since BEAM 4.7, use geotoolsMathTransformProvider
instead.A descriptor for map transformation types.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description MapTransform
createTransform(double[] parameterValues)
Deprecated.Creates an instance of the map transform for the given parameter values.String
getMapUnit()
Deprecated.String
getName()
Deprecated.double[]
getParameterDefaultValues()
Deprecated.Gets a copy of the default parameter values for this map transform.Parameter[]
getParameters()
Deprecated.Gets the parameters for this map transform.MapTransformUI
getTransformUI(MapTransform transform)
Deprecated.Gets a user interface for editing the transformation properties of a map projection.String
getTypeID()
Deprecated.boolean
hasTransformUI()
Deprecated.Tests if a user interface is available.void
registerProjections()
Deprecated.This method is called within the
method after an instance of thisMapProjectionRegistry.registerDescriptor(org.esa.snap.core.dataop.maptransf.MapTransformDescriptor)
MapTransformDescriptor
has been successfully registered.
-
-
-
Method Detail
-
registerProjections
void registerProjections()
Deprecated.This method is called within the
method after an instance of thisMapProjectionRegistry.registerDescriptor(org.esa.snap.core.dataop.maptransf.MapTransformDescriptor)
MapTransformDescriptor
has been successfully registered. The method can and should be used to register projections that are based on the type of
described by thisMapTransform
MapTransformDescriptor
. Registering projection instances is done using the using the
method.MapProjectionRegistry.registerProjection(org.esa.snap.core.dataop.maptransf.MapProjection)
A typical implementation of this method would be:
public void registerProjections() { MapProjectionRegistry.registerProjection(new MapProjection("my-projection-name-1", new MyMapTransform(param_1))); MapProjectionRegistry.registerProjection(new MapProjection("my-projection-name-2", new MyMapTransform(param_2))); MapProjectionRegistry.registerProjection(new MapProjection("my-projection-name-3", new MyMapTransform(param_3))); ... }
-
createTransform
MapTransform createTransform(double[] parameterValues)
Deprecated.Creates an instance of the map transform for the given parameter values. The parameter value array must exactly match the size and semantics of the parameters returned by thegetParameters()
method.Important: Implementors of this method shall ensure that an element-wise copy of the given parameter array is created and set.
- Parameters:
parameterValues
- the parameter values. If null, a map transform with default parameter values is created- Returns:
- a new instance of a map transform with the array of parameters being copied, never null
-
getTypeID
String getTypeID()
Deprecated.- Returns:
- The unique type identifier for the map transformation, e.g. "Transverse_Mercator".
-
getName
String getName()
Deprecated.- Returns:
- A descriptive name for this map transformation descriptor, e.g. "Transverse Mercator".
-
getMapUnit
String getMapUnit()
Deprecated.- Returns:
- The unit of the map, e.g. "degree" or "meter".
-
getParameterDefaultValues
double[] getParameterDefaultValues()
Deprecated.Gets a copy of the default parameter values for this map transform. Changing elements in the returned array will not affect this object's state.- Returns:
- The default parameter values for this map transform.
-
getParameters
Parameter[] getParameters()
Deprecated.Gets the parameters for this map transform.Important: Changing elements in the returned array may change this object's state.
- Returns:
- The list of parameters required to create a new instance of the map transform.
-
hasTransformUI
boolean hasTransformUI()
Deprecated.Tests if a user interface is available.- Returns:
true
if a user interface is available, in this case thegetTransformUI(org.esa.snap.core.dataop.maptransf.MapTransform)
method never returns null.
-
getTransformUI
MapTransformUI getTransformUI(MapTransform transform)
Deprecated.Gets a user interface for editing the transformation properties of a map projection.- Parameters:
transform
- the transformation which provides the default properties for the UI.- Returns:
- the user interface or null if editing is not supported. The
hasTransformUI()
method shall returnfalse
in this case.
-
-