layout: default title: RasterStretchRenderer parent: Core Classes —
dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Renderers
RasterStretchRenderer Class
RasterStretchRenderer defines the symbology with a gradual ramp of colors for each pixel in a ImageryLayer, ImageryTileLayer,
and WCSLayer based on the pixel value. The RasterStretchRenderer works well when you have a large range of values to display,
such as in imagery, aerial photographs, or elevation models. Important to note that RasterStretchRenderer does not inherit from
Renderer class.
ArcGIS Maps SDK for JavaScript
public class RasterStretchRenderer : dymaptic.GeoBlazor.Core.Components.MapComponent,
dymaptic.GeoBlazor.Core.Components.Renderers.IImageryRenderer
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 RasterStretchRenderer
Implements IImageryRenderer
Constructors
RasterStretchRenderer() Constructor
Constructor for use in code
public RasterStretchRenderer();
RasterStretchRenderer(ColorRamp, Nullable, Nullable, List, Nullable, Nullable, Nullable, RasterStatistics[], Nullable, Nullable) Constructor
Constructor for use in code
public RasterStretchRenderer(dymaptic.GeoBlazor.Core.Components.Renderers.ColorRamps.ColorRamp? colorRamp=null, System.Nullable<bool> computeGamma=null, System.Nullable<bool> dynamicRangeAdjustment=null, System.Collections.Generic.List<int>? gamma=null, System.Nullable<int> outputMax=null, System.Nullable<int> outputMin=null, System.Nullable<dymaptic.GeoBlazor.Core.Components.Renderers.StretchType> stretchType=null, dymaptic.GeoBlazor.Core.Components.Renderers.RasterStatistics[]? statistics=null, System.Nullable<bool> useGamma=null, System.Nullable<int> numberOfStandardDeviations=null);
Parameters
colorRamp ColorRamp
The stretched values are mapped to this specified color ramp.
computeGamma System.Nullable<System.Boolean>
The computeGamma automatically calculates best gamma value to render exported image based on empirical model. This is applicable to any stretch type when useGamma is true.
dynamicRangeAdjustment System.Nullable<System.Boolean>
When Dynamic Range Adjustment is true, the statistics based on the current display extent are calculated as you zoom and pan around the image. This property only applies
gamma System.Collections.Generic.List<System.Int32>
The gamma values to be used if useGamma is set to true. Gamma refers to the degree of contrast between the mid-level gray values of a raster dataset. Gamma does not
outputMax System.Nullable<System.Int32>
The outputMax denotes the output maximum, which is the highest pixel value. The outputMin and outputMax will set the range of values that will then be linearly contrast
outputMin System.Nullable<System.Int32>
The outputMin denotes the output minimum, which is the lowest pixel value. The outputMin and outputMax will set the range of values that will then be linearly contrast
stretchType System.Nullable<StretchType>
The stretch type defines a histogram stretch that will be applied to the rasters to enhance their appearance. Stretching improves the appearance of the data by spreading the
statistics RasterStatistics[]
The input statistics can be specified through the statistics property.
useGamma System.Nullable<System.Boolean>
Denotes whether the gamma value should be used.
numberOfStandardDeviations System.Nullable<System.Int32>
Applicable when stretchType is standard-deviation. Specifies the number of standard deviations to use. The values beyond the number of standard deviations become the outputMin
Properties
RasterStretchRenderer.ColorRamp Property
The stretched values are mapped to this specified color ramp.
public dymaptic.GeoBlazor.Core.Components.Renderers.ColorRamps.ColorRamp? ColorRamp { get; set; }
Property Value
RasterStretchRenderer.ComputeGamma Property
The computeGamma automatically calculates best gamma value to render exported image based on empirical model. This is applicable to any stretch type when useGamma is true.
public System.Nullable<bool> ComputeGamma { get; set; }
Property Value
System.Nullable<System.Boolean>
RasterStretchRenderer.DynamicRangeAdjustment Property
When Dynamic Range Adjustment is true, the statistics based on the current display extent are calculated as you zoom and pan around the image. This property only applies
to images in 2D MapView.
public System.Nullable<bool> DynamicRangeAdjustment { get; set; }
Property Value
System.Nullable<System.Boolean>
RasterStretchRenderer.Gamma Property
The gamma values to be used if useGamma is set to true. Gamma refers to the degree of contrast between the mid-level gray values of a raster dataset. Gamma does not
affect the black or white values in a raster dataset, only the middle values. By applying a gamma correction, you can control the overall brightness of a layer.
Gamma stretching is only valid with the none, standard-deviation, and min-max stretch
public System.Collections.Generic.List<int>? Gamma { get; set; }
Property Value
System.Collections.Generic.List<System.Int32>
RasterStretchRenderer.ImageryRendererType Property
The type of renderer.
public string ImageryRendererType { get; }
Implements ImageryRendererType
Property Value
RasterStretchRenderer.NumberOfStandardDeviations Property
Applicable when stretchType is standard-deviation. Specifies the number of standard deviations to use. The values beyond the number of standard deviations become the outputMin
and outputMax. The remaining values are linearly stretched between outputMin and outputMax.
public System.Nullable<int> NumberOfStandardDeviations { get; set; }
Property Value
RasterStretchRenderer.OutputMax Property
The outputMax denotes the output maximum, which is the highest pixel value. The outputMin and outputMax will set the range of values that will then be linearly contrast
stretched. The outputMax value ranges from 0-255.
public System.Nullable<int> OutputMax { get; set; }
Property Value
RasterStretchRenderer.OutputMin Property
The outputMin denotes the output minimum, which is the lowest pixel value. The outputMin and outputMax will set the range of values that will then be linearly contrast
stretched. The outputMin value ranges from 0-255.
public System.Nullable<int> OutputMin { get; set; }
Property Value
RasterStretchRenderer.Statistics Property
The input statistics can be specified through the statistics property.
public dymaptic.GeoBlazor.Core.Components.Renderers.RasterStatistics[]? Statistics { get; set; }
Property Value
RasterStretchRenderer.StretchType Property
The stretch type defines a histogram stretch that will be applied to the rasters to enhance their appearance. Stretching improves the appearance of the data by spreading the
pixel values along a histogram from the minimum and maximum values defined by their bit depth.
public System.Nullable<dymaptic.GeoBlazor.Core.Components.Renderers.StretchType> StretchType { get; set; }
Property Value
RasterStretchRenderer.Type Property
Type for compatibility with other renderers.
public string Type { get; }
Property Value
RasterStretchRenderer.UseGamma Property
Denotes whether the gamma value should be used.
public System.Nullable<bool> UseGamma { get; set; }
Property Value
System.Nullable<System.Boolean>
Methods
RasterStretchRenderer.RegisterChildComponent(MapComponent) Method
Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to “Register” the current component with it’s parent.
public override System.Threading.Tasks.Task RegisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);
Parameters
child MapComponent
The calling, child component to register
Returns
Exceptions
InvalidChildElementException
Throws if the current child is not a valid sub-component to the parent.
Remarks
This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method. If you see no other way to register a child component, please open an issue on GitHub.
RasterStretchRenderer.SetStretchType(StretchType) Method
Updates the StretchType of the renderer after initial rendering.
public System.Threading.Tasks.Task SetStretchType(dymaptic.GeoBlazor.Core.Components.Renderers.StretchType stretchType);
Parameters
stretchType StretchType
Returns
RasterStretchRenderer.UnregisterChildComponent(MapComponent) Method
Undoes the “Registration” of a child with its parent.
public override System.Threading.Tasks.Task UnregisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);
Parameters
child MapComponent
The child to unregister
Returns
Remarks
This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method.