Class DefineOverviewsParametersClass

Namespace
ESRI.ArcGIS.DatasourcesRaster
Assembly
ESRI.Server.DatasourcesRaster.dll
[Guid("3C8017CE-5091-4B09-BA2E-62F15454589A")]
[ClassInterface(ClassInterfaceType.None)]
public class DefineOverviewsParametersClass : DefineOverviewsParameters, IMosaicDatasetOperationParameters, IDefineOverviewsParameters, IOverviewTileParameters2, IOverviewTileParameters, IOverviewImageParameters, ISelectionParameters, IBuildBoundaryParameters, ICalculateCellSizeRangesParameters, IThreadedOperationParameters
Inheritance
DefineOverviewsParametersClass
Implements
Inherited Members

Constructors

DefineOverviewsParametersClass()

public DefineOverviewsParametersClass()

Explicit Interface Implementations

AoiGeometry

The polygon within which overview tiles are created.

virtual IGeometry AoiGeometry { get; set; }

Returns

IGeometry

AppendToExistingBoundary

Indicates whether the computed boundary geometry is merged with existing mosaic boundary.

virtual bool AppendToExistingBoundary { get; set; }

Returns

bool

BaseCellSize

The cell size of the first level of overview tiles. If this property is not specified, the value in IOverviewTileParameters.CellSize is used.

virtual IPoint BaseCellSize { get; set; }

Returns

IPoint

BufferDistanceFactor

The buffer factor applied on each item footprint before it is merged with the cumulative boundary geometry.

virtual double BufferDistanceFactor { get; set; }

Returns

double

CalculateLevels

Indicates whether all unique cell size levels for the mosaic dataset are computed and stored.

virtual bool CalculateLevels { get; set; }

Returns

bool

CalculateMosaicCellSizes

Indicates whether mosaic dataset's maximum visible cell size is calculated.

virtual bool CalculateMosaicCellSizes { get; set; }

Returns

bool

CalculateRasterMaxCellSizes

Indicates whether maximum visibility values are calculated for selected items.

virtual bool CalculateRasterMaxCellSizes { get; set; }

Returns

bool

CalculateRasterMinCellSizes

Indicates whether minimum visibility values are calculated for selected items.

virtual bool CalculateRasterMinCellSizes { get; set; }

Returns

bool

CellSize

The cell size of the first level of overview tiles in the units of the coordinate system of the catalog. If this property is not specified, the default value is computed automatically.

virtual double CellSize { get; set; }

Returns

double

CellSizeClusterTolerance

The factor controlling clustering of cell size values. Two cell size values with a difference factor less than the value in this property are considered one.

virtual double CellSizeClusterTolerance { get; set; }

Returns

double

ForceOverviewTiles

Indicates whether overview tiles are generated irrespective of existing primary or overview items in the specified area.

virtual bool ForceOverviewTiles { get; set; }

Returns

bool

IOverviewTileParameters2_AoiGeometry

virtual IGeometry IOverviewTileParameters2_AoiGeometry { get; set; }

Returns

IGeometry

IOverviewTileParameters2_CellSize

virtual double IOverviewTileParameters2_CellSize { get; set; }

Returns

double

IOverviewTileParameters2_Levels

virtual int IOverviewTileParameters2_Levels { get; set; }

Returns

int

IOverviewTileParameters2_MaximumSizeOfTopmostOverview

virtual int IOverviewTileParameters2_MaximumSizeOfTopmostOverview { get; set; }

Returns

int

IOverviewTileParameters2_Origin

virtual IPoint IOverviewTileParameters2_Origin { get; set; }

Returns

IPoint

IOverviewTileParameters2_OverviewFactor

virtual int IOverviewTileParameters2_OverviewFactor { get; set; }

Returns

int

IOverviewTileParameters2_TileCols

virtual int IOverviewTileParameters2_TileCols { get; set; }

Returns

int

IOverviewTileParameters2_TileRows

virtual int IOverviewTileParameters2_TileRows { get; set; }

Returns

int

IOverviewTileParameters2_WorkspaceName

virtual IWorkspaceName IOverviewTileParameters2_WorkspaceName { get; set; }

Returns

IWorkspaceName

InstanceID

The object ID of the raster type instance associated with a preview define overview operation. Properties that control how overview tiles are created are read from the matching raster type instance. A value here also indicates that no new schema is created by

virtual int InstanceID { get; set; }

Returns

int

IsDatasetReadOnly

Indicates whether the mosaic dataset is in read-only mode. Mosaic dataset operations do not perform write operations on a read-only mosaic.

virtual bool IsDatasetReadOnly { get; set; }

Returns

bool

Levels

The number of levels of overview tiles created.

virtual int Levels { get; set; }

Returns

int

MaxOverviewFactor

The multiplicative factor used for computing the maximum visibility of the top-most (lowest resolution) overview items.

virtual double MaxOverviewFactor { get; set; }

Returns

double

MaxRangeFactor

The multiplicative factor used for computing maximum visibility of those items that don't their footprints completely covered by footprints of lower resolution items. The maximum pixel size values of such items are computed by multiplying the corresponding low

virtual double MaxRangeFactor { get; set; }

Returns

double

MaximumSizeOfTopmostOverview

The recommended maximum size (in pixels) on any dimension for the lowest resolution overview item. A higher value for this property results in fewer levels of overviews. The operation continues to define a new level as long as the number of pixels of the overv

virtual int MaximumSizeOfTopmostOverview { get; set; }

Returns

int

NumThreads

The number of parallel threads that execute parts of the associated operation.

virtual int NumThreads { get; set; }

Returns

int

Origin

The origin of the grid containing overview tiles.

virtual IPoint Origin { get; set; }

Returns

IPoint

OverviewFactor

The factor by which two neighboring overview levels differ.

virtual int OverviewFactor { get; set; }

Returns

int

Parameters

All parameters associated with the mosaic dataset operation.

virtual IPropertySet Parameters { get; set; }

Returns

IPropertySet

PerformWeeding

Indicates whether the computed boundary geometry is run through a point-weeding routine.

virtual bool PerformWeeding { get; set; }

Returns

bool

Progressor

The external progressor object associated with the mosaic dataset operation.

virtual IProgressor Progressor { get; set; }

Returns

IProgressor

QueryFilter

The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation. If no selection is specified, the query filter is applied on the entire catalog.

virtual IQueryFilter QueryFilter { get; set; }

Returns

IQueryFilter

RecommendedNumThreads(ref int)

The number of parallel threads of execution recommended by the system.

virtual void RecommendedNumThreads(ref int pRecommendedNumThreads)

Parameters

pRecommendedNumThreads int

RefreshAllInstances

Indicates whether all existing overview instances are refreshed. A TRUE value also indicates that no new schema of overview tiles is created by the IMosaicDatasetOperation.DefineOverviews method.

virtual bool RefreshAllInstances { get; set; }

Returns

bool

RemoveSlivers

Indicates whether polygons designated as slivers are removed from the boundary geometry.

virtual bool RemoveSlivers { get; set; }

Returns

bool

ResamplingMethod

The sampling method used on the mosaic dataset while generating the overview raster dataset.

virtual rstResamplingTypes ResamplingMethod { get; set; }

Returns

rstResamplingTypes

Results

The properties of the result associated with the mosaic dataset operation.

virtual IPropertySet Results { get; set; }

Returns

IPropertySet

SelectionSet

The selection set that identifies the collection of catalog items on which to perform the associated operation.

virtual ISelectionSet SelectionSet { get; set; }

Returns

ISelectionSet

ServerName

The URL to the server object name where parts of the operation may be remotely executed.

virtual string ServerName { get; set; }

Returns

string

StorageDef

The raster storage definition.

virtual IRasterStorageDef StorageDef { get; set; }

Returns

IRasterStorageDef

TileCols

The recommended number of pixel columns in each overview tiles.

virtual int TileCols { get; set; }

Returns

int

TileRows

The recommended number of pixel rows in each overview tiles.

virtual int TileRows { get; set; }

Returns

int

UpdateBoundary

Indicates whether the mosaic dataset is updated with the computed boundary geometry.

virtual bool UpdateBoundary { get; set; }

Returns

bool

UpdateMissingValuesOnly

Indicates whether only those rows where MinPS or MaxPS is either null or -1 are updated.

virtual bool UpdateMissingValuesOnly { get; set; }

Returns

bool

WeedTolerance

The tolerance for weeding points.

virtual double WeedTolerance { get; set; }

Returns

double

WorkspaceName

The workspace name where overview raster datasets are generated and stored.

virtual IWorkspaceName WorkspaceName { get; set; }

Returns

IWorkspaceName