GeoBlazor Pro

dymaptic.GeoBlazor.Pro

dymaptic.GeoBlazor.Pro.Model

ImageSampleParameters Class

<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Model.ImageSampleParameters.html”>GeoBlazor Docs</a> Input parameters for the <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#getSamples”>getSamples()</a> method on <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html”>ImageryLayer</a>. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html”>ArcGIS Maps SDK for JavaScript</a>

public record ImageSampleParameters : System.IEquatable<dymaptic.GeoBlazor.Pro.Model.ImageSampleParameters>

Inheritance System.Object 🡒 ImageSampleParameters

Implements System.IEquatable<ImageSampleParameters>

Constructors

ImageSampleParameters(Geometry, Nullable<Interpolation>, IReadOnlyCollection<Point>, MosaicRule, IReadOnlyCollection<string>, Point, Nullable<bool>, Nullable<int>, Nullable<double>, Nullable<long>, TimeExtent) Constructor

<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Model.ImageSampleParameters.html”>GeoBlazor Docs</a> Input parameters for the <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#getSamples”>getSamples()</a> method on <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html”>ImageryLayer</a>. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html”>ArcGIS Maps SDK for JavaScript</a>

public ImageSampleParameters(dymaptic.GeoBlazor.Core.Components.Geometries.Geometry? Geometry=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.Interpolation> Interpolation=null, System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Components.Geometries.Point>? Locations=null, dymaptic.GeoBlazor.Core.Model.MosaicRule? MosaicRule=null, System.Collections.Generic.IReadOnlyCollection<string>? OutFields=null, dymaptic.GeoBlazor.Core.Components.Geometries.Point? PixelSize=null, System.Nullable<bool> ReturnFirstValueOnly=null, System.Nullable<int> SampleCount=null, System.Nullable<double> SampleDistance=null, System.Nullable<long> SliceId=null, dymaptic.GeoBlazor.Core.Components.TimeExtent? TimeExtent=null);

Parameters

Geometry dymaptic.GeoBlazor.Core.Components.Geometries.Geometry

Input geometry that defines the locations to be sampled. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#geometry”>ArcGIS Maps SDK for JavaScript</a>

Interpolation System.Nullable<dymaptic.GeoBlazor.Core.Enums.Interpolation>

Defines how to interpolate pixel values. default “nearest” <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#interpolation”>ArcGIS Maps SDK for JavaScript</a>

Locations System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Components.Geometries.Point>

When sampling multiple locations, you can use an array of <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html”>points</a> instead of providing a <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html”>multipoint</a> for the <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#geometry”>geometry</a> property. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#locations”>ArcGIS Maps SDK for JavaScript</a>

MosaicRule dymaptic.GeoBlazor.Core.Model.MosaicRule

Specifies the <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html”>mosaic rule</a> defining the image sort order and selection. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#mosaicRule”>ArcGIS Maps SDK for JavaScript</a>

OutFields System.Collections.Generic.IReadOnlyCollection<System.String>

The list of fields associated with the rasters to be included in the response. default null <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#outFields”>ArcGIS Maps SDK for JavaScript</a>

PixelSize dymaptic.GeoBlazor.Core.Components.Geometries.Point

Specifies the pixel size (or the resolution) that will be used for the sampling. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#pixelSize”>ArcGIS Maps SDK for JavaScript</a>

ReturnFirstValueOnly System.Nullable<System.Boolean>

When `true`, returns the first valid pixel value that meets specified conditions at each sampling point location. default true <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#returnFirstValueOnly”>ArcGIS Maps SDK for JavaScript</a>

SampleCount System.Nullable<System.Int32>

Specifies the approximate number of locations to sample from the provided geometry when the input geometry is <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html”>polyline</a>, <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html”>polygon</a> or <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html”>extent</a>. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#sampleCount”>ArcGIS Maps SDK for JavaScript</a>

SampleDistance System.Nullable<System.Double>

Specifies the distance interval to sample points from the provided <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#geometry”>geometry</a> when input geometry is <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html”>polyline</a>. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#sampleDistance”>ArcGIS Maps SDK for JavaScript</a>

SliceId System.Nullable<System.Int64>

Specifies the slice id of a multidimensional raster. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#sliceId”>ArcGIS Maps SDK for JavaScript</a>

TimeExtent dymaptic.GeoBlazor.Core.Components.TimeExtent

The <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-time-TimeExtent.html”>time extent</a> for which to perform sampling. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#timeExtent”>ArcGIS Maps SDK for JavaScript</a>

Properties

ImageSampleParameters.Geometry Property

Input geometry that defines the locations to be sampled. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#geometry”>ArcGIS Maps SDK for JavaScript</a>

public dymaptic.GeoBlazor.Core.Components.Geometries.Geometry? Geometry { get; set; }

Property Value

dymaptic.GeoBlazor.Core.Components.Geometries.Geometry

ImageSampleParameters.Interpolation Property

Defines how to interpolate pixel values. default “nearest” <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#interpolation”>ArcGIS Maps SDK for JavaScript</a>

public System.Nullable<dymaptic.GeoBlazor.Core.Enums.Interpolation> Interpolation { get; set; }

Property Value

System.Nullable<dymaptic.GeoBlazor.Core.Enums.Interpolation>

ImageSampleParameters.Locations Property

When sampling multiple locations, you can use an array of <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html”>points</a> instead of providing a <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html”>multipoint</a> for the <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#geometry”>geometry</a> property. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#locations”>ArcGIS Maps SDK for JavaScript</a>

public System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Components.Geometries.Point>? Locations { get; set; }

Property Value

System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Components.Geometries.Point>

ImageSampleParameters.MosaicRule Property

Specifies the <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html”>mosaic rule</a> defining the image sort order and selection. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#mosaicRule”>ArcGIS Maps SDK for JavaScript</a>

public dymaptic.GeoBlazor.Core.Model.MosaicRule? MosaicRule { get; set; }

Property Value

dymaptic.GeoBlazor.Core.Model.MosaicRule

ImageSampleParameters.OutFields Property

The list of fields associated with the rasters to be included in the response. default null <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#outFields”>ArcGIS Maps SDK for JavaScript</a>

public System.Collections.Generic.IReadOnlyCollection<string>? OutFields { get; set; }

Property Value

System.Collections.Generic.IReadOnlyCollection<System.String>

ImageSampleParameters.PixelSize Property

Specifies the pixel size (or the resolution) that will be used for the sampling. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#pixelSize”>ArcGIS Maps SDK for JavaScript</a>

public dymaptic.GeoBlazor.Core.Components.Geometries.Point? PixelSize { get; set; }

Property Value

dymaptic.GeoBlazor.Core.Components.Geometries.Point

ImageSampleParameters.ReturnFirstValueOnly Property

When `true`, returns the first valid pixel value that meets specified conditions at each sampling point location. default true <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#returnFirstValueOnly”>ArcGIS Maps SDK for JavaScript</a>

public System.Nullable<bool> ReturnFirstValueOnly { get; set; }

Property Value

System.Nullable<System.Boolean>

ImageSampleParameters.SampleCount Property

Specifies the approximate number of locations to sample from the provided geometry when the input geometry is <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html”>polyline</a>, <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html”>polygon</a> or <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html”>extent</a>. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#sampleCount”>ArcGIS Maps SDK for JavaScript</a>

public System.Nullable<int> SampleCount { get; set; }

Property Value

System.Nullable<System.Int32>

ImageSampleParameters.SampleDistance Property

Specifies the distance interval to sample points from the provided <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#geometry”>geometry</a> when input geometry is <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html”>polyline</a>. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#sampleDistance”>ArcGIS Maps SDK for JavaScript</a>

public System.Nullable<double> SampleDistance { get; set; }

Property Value

System.Nullable<System.Double>

ImageSampleParameters.SliceId Property

Specifies the slice id of a multidimensional raster. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#sliceId”>ArcGIS Maps SDK for JavaScript</a>

public System.Nullable<long> SliceId { get; set; }

Property Value

System.Nullable<System.Int64>

ImageSampleParameters.TimeExtent Property

The <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-time-TimeExtent.html”>time extent</a> for which to perform sampling. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#timeExtent”>ArcGIS Maps SDK for JavaScript</a>

public dymaptic.GeoBlazor.Core.Components.TimeExtent? TimeExtent { get; set; }

Property Value

dymaptic.GeoBlazor.Core.Components.TimeExtent