Module org.apache.sis.gui

Package org.apache.sis.gui.coverage

Class ImageRequest

Object

ImageRequest

public class ImageRequest
extends Object

A request for a two-dimensional view of a grid coverage. Those requests can be used for reading or rendering and image in a background thread.

Since:

1.1

See Also:

• Grid­View.set­Image(Image­Request)
• Coverage­Explorer.set­Coverage(Image­Request)

Constructor Summary

Constructors

Constructor	Description
Image­Request(Grid­Coverage source, Grid­Extent slice)	Creates a new request for loading an image from the specified coverage.
Image­Request(Grid­Coverage­Resource source, Grid­Geometry domain, int... range)	Creates a new request for loading an image from the specified resource.

Method Summary

Modifier and Type	Method	Description
final Optional<Grid­Coverage>	get­Coverage()	Returns the coverage specified at construction time, or an empty value if none.
final Optional<Grid­Geometry>	get­Domain()	Returns the desired grid extent and resolution, or an empty value for reading the full domain.
final Optional<int[]>	get­Range()	Returns the 0-based indices of sample dimensions to read, or an empty value for reading them all.
final Optional<Grid­Coverage­Resource>	get­Resource()	Returns the resource specified at construction time, or an empty value if none.
final Optional<Grid­Extent>	get­Slice­Extent()	Returns the subspace of the grid coverage extent to render.

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, to­String, wait, wait, wait

Constructor Details

ImageRequest

public ImageRequest(GridCoverageResource source,
 GridGeometry domain,
 int... range)

Creates a new request for loading an image from the specified resource. If domain and range arguments are null, then the full coverage will be loaded. For loading a smaller amount of data, sub-domain or sub-range can be specified as documented in the read method javadoc.

Parameters:

source - source of the image to load.

domain - desired grid extent and resolution, or null for reading the whole domain.

range - 0-based indices of sample dimensions to read, or null or an empty sequence for reading them all.

See Also:

• Grid­Coverage­Resource.read(Grid­Geometry, int...)

ImageRequest

public ImageRequest(GridCoverage source,
 GridExtent slice)

Creates a new request for loading an image from the specified coverage. If the slice­Extent argument is null, then the full coverage will be rendered in the first two dimensions having a size greater than 1 cell. For rendering a smaller amount of data, or for rendering data along other dimensions, a slice extent can be specified as documented in the render method javadoc.

Parameters:

source - source of the image to load.

slice - a subspace of the grid coverage extent to render, or null for the whole extent.

See Also:

• Grid­Coverage.render(Grid­Extent)

Method Details

getResource

public final Optional<GridCoverageResource> getResource()

Returns the resource specified at construction time, or an empty value if none.

Returns:

the resource to read.

getCoverage

public final Optional<GridCoverage> getCoverage()

Returns the coverage specified at construction time, or an empty value if none.

Returns:

the coverage to render.

getDomain

public final Optional<GridGeometry> getDomain()

Returns the desired grid extent and resolution, or an empty value for reading the full domain. This is the domain argument specified to the following constructor:

Image­Request(Grid­Coverage­Resource, Grid­Geometry, int[])

This argument will be forwarded verbatim to the following method (see its javadoc for more explanation):

Grid­Coverage­Resource.read(Grid­Geometry, int...)

This property is always empty if this image request has been created with the Image­Request(Grid­Coverage, Grid­Extent) constructor, since no read operation will happen in such case.

Returns:

the desired grid extent and resolution of the coverage.

getRange

public final Optional<int[]> getRange()

Returns the 0-based indices of sample dimensions to read, or an empty value for reading them all. This is the range argument specified to the following constructor:

Image­Request(Grid­Coverage­Resource, Grid­Geometry, int[])

This argument will be forwarded verbatim to the following method (see its javadoc for more explanation):

Grid­Coverage­Resource.read(Grid­Geometry, int...)

This property is always empty if this image request has been created with the Image­Request(Grid­Coverage, Grid­Extent) constructor, since no read operation will happen in such case.

Returns:

the 0-based indices of sample dimensions to read.

getSliceExtent

public final Optional<GridExtent> getSliceExtent()

Returns the subspace of the grid coverage extent to render. This is the slice­Extent argument specified to the following constructor:

Image­Request(Grid­Coverage, Grid­Extent)

This argument will be forwarded verbatim to the following method (see its javadoc for more explanation):

Grid­Coverage.render(Grid­Extent)

If non-empty, then all dimensions except two should have a size of 1 cell.

Returns:

subspace of the grid coverage extent to render.

See Also:

• Grid­Coverage.render(Grid­Extent)