Factory
GridCoverageFactory
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Object
GridCoverageBuilder.
@ThreadSafe @Deprecated public class GridCoverageFactory
A factory for grid coverage objects. This factory expects various combinations of the following informations:
float[][].String objects (CaselessStringKey are accepted as well), while
values may be any Object.The coordinate reference system is inferred from the supplied envelope or grid geometry parameters. If those parameters do not have CRS information, then this factory fallback on a default CRS.
Every create methods will ultimately delegate their work to a master
create variant. Developers can override this method if they
want to intercept the creation of all GridCoverage2D objects in this factory.
| coverage/geotk-coverage (download) | View source code for this class |
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class Factory |
|---|
Factory.Availability, Factory.Organizer |
| Field Summary |
|---|
| Fields inherited from class Factory |
|---|
EMPTY_HINTS, hints |
| Constructor Summary | |
|---|---|
GridCoverageFactory()
Deprecated. Creates a default factory. |
|
GridCoverageFactory(Hints userHints)
Deprecated. Creates a factory using the specified set of hints. |
|
| Method Summary | |
|---|---|
GridCoverage2D |
create(CharSequence name,
float[][] matrix,
Envelope envelope)
Deprecated. Constructs a grid coverage from the specified matrix and envelope. |
GridCoverage2D |
create(CharSequence name,
ImageFunction function,
GridGeometry2D gridGeometry,
GridSampleDimension[] bands,
Map<?,?> properties)
Deprecated. Constructs a grid coverage from an image function. |
GridCoverage2D |
create(CharSequence name,
RenderedImage image,
CoordinateReferenceSystem crs,
MathTransform gridToCRS,
GridSampleDimension[] bands,
GridCoverage[] sources,
Map<?,?> properties)
Deprecated. Constructs a grid coverage from the specified image and "grid to CRS" transform. |
GridCoverage2D |
create(CharSequence name,
RenderedImage image,
Envelope envelope)
Deprecated. Constructs a grid coverage from the specified image and envelope. |
GridCoverage2D |
create(CharSequence name,
RenderedImage image,
Envelope envelope,
GridSampleDimension[] bands,
GridCoverage[] sources,
Map<?,?> properties)
Deprecated. Constructs a grid coverage from the specified image and envelope. |
GridCoverage2D |
create(CharSequence name,
RenderedImage image,
GridGeometry2D gridGeometry,
GridSampleDimension[] bands,
GridCoverage[] sources,
Map<?,?> properties)
Deprecated. Constructs a grid coverage from the specified image and grid geometry. |
GridCoverage2D |
create(CharSequence name,
WritableRaster raster,
CoordinateReferenceSystem crs,
MathTransform gridToCRS,
double[] minValues,
double[] maxValues,
Unit<?> units,
Color[][] colors,
RenderingHints hints)
Deprecated. Constructs a grid coverage from the specified raster and "grid to CRS" transform. |
GridCoverage2D |
create(CharSequence name,
WritableRaster raster,
CoordinateReferenceSystem crs,
MathTransform gridToCRS,
GridSampleDimension... bands)
Deprecated. Constructs a grid coverage from the specified raster and "grid to CRS" transform. |
GridCoverage2D |
create(CharSequence name,
WritableRaster raster,
Envelope envelope)
Deprecated. Constructs a grid coverage from the specified raster and envelope. |
GridCoverage2D |
create(CharSequence name,
WritableRaster raster,
Envelope envelope,
double[] minValues,
double[] maxValues,
Unit<?> units,
Color[][] colors,
RenderingHints hints)
Deprecated. Constructs a grid coverage from the specified raster and envelope. |
GridCoverage2D |
create(CharSequence name,
WritableRaster raster,
Envelope envelope,
GridSampleDimension... bands)
Deprecated. Constructs a grid coverage from the specified raster and envelope. |
protected CoordinateReferenceSystem |
getDefaultCRS(int dimension)
Deprecated. Returns the default coordinate reference system to use when no CRS were explicitly specified by the user. |
| Methods inherited from class Factory |
|---|
availability, dispose, equals, getImplementationHints, hasCompatibleHints, hashCode, setOrdering, toString |
| Methods inherited from class Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public GridCoverageFactory()
CoverageFactoryFinder.getGridCoverageFactory(org.geotoolkit.factory.Hints) instead.
public GridCoverageFactory(Hints userHints)
userHints - An optional set of hints to use for coverage constructions.| Method Detail |
|---|
protected CoordinateReferenceSystem getDefaultCRS(int dimension)
DEFAULT_COORDINATE_REFERENCE_SYSTEM hint were provided at factory construction
time, then the specified CRS is returned. Otherwise, the default implementation
returns DefaultGeographicCRS.WGS84 or its 3D variant. Subclasses should
override this method if they want to use different defaults.
dimension - The number of dimension expected in the CRS to be returned.
public GridCoverage2D create(CharSequence name,
ImageFunction function,
GridGeometry2D gridGeometry,
GridSampleDimension[] bands,
Map<?,?> properties)
name - The grid coverage name, or null if none.function - The image function.gridGeometry - The grid geometry. The grid extent
must contains the expected image size (width and height).bands - Sample dimensions for each image band, or null for default sample dimensions.properties - The set of properties for this coverage, or null if there is none.
public GridCoverage2D create(CharSequence name,
float[][] matrix,
Envelope envelope)
name - The grid coverage name, or null if none.matrix - The matrix data in a [row][column] layout.
NaN values are mapped to a transparent color.envelope - The envelope.
public GridCoverage2D create(CharSequence name,
WritableRaster raster,
Envelope envelope)
name - The grid coverage name, or null if none.raster - The data (may be floating point numbers). NaN
values are mapped to a transparent color.envelope - The envelope.
public GridCoverage2D create(CharSequence name,
WritableRaster raster,
Envelope envelope,
double[] minValues,
double[] maxValues,
Unit<?> units,
Color[][] colors,
RenderingHints hints)
name - The grid coverage name, or null if none.raster - The data (may be floating point numbers).
NaN values are mapped to a transparent color.envelope - The grid coverage coordinates and its CRS. This envelope must have at least two
dimensions. The two first dimensions describe the image location along x
and y axis. The other dimensions are optional and may be used to locate
the image on a vertical axis or on the time axis.minValues - The minimal value for each band in the raster,
or null for computing it automatically.maxValues - The maximal value for each band in the raster,
or null for computing it automatically.units - The units of sample values, or null if unknown.colors - The colors to use for values from minValues to maxValues for each
bands, or null for a default color palette. If non-null, each arrays
colors[b] may have any length; colors will be interpolated as needed.hints - An optional set of rendering hints, or null if none. Those hints will not
affect the grid coverage to be created. However, they may affect the grid coverage
to be returned by view(View.RENDERED)SAMPLE_DIMENSION_TYPE hint
specifies the SampleDimensionType to be used at rendering time, which can
be one of UNSIGNED_8BITS or
UNSIGNED_16BITS.
public GridCoverage2D create(CharSequence name,
WritableRaster raster,
CoordinateReferenceSystem crs,
MathTransform gridToCRS,
double[] minValues,
double[] maxValues,
Unit<?> units,
Color[][] colors,
RenderingHints hints)
name - The grid coverage name, or null if none.raster - The data (may be floating point numbers).
NaN values are mapped to a transparent color.crs - The coordinate reference system. This specifies the CRS used when
accessing a grid coverage with the evaluate methods.gridToCRS - The math transform from grid to coordinate reference system.minValues - The minimal value for each band in the raster,
or null for computing it automatically.maxValues - The maximal value for each band in the raster,
or null for computing it automatically.units - The units of sample values, or null if unknown.colors - The colors to use for values from minValues to maxValues for each
bands, or null for a default color palette. If non-null, each arrays
colors[b] may have any length; colors will be interpolated as needed.hints - An optional set of rendering hints, or null if none. Those hints will not
affect the grid coverage to be created. However, they may affect the grid coverage
to be returned by view(View.RENDERED)SAMPLE_DIMENSION_TYPE hint
specifies the SampleDimensionType to be used at rendering time, which can
be one of UNSIGNED_8BITS or
UNSIGNED_16BITS.
public GridCoverage2D create(CharSequence name,
WritableRaster raster,
Envelope envelope,
GridSampleDimension... bands)
The coordinate reference system is inferred from the supplied envelope. The envelope must have at least two dimensions. The two first dimensions describe the image location along x and y axis. The other dimensions are optional and may be used to locate the image on a vertical axis or on the time axis.
name - The grid coverage name, or null if none.raster - The raster.envelope - The grid coverage coordinates.bands - Sample dimensions for each image band, or null for default sample dimensions.
If non-null, then this array length must matches the number of bands in image.
public GridCoverage2D create(CharSequence name,
WritableRaster raster,
CoordinateReferenceSystem crs,
MathTransform gridToCRS,
GridSampleDimension... bands)
name - The grid coverage name, or null if none.raster - The raster.crs - The coordinate reference system. This specifies the CRS used when accessing a grid
coverage with the evaluate methods. The number of dimensions must matches
the number of target dimensions of gridToCRS.gridToCRS - The math transform from grid to coordinate reference system.bands - Sample dimensions for each image band, or null for default sample dimensions.
If non-null, then this array length must matches the number of bands in image.
public GridCoverage2D create(CharSequence name,
RenderedImage image,
Envelope envelope)
The envelope must have at least two dimensions. The two first dimensions describe the image location along x and y axis. The other dimensions are optional and may be used to locate the image on a vertical axis or on the time axis.
name - The grid coverage name, or null if none.image - The image.envelope - The grid coverage coordinates.
public GridCoverage2D create(CharSequence name,
RenderedImage image,
Envelope envelope,
GridSampleDimension[] bands,
GridCoverage[] sources,
Map<?,?> properties)
This convenience constructor assumes that axis order in the supplied image matches exactly axis order in the supplied envelope. In other words, in the usual case where axis order in the image is (column, row), then the envelope should probably have a (longitude, latitude) or (easting, northing) axis order.
An exception to the above rule applies for CRS using exactly the following axis order:
(NORTH|SOUTH,
EAST|WEST).
An example of such CRS is EPSG:4326. This convenience constructor will
interchange automatically the (y,x) axis for such CRS.
If more control on axis order and direction reversal is wanted, use the constructor variant expecting an explicit transform.
name - The grid coverage name, or null if none.image - The image.envelope - The grid coverage coordinates. This envelope must have at least two dimensions.
The two first dimensions describe the image location along x and
y axis. The other dimensions are optional and may be used to locate
the image on a vertical axis or on the time axis.bands - Sample dimensions for each image band, or null for default sample dimensions.
If non-null, then this array length must matches the number of bands in image.sources - The sources for this grid coverage, or null if none.properties - The set of properties for this coverage, or null if there is none.
public GridCoverage2D create(CharSequence name,
RenderedImage image,
CoordinateReferenceSystem crs,
MathTransform gridToCRS,
GridSampleDimension[] bands,
GridCoverage[] sources,
Map<?,?> properties)
name - The grid coverage name, or null if none.image - The image.crs - The coordinate reference system. This specifies the CRS used when accessing a grid
coverage with the evaluate methods. The number of dimensions must matches
the number of target dimensions of gridToCRS.gridToCRS - The math transform from grid to coordinate reference system.bands - Sample dimension for each image band, or null for default sample dimensions.
If non-null, then this array length must matches the number of bands in the image.sources - The sources for this grid coverage, or null if none.properties - The set of properties for this coverage, or null if there is none.
public GridCoverage2D create(CharSequence name,
RenderedImage image,
GridGeometry2D gridGeometry,
GridSampleDimension[] bands,
GridCoverage[] sources,
Map<?,?> properties)
This is the most general constructor, the one that gives the maximum control
on the grid coverage to be created. Every create methods will ultimately
delegate their work this master method. Developers can override this method if they
want to intercept the creation of all GridCoverage2D objects in this factory.
name - The grid coverage name, or null if none.image - The image.gridGeometry - The grid geometry (must contains an envelope
with its coordinate reference
system and a "grid to CRS" transform).bands - Sample dimensions for each image band, or null for default sample dimensions.
If non-null, then this array length must matches the number of bands in image.sources - The sources for this grid coverage, or null if none.properties - The set of properties for this coverage, or null none.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||