Class RasterDatasetClass

Namespace
ESRI.ArcGIS.DatasourcesRaster
Assembly
ESRI.Server.DatasourcesRaster.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("7ACA3D07-0629-11D2-8D24-0000F8780535")]
public class RasterDatasetClass : RasterDataset, IRasterDataset3, IRasterDataset2, IRasterDataset, IRasterDatasetEdit3, IRasterDatasetEdit2, IRasterDatasetEdit, IDataset, IGeoDataset, IGeoDatasetSchemaEdit2, IGeoDatasetSchemaEdit, IRasterBandCollection, IRasterPyramid4, IRasterPyramid3, IRasterPyramid2, IRasterPyramid, IMetadata, IMetadataEdit, INativeTypeInfo, ITemporaryDataset, IDatasetAnalyze, IDatasetFileStat, ISupportErrorInfo, IWorldFileExport, IWorldFileExport2, IRasterDatasetJukebox, ISaveAs2, ISaveAs, IRawBlocks
Inheritance
RasterDatasetClass
Implements
Inherited Members

Constructors

RasterDatasetClass()

public RasterDatasetClass()

Explicit Interface Implementations

Add(IRasterBand, int)

Adds a RasterBand to the band collection.

virtual void Add(IRasterBand Element, int Index)

Parameters

Element IRasterBand
Index int

Remarks

This method is only applicable to work with a Raster, not with a RasterDataset.

AllowableComponents

The allowable components to be analyzed.

virtual int AllowableComponents { get; }

Returns

int

Remarks

The AllowableComponents property indicates which parts of the table or feature class can be analyzed. The returned value is based on the esriTableComponents enumeration. Members from this enumeration can be bitwise or’d together.

AlterAttributeTable(ITable)

Alters the raster attribute table.

virtual void AlterAttributeTable(ITable newTable)

Parameters

newTable ITable

AlterColormap(IRasterColormap)

Alters colormap.

virtual void AlterColormap(IRasterColormap Colormap)

Parameters

Colormap IRasterColormap

AlterGeodataXform(IGeodataXform)

Alters the geodata transformation of the dataset (does not transform the data).

virtual void AlterGeodataXform(IGeodataXform xform)

Parameters

xform IGeodataXform

AlterResolution(double, double, double)

Alters the resolution of the dataset and rebuilds the spatial indexes.

virtual void AlterResolution(double xyResolution, double zResolution, double mResolution)

Parameters

xyResolution double
zResolution double
mResolution double

Remarks

AlterResolution will change the resolution of the dataset based on the supplied XY, Z and M resolution values and rebuild the spatial indices.  AlterResolution can only be used on Low Precision datasets within a 9.2 Geodatabase.  To determine if AlterPrecision can be used on dataset, use the IControlPrecision2::IsHighPrecision  property.

Use the IGeoDatasetSchemaEdit2::ConstructResolutions method to obtain the applicable levels of resolution for your data.

If a value of -1 is supplied for the xyResolution or zResolution arguments, the current resolution will be maintained.  The current resolution of for a dataset can be obtained from its spatial reference using the ISpatialReferenceResolution interface.

Any of the following scenarios will result in an error:

  • If a value supplied is not equal to one of the possible resolutions returned by IGeoDatasetSchemaEdit2::ConstructResolutions.
  • If a resolution value that is coarser or larger than the current resolution is supplied.
  • If a value of 0 or a negative value other than -1 is supplied.

AlterSpatialReference(ISpatialReference)

Alters the spatial reference of the dataset to match the coordinate system of the input spatial reference, does not reproject the data.

virtual void AlterSpatialReference(ISpatialReference SpatialReference)

Parameters

SpatialReference ISpatialReference

Analyze(int)

Analyze the data to update/generate DBMS statistics.

virtual void Analyze(int tableComponents)

Parameters

tableComponents int

Remarks

When applied to a feature dataset, Analyze updates the statistics for all of the tables.

AppendBand(IRasterBand)

Appends a RasterBand to the band collection.

virtual void AppendBand(IRasterBand Element)

Parameters

Element IRasterBand

Remarks

This method is only applicable to work with a Raster, not with a RasterDataset.

AppendBands(IRasterBandCollection)

Appends a collection of RasterBands to the band collection.

virtual void AppendBands(IRasterBandCollection Bands)

Parameters

Bands IRasterBandCollection

Remarks

This method is only applicable to work with a Raster, not with a RasterDataset.

AppendNewBand()

Appends a new raster band.

virtual void AppendNewBand()

Remarks

This method is available only on a raster dataset in File and ArcSDE geodatabases.

BandByName[string]

A RasterBand given its name.

virtual IRasterBand BandByName[string Name] { get; }

Parameters

Name string

Returns

IRasterBand

BandIndex[string]

The index of a RasterBand given its name.

virtual int BandIndex[string Name] { get; }

Parameters

Name string

Returns

int

Bands

All the bands in the collection as an interface to the RasterBands enumerator object.

virtual IEnumRasterBand Bands { get; }

Returns

IEnumRasterBand

BasicOpenFromFile(string)

Opens the dataset from file.

virtual void BasicOpenFromFile(string Path)

Parameters

Path string

BlockHeight

The native block height.

virtual int BlockHeight { get; }

Returns

int

BlockWidth

The native block width.

virtual int BlockWidth { get; }

Returns

int

BrowseName

The browse name of the dataset.

virtual string BrowseName { get; set; }

Returns

string

Remarks

BrowseName returns file names without their extension. For example, States.shp would appear as States.

BuildAttributeTable()

Builds the raster attribute table.

virtual void BuildAttributeTable()

BuildPyramid(IPropertySet)

virtual void BuildPyramid(IPropertySet pAttributes)

Parameters

pAttributes IPropertySet

BuildPyramid(int, rstResamplingTypes)

Builds pyramid for this RasterDataset.

virtual void BuildPyramid(int maxLevel, rstResamplingTypes Method)

Parameters

maxLevel int
Method rstResamplingTypes

CanAlterAttributeTable

Indicates if the raster attribute table can be altered.

virtual bool CanAlterAttributeTable { get; }

Returns

bool

CanAlterGeodataXform

Indicates if the geodata transformation of the dataset can be altered.

virtual bool CanAlterGeodataXform { get; }

Returns

bool

CanAlterSpatialReference

Indicates if the spatial reference of the dataset can be altered.

virtual bool CanAlterSpatialReference { get; }

Returns

bool

CanCopy()

Returns true if this dataset can be copied.

virtual bool CanCopy()

Returns

bool

CanDelete()

True if this dataset can be deleted.

virtual bool CanDelete()

Returns

bool

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods.  For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class.  To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

CanEditMetadata

Indicates if metadata can be edited.

virtual bool CanEditMetadata { get; }

Returns

bool

Remarks

This property is available to those objects that support metadata.

CanRename()

True if this dataset can be renamed.

virtual bool CanRename()

Returns

bool

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods.  For example, you may not delete or rename a network feature class nor can you use the Copy method on a Geodatabase feature class.  To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

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

CanWrite

Indicates if this RasterDataset is writable.

virtual bool CanWrite { get; }

Returns

bool

Category

The category of the dataset.

virtual string Category { get; }

Returns

string

Remarks

IDataset::Category returns a description of the category of the dataset.  The description returned from the Category property is the same value that is displayed in the Type column within the Contents tab in ArcCatalog.  The value will contain a description of the dataset such as "Topology" prefixed with a description of the type of workspace containing the dataset such as "File Geodatabase".

The description returned from IDataset::Category may change between releases of ArcGIS. In addition to this, returned strings are localized, meaning that code relying on a specific string being provided may fail when deployed with a different version of ArcGIS than it was developed with, or when deployed to a client using a different language than it was developed with.

Clear()

Removes all the elements in the collection.

virtual void Clear()

Remarks

This method is only applicable to work with a Raster, not with a RasterDataset.

CompleteName

The full path of the RasterDataset.

virtual string CompleteName { get; }

Returns

string

CompressionType

The compression technique applied to this RasterDataset.

virtual string CompressionType { get; }

Returns

string

ComputeStatisticsHistogram(int, int, object, bool)

Computes statistics and histogram for a skip factor and a list of Ignore vlaues.

virtual void ComputeStatisticsHistogram(int skipx, int skipy, object ignoreValues, bool requireHistogram)

Parameters

skipx int
skipy int
ignoreValues object
requireHistogram bool

ComputeStats(int)

Calculates statistics and histograms from a given pyramid level.

virtual void ComputeStats(int PyramidLevel)

Parameters

PyramidLevel int

Remarks

This method is avaliable only on raster datasets in File and ArcSDE geodatabases.

ConstructResolutions(ISpatialReference, int, out int, out IDoubleArray, out IDoubleArray, out IDoubleArray)

Returns a list of possible resolutions (precisions) and the doubling factors that produce them from the specified low precision spatial reference. The zeroth returned element is the current precision of the spatial reference.

virtual void ConstructResolutions(ISpatialReference SpatialReference, int numberRequested, out int defaultXYResolutionIndex, out IDoubleArray xyResolutions, out IDoubleArray zResolutions, out IDoubleArray mResolutions)

Parameters

SpatialReference ISpatialReference
numberRequested int
defaultXYResolutionIndex int
xyResolutions IDoubleArray
zResolutions IDoubleArray
mResolutions IDoubleArray

Remarks

ConstructResolutions should be used to determine the acceptable levels of resolution available for AlterResolution.

Copy(string, IWorkspace)

Copies this dataset to a new dataset with the specified name.

virtual IDataset Copy(string copyName, IWorkspace copyWorkspace)

Parameters

copyName string
copyWorkspace IWorkspace

Returns

IDataset

Count

The number of bands in the collection.

virtual int Count { get; }

Returns

int

Create()

Build raster pyramids for this raster.

virtual void Create()

CreateDefaultRaster()

Creates a raster object with the default properties for this dataset.

virtual IRaster CreateDefaultRaster()

Returns

IRaster

Remarks

The CreateDefaultRaster method creates a Raster that has a square cell size and contains only three raster bands if the dataset has more than three bands. The three bands are the default bands used in raster RGB renderer and are determined by the settings for default raster behavior made on the RasterDefaultsEnv object in esriCarto library.

CreateFullRaster()

Creates a raster containing all bands in this raster dataset.

virtual IRaster CreateFullRaster()

Returns

IRaster

CreatePixelBlock()

Create a compatible pixel block.

virtual IPixelBlock CreatePixelBlock()

Returns

IPixelBlock

CreateRaster()

Creates an empty raster.

virtual IRaster CreateRaster()

Returns

IRaster

Remarks

An empty raster means that properties of the Raster are not defined. The width, height, and the number of bands of the raster are all 0. It can not be used before populating pixels to it.

Delete()

Deletes this dataset.

virtual void Delete()

Remarks

Certain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.

DeleteAttributeTable()

Deletes the raster attribute table.

virtual void DeleteAttributeTable()

DeleteColormap()

Deletes colormap.

virtual void DeleteColormap()

Remarks

This method only applies to database Rasterdataset , a raster dataset stored in a File or ArcSDE geodatabase.

DeletePyramid()

Deletes pyramid for this RasterDataset.

virtual void DeletePyramid()

DeleteStats()

Deletes statistics and histograms.

virtual void DeleteStats()

Remarks

This method is avaliable only on raster datasets in File and ArcSDE geodatabases.

Erase(IEnvelope)

Erases a rectanglar area of this RasterDataset.

virtual void Erase(IEnvelope Extent)

Parameters

Extent IEnvelope

Extent

The extent of the GeoDataset.

virtual IEnvelope 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.

 

FirstPyramidLevel

The first available pyramid level.

virtual int FirstPyramidLevel { get; }

Returns

int

Flush()

Flushes buffered data.

virtual void Flush()

Format

The format of this RasterRataset.

virtual string Format { get; }

Returns

string

FullName

The associated name object.

virtual IName FullName { get; }

Returns

IName

Remarks

The FullName property returns a Name object for the dataset. The Name object can be persisted and provides a way to get back to the dataset in a future session of the application, via the Open method on the Name object.

IDataset_CanCopy()

True if this dataset can be copied.

virtual bool IDataset_CanCopy()

Returns

bool

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods.  For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class.  To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

The CanCopy method is supported by:

  • CAD Drawings
  • Coverages
  • DBase Tables
  • Info Tables
  • Raster Datasets
  • SDC datasets
  • SDC Network Datasets
  • Shapefiles
  • Shapefile Network Datasets

IDataset_Copy(string, IWorkspace)

Copies this dataset to a new dataset with the specified name.

virtual IDataset IDataset_Copy(string copyName, IWorkspace copyWorkspace)

Parameters

copyName string
copyWorkspace IWorkspace

Returns

IDataset

Remarks

IDataset::Copy should only be used with datasets from file-based data sources, such as shapefiles and coverages.

IGeoDatasetSchemaEdit2_AlterSpatialReference(ISpatialReference)

virtual void IGeoDatasetSchemaEdit2_AlterSpatialReference(ISpatialReference SpatialReference)

Parameters

SpatialReference ISpatialReference

IGeoDatasetSchemaEdit2_CanAlterSpatialReference

virtual bool IGeoDatasetSchemaEdit2_CanAlterSpatialReference { get; }

Returns

bool

IRasterDataset2_BasicOpenFromFile(string)

virtual void IRasterDataset2_BasicOpenFromFile(string Path)

Parameters

Path string

IRasterDataset2_CanCopy()

virtual bool IRasterDataset2_CanCopy()

Returns

bool

IRasterDataset2_CompleteName

virtual string IRasterDataset2_CompleteName { get; }

Returns

string

IRasterDataset2_CompressionType

virtual string IRasterDataset2_CompressionType { get; }

Returns

string

IRasterDataset2_Copy(string, IWorkspace)

virtual IDataset IRasterDataset2_Copy(string copyName, IWorkspace copyWorkspace)

Parameters

copyName string
copyWorkspace IWorkspace

Returns

IDataset

IRasterDataset2_CreateDefaultRaster()

virtual IRaster IRasterDataset2_CreateDefaultRaster()

Returns

IRaster

IRasterDataset2_Format

virtual string IRasterDataset2_Format { get; }

Returns

string

IRasterDataset2_OpenFromFile(string)

virtual void IRasterDataset2_OpenFromFile(string Path)

Parameters

Path string

IRasterDataset2_PrecalculateStats(object)

virtual void IRasterDataset2_PrecalculateStats(object index_list)

Parameters

index_list object

IRasterDataset2_SensorType

virtual string IRasterDataset2_SensorType { get; }

Returns

string

IRasterDataset3_BasicOpenFromFile(string)

virtual void IRasterDataset3_BasicOpenFromFile(string Path)

Parameters

Path string

IRasterDataset3_CanCopy()

virtual bool IRasterDataset3_CanCopy()

Returns

bool

IRasterDataset3_CompleteName

virtual string IRasterDataset3_CompleteName { get; }

Returns

string

IRasterDataset3_CompressionType

virtual string IRasterDataset3_CompressionType { get; }

Returns

string

IRasterDataset3_Copy(string, IWorkspace)

virtual IDataset IRasterDataset3_Copy(string copyName, IWorkspace copyWorkspace)

Parameters

copyName string
copyWorkspace IWorkspace

Returns

IDataset

IRasterDataset3_CreateDefaultRaster()

virtual IRaster IRasterDataset3_CreateDefaultRaster()

Returns

IRaster

IRasterDataset3_CreateFullRaster()

virtual IRaster IRasterDataset3_CreateFullRaster()

Returns

IRaster

IRasterDataset3_CreateRaster()

virtual IRaster IRasterDataset3_CreateRaster()

Returns

IRaster

IRasterDataset3_Format

virtual string IRasterDataset3_Format { get; }

Returns

string

IRasterDataset3_IsEmpty

virtual bool IRasterDataset3_IsEmpty { get; }

Returns

bool

IRasterDataset3_OpenFromFile(string)

virtual void IRasterDataset3_OpenFromFile(string Path)

Parameters

Path string

IRasterDataset3_PrecalculateStats(object)

virtual void IRasterDataset3_PrecalculateStats(object index_list)

Parameters

index_list object

IRasterDataset3_SensorType

virtual string IRasterDataset3_SensorType { get; }

Returns

string

IRasterDatasetEdit2_AlterColormap(IRasterColormap)

virtual void IRasterDatasetEdit2_AlterColormap(IRasterColormap Colormap)

Parameters

Colormap IRasterColormap

IRasterDatasetEdit2_AppendNewBand()

virtual void IRasterDatasetEdit2_AppendNewBand()

IRasterDatasetEdit2_ComputeStats(int)

virtual void IRasterDatasetEdit2_ComputeStats(int PyramidLevel)

Parameters

PyramidLevel int

IRasterDatasetEdit2_DeleteColormap()

virtual void IRasterDatasetEdit2_DeleteColormap()

IRasterDatasetEdit2_DeleteStats()

virtual void IRasterDatasetEdit2_DeleteStats()

IRasterDatasetEdit2_Erase(IEnvelope)

virtual void IRasterDatasetEdit2_Erase(IEnvelope Extent)

Parameters

Extent IEnvelope

IRasterDatasetEdit2_Mosaic(IRaster, double)

virtual void IRasterDatasetEdit2_Mosaic(IRaster Raster, double tolerance)

Parameters

Raster IRaster
tolerance double

IRasterDatasetEdit2_MosaicBands(IRaster, int, double)

virtual void IRasterDatasetEdit2_MosaicBands(IRaster Raster, int Start, double tolerance)

Parameters

Raster IRaster
Start int
tolerance double

IRasterDatasetEdit3_AlterAttributeTable(ITable)

virtual void IRasterDatasetEdit3_AlterAttributeTable(ITable newTable)

Parameters

newTable ITable

IRasterDatasetEdit3_AlterColormap(IRasterColormap)

virtual void IRasterDatasetEdit3_AlterColormap(IRasterColormap Colormap)

Parameters

Colormap IRasterColormap

IRasterDatasetEdit3_AppendNewBand()

virtual void IRasterDatasetEdit3_AppendNewBand()

IRasterDatasetEdit3_BuildAttributeTable()

virtual void IRasterDatasetEdit3_BuildAttributeTable()

IRasterDatasetEdit3_CanAlterAttributeTable

virtual bool IRasterDatasetEdit3_CanAlterAttributeTable { get; }

Returns

bool

IRasterDatasetEdit3_ComputeStats(int)

virtual void IRasterDatasetEdit3_ComputeStats(int PyramidLevel)

Parameters

PyramidLevel int

IRasterDatasetEdit3_DeleteAttributeTable()

virtual void IRasterDatasetEdit3_DeleteAttributeTable()

IRasterDatasetEdit3_DeleteColormap()

virtual void IRasterDatasetEdit3_DeleteColormap()

IRasterDatasetEdit3_DeleteStats()

virtual void IRasterDatasetEdit3_DeleteStats()

IRasterDatasetEdit3_Erase(IEnvelope)

virtual void IRasterDatasetEdit3_Erase(IEnvelope Extent)

Parameters

Extent IEnvelope

IRasterDatasetEdit3_Mosaic(IRaster, double)

virtual void IRasterDatasetEdit3_Mosaic(IRaster Raster, double tolerance)

Parameters

Raster IRaster
tolerance double

IRasterDatasetEdit3_MosaicBands(IRaster, int, double)

virtual void IRasterDatasetEdit3_MosaicBands(IRaster Raster, int Start, double tolerance)

Parameters

Raster IRaster
Start int
tolerance double

IRasterPyramid2_Create()

virtual void IRasterPyramid2_Create()

IRasterPyramid2_MinimumSize

virtual IPnt IRasterPyramid2_MinimumSize { get; set; }

Returns

IPnt

IRasterPyramid2_Present

virtual bool IRasterPyramid2_Present { get; }

Returns

bool

IRasterPyramid3_BuildPyramid(int, rstResamplingTypes)

virtual void IRasterPyramid3_BuildPyramid(int maxLevel, rstResamplingTypes Method)

Parameters

maxLevel int
Method rstResamplingTypes

IRasterPyramid3_Create()

virtual void IRasterPyramid3_Create()

IRasterPyramid3_MinimumSize

virtual IPnt IRasterPyramid3_MinimumSize { get; set; }

Returns

IPnt

IRasterPyramid3_Present

virtual bool IRasterPyramid3_Present { get; }

Returns

bool

IRasterPyramid3_PyramidLevel

virtual int IRasterPyramid3_PyramidLevel { get; }

Returns

int

IRasterPyramid3_PyramidResamplingMethod

virtual rstResamplingTypes IRasterPyramid3_PyramidResamplingMethod { get; }

Returns

rstResamplingTypes

IRasterPyramid4_BuildPyramid(int, rstResamplingTypes)

Builds pyramid for this RasterDataset.

virtual void IRasterPyramid4_BuildPyramid(int maxLevel, rstResamplingTypes Method)

Parameters

maxLevel int
Method rstResamplingTypes

IRasterPyramid4_Create()

virtual void IRasterPyramid4_Create()

IRasterPyramid4_DeletePyramid()

virtual void IRasterPyramid4_DeletePyramid()

IRasterPyramid4_MinimumSize

virtual IPnt IRasterPyramid4_MinimumSize { get; set; }

Returns

IPnt

IRasterPyramid4_Present

virtual bool IRasterPyramid4_Present { get; }

Returns

bool

IRasterPyramid4_PyramidLevel

virtual int IRasterPyramid4_PyramidLevel { get; }

Returns

int

IRasterPyramid4_PyramidResamplingMethod

virtual rstResamplingTypes IRasterPyramid4_PyramidResamplingMethod { get; }

Returns

rstResamplingTypes

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

ISaveAs_SaveAs(string, IWorkspace, string)

Creates a new persistent Dataset of a given format.

virtual IDataset ISaveAs_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);

 

InterfaceSupportsErrorInfo(ref Guid)

virtual void InterfaceSupportsErrorInfo(ref Guid riid)

Parameters

riid Guid

IsEmpty

Indicates whether the raster dataset is empty.

virtual bool IsEmpty { get; }

Returns

bool

Remarks

An empty raster means that properties of the Raster are not defined. The width, height, and the number of bands of the raster are all 0. It can not be used before populating pixels to it.

Co-create a Raster and IRasterDataset2::CreateRaster create an empty raster.

 

IRasterBandCollection::AppendBands or AppendBand allows you to populate this raster.

 

IsTemporary()

Indicates if the dataset is temporary.

virtual bool IsTemporary()

Returns

bool

Item(int)

Returns a RasterBand given its index.

virtual IRasterBand Item(int BandIndex)

Parameters

BandIndex int

Returns

IRasterBand

LODInfos

The custom LOD infos.

virtual IRasterLODInfos LODInfos { get; }

Returns

IRasterLODInfos

MakePermanent()

Persists this temporary dataset permanent.

virtual void MakePermanent()

MakePermanentAs(string, IWorkspace, string)

Persists this temporary dataset to a new permanent dataset.

virtual IDataset MakePermanentAs(string new_name, IWorkspace Workspace, string Format)

Parameters

new_name string
Workspace IWorkspace
Format string

Returns

IDataset

MaximumPyramidLevel

The maximum available pyramid level.

virtual int MaximumPyramidLevel { get; }

Returns

int

Metadata

The PropertySet containing metadata.

virtual IPropertySet Metadata { get; set; }

Returns

IPropertySet

Remarks

The variable to hold the data must be of IPropertySet data type.

The metadata property is frequently used to save, or update, changes to metadata documents that have taken place through methods available on the IPropertySet, IXmlPropertySet, and/or IXmlPropertySet2 interfaces.

MinimumSize

The minimum raster pyramid size.

virtual IPnt MinimumSize { get; set; }

Returns

IPnt

Mosaic(IRaster, double)

Mosaics a Raster into this RasterDataset.

virtual void Mosaic(IRaster Raster, double tolerance)

Parameters

Raster IRaster
tolerance double

MosaicBands(IRaster, int, double)

Mosaics a Raster into this RasterDataset at a given starting band index.

virtual void MosaicBands(IRaster Raster, int Start, double tolerance)

Parameters

Raster IRaster
Start int
tolerance double

Remarks

This method is supported by RasterDataset instances created from geodatabase and TIFF, Imagine and GRID raster formats.

Name

The name of the Dataset.

virtual string Name { get; }

Returns

string

NativeType

The native type.

virtual INativeType NativeType { get; }

Returns

INativeType

OpenFromFile(string)

Attaches dataset to a particular file.

virtual void OpenFromFile(string Path)

Parameters

Path string

PrecalculateStats(object)

Calculates statistics and histograms for specified bands.

virtual void PrecalculateStats(object index_list)

Parameters

index_list object

Present

Indicates whether pyramid layers exist.

virtual bool Present { get; }

Returns

bool

PropertySet

The set of properties for the dataset.

virtual IPropertySet PropertySet { get; }

Returns

IPropertySet

Remarks

Examples of intrinsic properties for which explicit methods exist include the SpatialReference and the Extent methods available on the IGeoDataset interface. In most cases this PropertySet will be empty.

IDataset::PropertySet is not supported for Graph objects such as a Geometric Network.

PyramidLevel

The pyramid level.

virtual int PyramidLevel { get; }

Returns

int

PyramidResamplingMethod

The pyramid resampling method.

virtual rstResamplingTypes PyramidResamplingMethod { get; }

Returns

rstResamplingTypes

RasterInfo

The raster information.

virtual IRasterInfo RasterInfo { get; }

Returns

IRasterInfo

Read(IPnt, IRaster, IPixelBlock)

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

virtual void Read(IPnt tlc, IRaster Raster, IPixelBlock PixelBlock)

Parameters

tlc IPnt
Raster IRaster
PixelBlock IPixelBlock

ReadBlock(int, int, int, IPixelBlock)

Reads a raw pixel block.

virtual void ReadBlock(int tx, int ty, int Level, IPixelBlock pPixelBlock)

Parameters

tx int
ty int
Level int
pPixelBlock IPixelBlock

ReadPyramid(IPnt, int, IRaster, IPixelBlock)

Reads a block of pixels at a given pyramid level.

virtual void ReadPyramid(IPnt tlc, int PyramidLevel, IRaster Raster, IPixelBlock PixelBlock)

Parameters

tlc IPnt
PyramidLevel int
Raster IRaster
PixelBlock IPixelBlock

Refresh()

Refreshes opened RasterDataset.

virtual void Refresh()

Remove(int)

Removes an element from the collection.

virtual void Remove(int Index)

Parameters

Index int

Remarks

This method is only applicable to work with a Raster, not with a RasterDataset.

Rename(string)

Renames this Dataset.

virtual void Rename(string Name)

Parameters

Name string

Remarks

IDataset::Rename does not support the renaming of Graph objects such as a Geometric Network.  In addition, certain feature classes, such as network feature classes, cannot be renamed.

SaveAs(string, IWorkspace, string)

Creates a new persistent RasterDataset with the bands in the collection.

virtual IDataset SaveAs(string new_name, IWorkspace worksp, string Format)

Parameters

new_name string
worksp IWorkspace
Format string

Returns

IDataset

Remarks

The SaveAs method can create a raster dataset in Imagine, TIFF, GRID, JPEG2000, JPEG, BMP, GIF, PNG, PCI Raster, USGS ASCII DEM, X11 Pixmap, Memory Raster and geodatabase raster.

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"
 

The format string "TIFF" creates a TIFF file with ".tif" extension. ArcGIS also supports TIFF format with ".tiff" and ".tff" extensions. A format string "TIF" creates a  TIFF file with ".tiff" extention and a format string "TFF" creates a TIFF file with ".tff" extension.

 

 

Note, SaveAs will return a RasterDataset, to prevent from SaveAs 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

SensorType

The sensor type used for this RasterDataset.

virtual string SensorType { get; }

Returns

string

SpatialReference

The spatial reference of the GeoDataset.

virtual ISpatialReference 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.

StatMode

The access mode.

virtual esriDatasetFileStatAccessMode StatMode { get; }

Returns

esriDatasetFileStatAccessMode

StatSize

Obsolete. Use StatSize64.

virtual int StatSize { get; }

Returns

int

StatTime[esriDatasetFileStatTimeMode]

Obsolete. Use StatTime64.

virtual int StatTime[esriDatasetFileStatTimeMode dateMode] { get; }

Parameters

dateMode esriDatasetFileStatTimeMode

Returns

int

Subdataset

The current active subdataset.

virtual int Subdataset { get; set; }

Returns

int

Remarks

This property is used to get/set the index of a subdataset which becomes the current raster dataset

SubdatasetCount

The number of subdatasets.

virtual int SubdatasetCount { get; }

Returns

int

SubdatasetDescription[int]

The given subdataset description.

virtual string SubdatasetDescription[int SubdatasetID] { get; }

Parameters

SubdatasetID int

Returns

string

SubdatasetName[int]

The given subdataset name.

virtual string SubdatasetName[int SubdatasetID] { get; }

Parameters

SubdatasetID int

Returns

string

Remarks

The subdataset name has the following form: HDF4_SDS:subdataset_type:file_name:subdataset_index

where subdataset_type shows predefined names for some of the well known HDF datasets, file_name is the name of the input file, and subdataset_index is the index of the image to use.

Subsets

Datasets contained within this dataset.

virtual IEnumDataset Subsets { get; }

Returns

IEnumDataset

Remarks

IDataset::Subsets is not supported for Graph objects such as a Geometric Network.  To return the feature classes contained in a Geometric Network, use the IFeatureClassContainer interface.

Synchronize(esriMetadataSyncAction, int)

Updates metadata with the current properties; may create metadata if it doesn't already exist.

virtual void Synchronize(esriMetadataSyncAction action, int interval)

Parameters

action esriMetadataSyncAction
interval int

Remarks

The following actions will result in synchronization given each of the listed conditions:

Action Metadata status Esri/Sync element Interval parameter
esriMSAAccessed Doesn't matter Must not be FALSE Must be less than actual interval
esriMSAAlways Doesn't matter Doesn't matter Doesn't matter
esriMSACreated Must not exist Must not be FALSE Must be less than actual interval
esriMSANotCreated Must exist Must not be FALSE Must be less than actual interval
esriMSAOverwrite Doesn't matter Doesn't matter Doesn't matter

The difference between esriMSAAlways and esriMSAOverwrite lies in which elements are synchronized. esriMSAAlways will honor the removal or value change of an element's Sync attribute (to disable synchronization), whereas using esriMSAOverwrite is equivalent to setting the IXmlPropertySet2.OverwriteSyncAttribute to true for the metadata's property set, meaning that even elements without a Sync attribute of TRUE will be synchronized.

Type

The type of the Dataset.

virtual esriDatasetType Type { get; }

Returns

esriDatasetType

Remarks

The Type property returns the an esriDatasetType value indicating the dataset type, such as esriDTTable or esriDTFeatureClass.

Workspace

The workspace containing this dataset.

virtual IWorkspace Workspace { get; }

Returns

IWorkspace

Remarks

<p>A Workspace is a container of spatial and non-spatial datasets such as feature classes, raster datasets, and tables. It provides methods to instantiate existing datasets and to create new datasets. Workspaces are classified into types specified by the <b><a href="esriWorkspaceType.htm">esriWorkspaceType</a></b> enumerator: FileSystemWorkspace, LocalDatabaseWorkspace, and RemoteDatabaseWorkspace. Shapefiles and ArcGIS for Desktop Advanced workspaces are examples of FileSystemWorkspace. A personal geodatabase stored in an Access or a File Geodatabase is an example of a LocalDatabaseWorkspace. A geodatabase stored in an RDBMS such as Oracle, DB2, SQL Server, or Informix and accessed via ArcSDE is an example of a RemoteDatabaseWorkspace.</p> <p>A Workspace hands out a <b><a href="WorkspaceName.htm">WorkspaceName</a> </b>object as the value of its FullName property. For example, the WorkspaceName for a workspace can be persisted in a map document. An application can call the <b>Open()</b> method on the workspace name after loading it from persistent storage to connect to and get an object reference to the workspace.</p>

Write()

Creates a World File.

virtual void Write()

Remarks

For GRID format or datasets that get their georeference information from a world file, IWorldFileExport:Write method has no effect.

Write(IPnt, IRaster, esriRasterWriteMode, IPixelBlock)

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

virtual void Write(IPnt tlc, IRaster Raster, esriRasterWriteMode mode, IPixelBlock PixelBlock)

Parameters

tlc IPnt
Raster IRaster
mode esriRasterWriteMode
PixelBlock IPixelBlock

WriteBinaryAuxFile()

Create a binary AUX file containing georeferencing and spatial reference.

virtual void WriteBinaryAuxFile()

WriteBlock(int, int, int, IPixelBlock)

Writes a raw pixel block.

virtual void WriteBlock(int tx, int ty, int Level, IPixelBlock pPixelBlock)

Parameters

tx int
ty int
Level int
pPixelBlock IPixelBlock