PlanetaryComputerModelFactory.CropFeatureWidthByHeightOptions Method

Definition

Options for the cropFeatureWidthByHeight operation.

public static Azure.Analytics.PlanetaryComputer.CropFeatureWidthByHeightOptions CropFeatureWidthByHeightOptions(System.Collections.Generic.IEnumerable<int> bidx = default, System.Collections.Generic.IEnumerable<string> assets = default, string expression = default, System.Collections.Generic.IEnumerable<string> assetBandIndices = default, bool? assetAsBand = default, string noData = default, bool? unscale = default, Azure.Analytics.PlanetaryComputer.WarpKernelResampling? reproject = default, Azure.Analytics.PlanetaryComputer.TerrainAlgorithm? algorithm = default, string algorithmParams = default, string collectionId = default, string itemId = default, int width = 0, int height = 0, string format = default, string colorFormula = default, string coordinateReferenceSystem = default, Azure.Analytics.PlanetaryComputer.ResamplingMethod? resampling = default, int? maxSize = default, System.Collections.Generic.IEnumerable<string> rescale = default, Azure.Analytics.PlanetaryComputer.ColorMapNames? colorMapName = default, string colorMap = default, bool? returnMask = default, string destinationCrs = default, string subdatasetName = default, System.Collections.Generic.IEnumerable<int> subdatasetBands = default, string crs = default, string datetime = default, System.Collections.Generic.IEnumerable<string> sel = default, Azure.Analytics.PlanetaryComputer.SelMethod? selMethod = default);
static member CropFeatureWidthByHeightOptions : seq<int> * seq<string> * string * seq<string> * Nullable<bool> * string * Nullable<bool> * Nullable<Azure.Analytics.PlanetaryComputer.WarpKernelResampling> * Nullable<Azure.Analytics.PlanetaryComputer.TerrainAlgorithm> * string * string * string * int * int * string * string * string * Nullable<Azure.Analytics.PlanetaryComputer.ResamplingMethod> * Nullable<int> * seq<string> * Nullable<Azure.Analytics.PlanetaryComputer.ColorMapNames> * string * Nullable<bool> * string * string * seq<int> * string * string * seq<string> * Nullable<Azure.Analytics.PlanetaryComputer.SelMethod> -> Azure.Analytics.PlanetaryComputer.CropFeatureWidthByHeightOptions
Public Shared Function CropFeatureWidthByHeightOptions (Optional bidx As IEnumerable(Of Integer) = Nothing, Optional assets As IEnumerable(Of String) = Nothing, Optional expression As String = Nothing, Optional assetBandIndices As IEnumerable(Of String) = Nothing, Optional assetAsBand As Nullable(Of Boolean) = Nothing, Optional noData As String = Nothing, Optional unscale As Nullable(Of Boolean) = Nothing, Optional reproject As Nullable(Of WarpKernelResampling) = Nothing, Optional algorithm As Nullable(Of TerrainAlgorithm) = Nothing, Optional algorithmParams As String = Nothing, Optional collectionId As String = Nothing, Optional itemId As String = Nothing, Optional width As Integer = 0, Optional height As Integer = 0, Optional format As String = Nothing, Optional colorFormula As String = Nothing, Optional coordinateReferenceSystem As String = Nothing, Optional resampling As Nullable(Of ResamplingMethod) = Nothing, Optional maxSize As Nullable(Of Integer) = Nothing, Optional rescale As IEnumerable(Of String) = Nothing, Optional colorMapName As Nullable(Of ColorMapNames) = Nothing, Optional colorMap As String = Nothing, Optional returnMask As Nullable(Of Boolean) = Nothing, Optional destinationCrs As String = Nothing, Optional subdatasetName As String = Nothing, Optional subdatasetBands As IEnumerable(Of Integer) = Nothing, Optional crs As String = Nothing, Optional datetime As String = Nothing, Optional sel As IEnumerable(Of String) = Nothing, Optional selMethod As Nullable(Of SelMethod) = Nothing) As CropFeatureWidthByHeightOptions

Parameters

bidx
IEnumerable<Int32>

Dataset band indexes.

assets
IEnumerable<String>

Asset's names.

expression
String

Band math expression between assets.

assetBandIndices
IEnumerable<String>

Per asset band indexes (coma separated indexes, e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image").

assetAsBand
Nullable<Boolean>

Asset as Band.

noData
String

Overwrite internal Nodata value.

unscale
Nullable<Boolean>

Apply internal Scale or Offset.

reproject
Nullable<WarpKernelResampling>

WarpKernel resampling algorithm (only used when doing re-projection). Defaults to nearest.

algorithm
Nullable<TerrainAlgorithm>

Terrain algorithm name.

algorithmParams
String

Terrain algorithm parameters.

collectionId
String

STAC Collection Identifier.

itemId
String

STAC Item Identifier.

width
Int32

Width in pixels for the output image.

height
Int32

Height in pixels for the output image.

format
String

Output format for the tile or image (e.g., png, jpeg, webp).

colorFormula
String

rio-color formula (info: https://github.com/mapbox/rio-color).

coordinateReferenceSystem
String

Coordinate Reference System of the input coords. Default to epsg:4326.

resampling
Nullable<ResamplingMethod>

Resampling method.

maxSize
Nullable<Int32>

Image output size limit if width and height limits are not set.

rescale
IEnumerable<String>

comma (',') delimited Min,Max range. Can set multiple time for multiple bands.

colorMapName
Nullable<ColorMapNames>

Colormap name.

colorMap
String

JSON encoded custom Colormap.

returnMask
Nullable<Boolean>

Add mask to the output data.

destinationCrs
String

Output Coordinate Reference System.

subdatasetName
String

The name of a subdataset within the asset.

subdatasetBands
IEnumerable<Int32>

The index of a subdataset band within the asset.

crs
String

Coordinate Reference System.

datetime
String

Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots. Examples:

  • A date-time: "2018-02-12T23:20:50Z"
  • A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
  • Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
Only features that have a temporal property that intersects the value of `datetime` are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.
sel
IEnumerable<String>

Xarray Indexing using dimension names {dimension}={value}.

selMethod
Nullable<SelMethod>

Xarray indexing method to use for inexact matches.

Returns

A new CropFeatureWidthByHeightOptions instance for mocking.

Applies to