Class MosaicRasterClass

Namespace
ESRI.ArcGIS.DatasourcesRaster
Assembly
ESRI.Server.DatasourcesRaster.dll
[Guid("1375C45E-1F1E-4687-A62F-13EA270772C5")]
[ClassInterface(ClassInterfaceType.None)]
public class MosaicRasterClass : MosaicRaster, IMosaicRaster, IMosaicRaster2, IRasterCollection, IRaster, IRasterProps, IGeoDataset, ISaveAs2, ISaveAs, IPixelOperation, ISupportErrorInfo
Inheritance
MosaicRasterClass
Implements
Inherited Members

Constructors

MosaicRasterClass()

public MosaicRasterClass()

Explicit Interface Implementations

Append(IRaster)

Appends a raster to the end.

virtual void Append(IRaster pRaster)

Parameters

pRaster IRaster

Ascending

Indicates whether the ascending flag of OrderBy.

virtual bool Ascending { get; set; }

Returns

bool

CanSaveAs(string)

Checks if it's can be saved as a new persistent Dataset of a given format.

virtual bool CanSaveAs(string Format)

Parameters

Format string

Returns

bool

Colormap

The colormap to be used.

virtual IRasterColormap Colormap { get; set; }

Returns

IRasterColormap

CreateCursor()

Allocates a Raster Cursor for fast raster scanning.

virtual IRasterCursor CreateCursor()

Returns

IRasterCursor

CreatePixelBlock(IPnt)

Allocates a PixelBlock of requested size.

virtual IPixelBlock CreatePixelBlock(IPnt Size)

Parameters

Size IPnt

Returns

IPixelBlock

Remarks

CreatePixelBlock method only initializes the properties of a pixel block, such as dimension, pixel type etc. Read method of this interface should be used to read pixels into the pixel block.

Empty()

Empties this raster collection.

virtual void Empty()

Extent

The extent of the Raster.

virtual IEnvelope Extent { get; set; }

Returns

IEnvelope

Find(IRaster)

Finds a given raster and returns its index position.

virtual int Find(IRaster pRaster)

Parameters

pRaster IRaster

Returns

int

Get(int)

Gets the raster at a given index position.

virtual IRaster Get(int Index)

Parameters

Index int

Returns

IRaster

Height

Height in pixels.

virtual int Height { get; set; }

Returns

int

IGeoDataset_Extent

The extent of the GeoDataset.

virtual IEnvelope IGeoDataset_Extent { get; }

Returns

IEnvelope

Remarks

The IGeoDataset::Extent property returns an envelope representing the maximum extent of data which has been stored in the dataset.

Consider the following scenario. A new feature class has features added to it. The IGeoDataset::Extent is then requested and an envelope is returned. The extents of the envelope returned are represented by the red box in the image below.

The red box represents the IGeoDataset extent

If a portion of the features were then deleted and the extent is again requested an envelope with the exact same extents as during the first request would be returned (see image below). This is because the deletion of features does not shrink the extent. However all additions of features outside the red box would increase the envelope returned to encompass the newly added features.

The red box represents the IGeoDataset extent after some of the features have been deleted

If you would like to update the IGeoDataset::Extent property to reflect the current features in your dataset please see IFeatureClassManage::UpdateExtent (also see IFeatureClassLoad). In the image below the extent has been updated and a new envelope is being returned.

The red box represents the IGeoDataset extent after it has been updated

ESRI's GroupLayer implements this property differently from most other layer coclasses. When you instantiate a new GroupLayer, this property will return a valid envelope with zero height and width. With most other newly instantiated layers (for example FeatureLayer, RasterLayer, TinLayer), this property initally returns Nothing.

 

IGeoDataset_SpatialReference

The spatial reference of the GeoDataset.

virtual ISpatialReference IGeoDataset_SpatialReference { get; }

Returns

ISpatialReference

Remarks

This property is read only. For layers, when the first layer is added to ArcMap, its spatial reference is read by this property, and the map is set to this spatial reference.

Instances of the esriCarto.GroupLayer class will return null for this property, as a group layer can contain multiple datasets with different spatial references.

Modifications to a spatial reference returned by this property will not be persisted. To modify the spatial reference of a dataset, the IGeoDatasetSchemaEdit and IGeoDatasetSchemaEdit2 interfaces should be used.

ISaveAs2_CanSaveAs(string)

virtual bool ISaveAs2_CanSaveAs(string Format)

Parameters

Format string

Returns

bool

ISaveAs2_SaveAs(string, IWorkspace, string)

virtual IDataset ISaveAs2_SaveAs(string Name, IWorkspace Workspace, string Format)

Parameters

Name string
Workspace IWorkspace
Format string

Returns

IDataset

Insert(int, IRaster)

Inserts a raster at a given index.

virtual void Insert(int Index, IRaster pRaster)

Parameters

Index int
pRaster IRaster

InterfaceSupportsErrorInfo(ref Guid)

virtual void InterfaceSupportsErrorInfo(ref Guid riid)

Parameters

riid Guid

IsInteger

Indicates if the data is integer.

virtual bool IsInteger { get; }

Returns

bool

MapModel

Map to raster transformation information.

virtual IRasterMapModel MapModel { get; set; }

Returns

IRasterMapModel

MeanCellSize()

Returns the approximate cell size of the raster.

virtual IPnt MeanCellSize()

Returns

IPnt

MosaicColormapMode

The current mode for mosaicking pseucolor rasters.

virtual rstMosaicColormapMode MosaicColormapMode { get; set; }

Returns

rstMosaicColormapMode

Remarks

It is only applicable to ArcSDE rasters.

MosaicOperator

The current mosaic operator.

virtual IMosaicOperator MosaicOperator { get; set; }

Returns

IMosaicOperator

MosaicOperatorType

The current mosaic operator type.

virtual rstMosaicOperatorType MosaicOperatorType { get; set; }

Returns

rstMosaicOperatorType

NoDataValue

Data value used to indicate invalid or excluded data.

virtual object NoDataValue { get; set; }

Returns

object

Remarks

Specifying a single NoData value for a multiband raster, the NoData value will apply to each raster band in the raster. To set different NoData value for each band, pass an array, each element in the array sets the NoData value for the corresponding band, to this property.

OrderByField

The Order By fields on the base RasterCatalog.

virtual string OrderByField { get; set; }

Returns

string

PixelFilter

The pixel filter for filtering pixel values.

virtual IPixelFilter PixelFilter { get; set; }

Returns

IPixelFilter

PixelType

Data type of the pixels.

virtual rstPixelType PixelType { get; set; }

Returns

rstPixelType

Populate(IEnvelope)

Populates this raster collection from associated RasterCatalog.

virtual void Populate(IEnvelope pExtent)

Parameters

pExtent IEnvelope

RasterCatalog

The base RasterCatalog.

virtual IRasterCatalog RasterCatalog { get; set; }

Returns

IRasterCatalog

RasterCatalogTable

The source raster catalog table.

virtual IRasterCatalogTable RasterCatalogTable { get; set; }

Returns

IRasterCatalogTable

RasterCount

The number of rasters in this raster collection.

virtual int RasterCount { get; }

Returns

int

Read(IPnt, IPixelBlock)

Read a block of pixels starting from the top left corner.

virtual void Read(IPnt tlc, IPixelBlock block)

Parameters

tlc IPnt
block IPixelBlock

RecalculateCellsize(esriCellsizeType)

Recalculates the cellsize as (min, max, or mean) of all cellsizes.

virtual void RecalculateCellsize(esriCellsizeType Type)

Parameters

Type esriCellsizeType

Remove(int)

Removes a raster at a given index.

virtual void Remove(int Index)

Parameters

Index int

ResampleMethod

Interpolation method used when reading pixels.

virtual rstResamplingTypes ResampleMethod { get; set; }

Returns

rstResamplingTypes

SaveAs(string, IWorkspace, string)

Creates a new persistent Dataset of a given format.

virtual IDataset SaveAs(string Name, IWorkspace Workspace, string Format)

Parameters

Name string
Workspace IWorkspace
Format string

Returns

IDataset

Remarks

The format strings used for the supported formats are below, and they are case sensitive:

Format Name String Used
Imagine "IMAGINE Image"
TIFF "TIFF"
GRID "GRID"
JPEG "JPG"
JP2000 "JP2"
BMP "BMP"
PNG "PNG"
GIF "GIF"
PCI Raster "PIX"
X11 Pixmap "XPM"
PCRaster "MAP"
Memory Raster "MEM"
HDF4 "HDF4"
BIL "BIL"
BIP "BIP"
BSQ "BSQ"
Idrisi Raster Format "RST"
ENVI Raster Format "ENVI"
Geodatabase Raster "GDB"
 

 

 

Note, SaveAs will return a RasterDataset, to prevent from ISaveAs holding the output, .NET ReleaseCOMObject needs to be called to release the referene to the output raster dataset:

    System.Runtime.InteropServices.Marshal.ReleaseComObject(outRasterDS);

 

SaveAsRasterDataset(string, IWorkspace, string, IRasterStorageDef)

Creates a new persistent Raster Dataset of a given format and specified storage definition.

virtual IRasterDataset SaveAsRasterDataset(string Name, IWorkspace Workspace, string Format, IRasterStorageDef StorageDef)

Parameters

Name string
Workspace IWorkspace
Format string
StorageDef IRasterStorageDef

Returns

IRasterDataset

Set(int, IRaster)

Sets the raster at a given index position.

virtual void Set(int Index, IRaster pRaster)

Parameters

Index int
pRaster IRaster

SpatialReference

SpatialReference of the Raster.

virtual ISpatialReference SpatialReference { get; set; }

Returns

ISpatialReference

WhereClause

The Where Clause on the base RasterCatalog.

virtual string WhereClause { get; set; }

Returns

string

Width

Width in pixels.

virtual int Width { get; set; }

Returns

int