Class MosaicFunctionClass

Namespace
ESRI.ArcGIS.DatasourcesRaster
Assembly
ESRI.Server.DatasourcesRaster.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("7406B10E-6009-4366-85FF-5A067B54B2AD")]
public class MosaicFunctionClass : MosaicFunction, IRasterFunction, IMosaicFunction3, IMosaicFunction2, IMosaicFunction, IPersistStream, IPersist, IXMLSerialize, IXMLVersionSupport
Inheritance
MosaicFunctionClass
Implements
Inherited Members

Constructors

MosaicFunctionClass()

public MosaicFunctionClass()

Explicit Interface Implementations

ApplyColorCorrection

Indicates if color correction needs to be applied.

virtual bool ApplyColorCorrection { get; set; }

Returns

bool

Ascending

Indicates whether the ascending flag of OrderBy.

virtual bool Ascending { get; set; }

Returns

bool

BackgroundRaster

The background raster.

virtual IRaster BackgroundRaster { get; set; }

Returns

IRaster

Bind(object)

Binds function arguments to this raster function.

virtual void Bind(object pArguments)

Parameters

pArguments object

BlendingWidth

The blending width for Blend mosaic operator.

virtual int BlendingWidth { get; set; }

Returns

int

BlendingWidth2

The blending width for Blend mosaic operator.

virtual double BlendingWidth2 { get; set; }

Returns

double

BlendingWidthUnits

The units associated with the blending width for Blend mosaic operator.

virtual esriBlendWidthUnits BlendingWidthUnits { get; set; }

Returns

esriBlendWidthUnits

Catalog

The catalog.

virtual ITable Catalog { get; }

Returns

ITable

CellsizeFieldName

The native raster cellsize field name.

virtual string CellsizeFieldName { get; set; }

Returns

string

ClipToBoundary

Indicates if the mosaic dataset will be clipped to its boundary.

virtual bool ClipToBoundary { get; set; }

Returns

bool

ClipToFootprint

Indicates if individual images will be clipped to their footprints.

virtual bool ClipToFootprint { get; set; }

Returns

bool

ConstructQueryExpression(IPoint)

Constructs a query expression (WHERE clause).

virtual string ConstructQueryExpression(IPoint pCellsize)

Parameters

pCellsize IPoint

Returns

string

DefinitionExpression

The definition expression on the source catalog.

virtual string DefinitionExpression { get; set; }

Returns

string

DefinitionFIDs

The definition selection set on the source catalog.

virtual IFIDSet DefinitionFIDs { get; set; }

Returns

IFIDSet

DefinitionGeometry

The definition (spatial selection) geometry on the source catalog.

virtual IGeometry DefinitionGeometry { get; set; }

Returns

IGeometry

Description

The raster function description.

virtual string Description { get; set; }

Returns

string

Deserialize(IXMLSerializeData)

Deserializes an object from XML.

virtual void Deserialize(IXMLSerializeData data)

Parameters

data IXMLSerializeData

DrawFootprint

Indicates if to draw footprints.

virtual bool DrawFootprint { get; set; }

Returns

bool

FIDs

The current selection set on the source catalog.

virtual IFIDSet FIDs { get; set; }

Returns

IFIDSet

FootprintMayContainNoData

Indicates whether the footprint geometry associated with each raster may contain NoData pixels. Setting this property to false while clipping to fooptrint enables the system to assume that only valid pixels exist within a raster's footprint towards optimizing

virtual bool FootprintMayContainNoData { get; set; }

Returns

bool

FootprintSymbol

The symbol used to draw footprints.

virtual object FootprintSymbol { get; set; }

Returns

object

GetClassID(out Guid)

virtual void GetClassID(out Guid pClassID)

Parameters

pClassID Guid

GetSizeMax(out _ULARGE_INTEGER)

virtual void GetSizeMax(out _ULARGE_INTEGER pcbSize)

Parameters

pcbSize _ULARGE_INTEGER

IMosaicFunction2_ApplyColorCorrection

virtual bool IMosaicFunction2_ApplyColorCorrection { get; set; }

Returns

bool

IMosaicFunction2_Ascending

virtual bool IMosaicFunction2_Ascending { get; set; }

Returns

bool

IMosaicFunction2_Catalog

virtual ITable IMosaicFunction2_Catalog { get; }

Returns

ITable

IMosaicFunction2_CellsizeFieldName

virtual string IMosaicFunction2_CellsizeFieldName { get; set; }

Returns

string

IMosaicFunction2_ClipToFootprint

virtual bool IMosaicFunction2_ClipToFootprint { get; set; }

Returns

bool

IMosaicFunction2_ConstructQueryExpression(IPoint)

virtual string IMosaicFunction2_ConstructQueryExpression(IPoint pCellsize)

Parameters

pCellsize IPoint

Returns

string

IMosaicFunction2_DefinitionExpression

virtual string IMosaicFunction2_DefinitionExpression { get; set; }

Returns

string

IMosaicFunction2_DefinitionFIDs

virtual IFIDSet IMosaicFunction2_DefinitionFIDs { get; set; }

Returns

IFIDSet

IMosaicFunction2_DefinitionGeometry

virtual IGeometry IMosaicFunction2_DefinitionGeometry { get; set; }

Returns

IGeometry

IMosaicFunction2_DrawFootprint

virtual bool IMosaicFunction2_DrawFootprint { get; set; }

Returns

bool

IMosaicFunction2_FIDs

virtual IFIDSet IMosaicFunction2_FIDs { get; set; }

Returns

IFIDSet

IMosaicFunction2_FootprintSymbol

virtual object IMosaicFunction2_FootprintSymbol { get; set; }

Returns

object

IMosaicFunction2_IsVisible(double, double)

virtual bool IMosaicFunction2_IsVisible(double Dx, double Dy)

Parameters

Dx double
Dy double

Returns

bool

IMosaicFunction2_LODFieldName

virtual string IMosaicFunction2_LODFieldName { get; set; }

Returns

string

IMosaicFunction2_LODInfos

virtual IMosaicLODInfos IMosaicFunction2_LODInfos { get; set; }

Returns

IMosaicLODInfos

IMosaicFunction2_LockCellsize(double)

virtual void IMosaicFunction2_LockCellsize(double CellSize)

Parameters

CellSize double

IMosaicFunction2_LockRasterFieldName

virtual string IMosaicFunction2_LockRasterFieldName { get; set; }

Returns

string

IMosaicFunction2_LockRasterID

virtual string IMosaicFunction2_LockRasterID { get; set; }

Returns

string

IMosaicFunction2_MaxCellsizeFieldIndex

virtual int IMosaicFunction2_MaxCellsizeFieldIndex { get; }

Returns

int

IMosaicFunction2_MaxCellsizeFieldName

virtual string IMosaicFunction2_MaxCellsizeFieldName { get; set; }

Returns

string

IMosaicFunction2_MaxMosaicImageCount

virtual int IMosaicFunction2_MaxMosaicImageCount { get; set; }

Returns

int

IMosaicFunction2_MaximumVisibleCellsize

virtual IPnt IMosaicFunction2_MaximumVisibleCellsize { get; set; }

Returns

IPnt

IMosaicFunction2_MinCellsizeFieldIndex

virtual int IMosaicFunction2_MinCellsizeFieldIndex { get; }

Returns

int

IMosaicFunction2_MinCellsizeFieldName

virtual string IMosaicFunction2_MinCellsizeFieldName { get; set; }

Returns

string

IMosaicFunction2_MosaicMethod

virtual esriMosaicMethod IMosaicFunction2_MosaicMethod { get; set; }

Returns

esriMosaicMethod

IMosaicFunction2_MosaicOperator

virtual IMosaicOperator IMosaicFunction2_MosaicOperator { get; set; }

Returns

IMosaicOperator

IMosaicFunction2_MosaicOperatorType

virtual rstMosaicOperatorType IMosaicFunction2_MosaicOperatorType { get; set; }

Returns

rstMosaicOperatorType

IMosaicFunction2_OrderByBaseValue

virtual object IMosaicFunction2_OrderByBaseValue { get; set; }

Returns

object

IMosaicFunction2_OrderByFieldName

virtual string IMosaicFunction2_OrderByFieldName { get; set; }

Returns

string

IMosaicFunction2_RasterFieldIndex

virtual int IMosaicFunction2_RasterFieldIndex { get; }

Returns

int

IMosaicFunction2_RasterFieldName

virtual string IMosaicFunction2_RasterFieldName { get; set; }

Returns

string

IMosaicFunction2_Search(IQueryFilter, IPoint)

virtual ICursor IMosaicFunction2_Search(IQueryFilter pQueryFilter, IPoint pCellsize)

Parameters

pQueryFilter IQueryFilter
pCellsize IPoint

Returns

ICursor

IMosaicFunction2_UnlockCellsize()

virtual void IMosaicFunction2_UnlockCellsize()

IMosaicFunction2_Viewpoint

virtual IPoint IMosaicFunction2_Viewpoint { get; set; }

Returns

IPoint

IMosaicFunction2_WhereClause

virtual string IMosaicFunction2_WhereClause { get; set; }

Returns

string

IMosaicFunction3_ApplyColorCorrection

virtual bool IMosaicFunction3_ApplyColorCorrection { get; set; }

Returns

bool

IMosaicFunction3_Ascending

virtual bool IMosaicFunction3_Ascending { get; set; }

Returns

bool

IMosaicFunction3_BackgroundRaster

virtual IRaster IMosaicFunction3_BackgroundRaster { get; set; }

Returns

IRaster

IMosaicFunction3_BlendingWidth

virtual int IMosaicFunction3_BlendingWidth { get; set; }

Returns

int

IMosaicFunction3_Catalog

virtual ITable IMosaicFunction3_Catalog { get; }

Returns

ITable

IMosaicFunction3_CellsizeFieldName

virtual string IMosaicFunction3_CellsizeFieldName { get; set; }

Returns

string

IMosaicFunction3_ClipToBoundary

virtual bool IMosaicFunction3_ClipToBoundary { get; set; }

Returns

bool

IMosaicFunction3_ClipToFootprint

virtual bool IMosaicFunction3_ClipToFootprint { get; set; }

Returns

bool

IMosaicFunction3_ConstructQueryExpression(IPoint)

virtual string IMosaicFunction3_ConstructQueryExpression(IPoint pCellsize)

Parameters

pCellsize IPoint

Returns

string

IMosaicFunction3_DefinitionExpression

virtual string IMosaicFunction3_DefinitionExpression { get; set; }

Returns

string

IMosaicFunction3_DefinitionFIDs

virtual IFIDSet IMosaicFunction3_DefinitionFIDs { get; set; }

Returns

IFIDSet

IMosaicFunction3_DefinitionGeometry

virtual IGeometry IMosaicFunction3_DefinitionGeometry { get; set; }

Returns

IGeometry

IMosaicFunction3_DrawFootprint

virtual bool IMosaicFunction3_DrawFootprint { get; set; }

Returns

bool

IMosaicFunction3_FIDs

virtual IFIDSet IMosaicFunction3_FIDs { get; set; }

Returns

IFIDSet

IMosaicFunction3_FootprintMayContainNoData

virtual bool IMosaicFunction3_FootprintMayContainNoData { get; set; }

Returns

bool

IMosaicFunction3_FootprintSymbol

virtual object IMosaicFunction3_FootprintSymbol { get; set; }

Returns

object

IMosaicFunction3_IsVisible(double, double)

virtual bool IMosaicFunction3_IsVisible(double Dx, double Dy)

Parameters

Dx double
Dy double

Returns

bool

IMosaicFunction3_LODFieldName

virtual string IMosaicFunction3_LODFieldName { get; set; }

Returns

string

IMosaicFunction3_LODInfos

virtual IMosaicLODInfos IMosaicFunction3_LODInfos { get; set; }

Returns

IMosaicLODInfos

IMosaicFunction3_LockCellsize(double)

virtual void IMosaicFunction3_LockCellsize(double CellSize)

Parameters

CellSize double

IMosaicFunction3_LockRasterFieldName

virtual string IMosaicFunction3_LockRasterFieldName { get; set; }

Returns

string

IMosaicFunction3_LockRasterID

virtual string IMosaicFunction3_LockRasterID { get; set; }

Returns

string

IMosaicFunction3_MaxCellsizeFieldIndex

virtual int IMosaicFunction3_MaxCellsizeFieldIndex { get; }

Returns

int

IMosaicFunction3_MaxCellsizeFieldName

virtual string IMosaicFunction3_MaxCellsizeFieldName { get; set; }

Returns

string

IMosaicFunction3_MaxMosaicImageCount

virtual int IMosaicFunction3_MaxMosaicImageCount { get; set; }

Returns

int

IMosaicFunction3_MaximumVisibleCellsize

virtual IPnt IMosaicFunction3_MaximumVisibleCellsize { get; set; }

Returns

IPnt

IMosaicFunction3_MinCellsizeFieldIndex

virtual int IMosaicFunction3_MinCellsizeFieldIndex { get; }

Returns

int

IMosaicFunction3_MinCellsizeFieldName

virtual string IMosaicFunction3_MinCellsizeFieldName { get; set; }

Returns

string

IMosaicFunction3_MosaicMethod

virtual esriMosaicMethod IMosaicFunction3_MosaicMethod { get; set; }

Returns

esriMosaicMethod

IMosaicFunction3_MosaicOperator

virtual IMosaicOperator IMosaicFunction3_MosaicOperator { get; set; }

Returns

IMosaicOperator

IMosaicFunction3_MosaicOperatorType

virtual rstMosaicOperatorType IMosaicFunction3_MosaicOperatorType { get; set; }

Returns

rstMosaicOperatorType

IMosaicFunction3_OrderByBaseValue

virtual object IMosaicFunction3_OrderByBaseValue { get; set; }

Returns

object

IMosaicFunction3_OrderByFieldName

virtual string IMosaicFunction3_OrderByFieldName { get; set; }

Returns

string

IMosaicFunction3_RasterFieldIndex

virtual int IMosaicFunction3_RasterFieldIndex { get; }

Returns

int

IMosaicFunction3_RasterFieldName

virtual string IMosaicFunction3_RasterFieldName { get; set; }

Returns

string

IMosaicFunction3_Search(IQueryFilter, IPoint)

virtual ICursor IMosaicFunction3_Search(IQueryFilter pQueryFilter, IPoint pCellsize)

Parameters

pQueryFilter IQueryFilter
pCellsize IPoint

Returns

ICursor

IMosaicFunction3_UnlockCellsize()

virtual void IMosaicFunction3_UnlockCellsize()

IMosaicFunction3_Viewpoint

virtual IPoint IMosaicFunction3_Viewpoint { get; set; }

Returns

IPoint

IMosaicFunction3_WhereClause

virtual string IMosaicFunction3_WhereClause { get; set; }

Returns

string

IPersistStream_GetClassID(out Guid)

virtual void IPersistStream_GetClassID(out Guid pClassID)

Parameters

pClassID Guid

IsDirty()

virtual void IsDirty()

IsVisible(double, double)

Checks if a given pixel size is visible.

virtual bool IsVisible(double Dx, double Dy)

Parameters

Dx double
Dy double

Returns

bool

LODFieldName

The LOD field name.

virtual string LODFieldName { get; set; }

Returns

string

LODInfos

The current mosaic LOD information.

virtual IMosaicLODInfos LODInfos { get; set; }

Returns

IMosaicLODInfos

Load(IStream)

virtual void Load(IStream pstm)

Parameters

pstm IStream

LockCellsize(double)

Locks LOD at a given cellsize.

virtual void LockCellsize(double CellSize)

Parameters

CellSize double

LockRasterFieldName

The lock raster ID field name in the source catalog.

virtual string LockRasterFieldName { get; set; }

Returns

string

LockRasterID

The lock raster ID.

virtual string LockRasterID { get; set; }

Returns

string

MaxCellsizeFieldIndex

The maximum cellsize field index.

virtual int MaxCellsizeFieldIndex { get; }

Returns

int

MaxCellsizeFieldName

The maximum cellsize field name.

virtual string MaxCellsizeFieldName { get; set; }

Returns

string

MaxMosaicImageCount

The maximum number of rasters used per request.

virtual int MaxMosaicImageCount { get; set; }

Returns

int

MaximumVisibleCellsize

The maximum visible cellsize.

virtual IPnt MaximumVisibleCellsize { get; set; }

Returns

IPnt

MinCellsizeFieldIndex

The minimum cellsize field index.

virtual int MinCellsizeFieldIndex { get; }

Returns

int

MinCellsizeFieldName

The minimum cellsize field name.

virtual string MinCellsizeFieldName { get; set; }

Returns

string

MinNamespaceSupported

The minimum namespace the class can serialize to (eg the 90 namespace).

virtual string MinNamespaceSupported { get; }

Returns

string

MosaicMethod

The mosaic method.

virtual esriMosaicMethod MosaicMethod { get; set; }

Returns

esriMosaicMethod

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

Name

The raster function name.

virtual string Name { get; set; }

Returns

string

OrderByBaseValue

The Order By base value.

virtual object OrderByBaseValue { get; set; }

Returns

object

OrderByFieldName

The Order By field on the source catalog.

virtual string OrderByFieldName { get; set; }

Returns

string

PixelType

The output pixel type.

virtual rstPixelType PixelType { get; set; }

Returns

rstPixelType

RasterFieldIndex

The raster field index.

virtual int RasterFieldIndex { get; }

Returns

int

RasterFieldName

The raster field name in the source catalog.

virtual string RasterFieldName { get; set; }

Returns

string

RasterInfo

The raster information after this function is applied to an object.

virtual IRasterInfo RasterInfo { get; }

Returns

IRasterInfo

Read(IPnt, IRaster, IPixelBlock)

Reads a pixel block starting from the top left corner.

virtual void Read(IPnt pTlc, IRaster pRaster, IPixelBlock pPixelBlock)

Parameters

pTlc IPnt
pRaster IRaster
pPixelBlock IPixelBlock

Save(IStream, int)

virtual void Save(IStream pstm, int fClearDirty)

Parameters

pstm IStream
fClearDirty int

Search(IQueryFilter, IPoint)

Searches the catalog using current mosaic rules.

virtual ICursor Search(IQueryFilter pQueryFilter, IPoint pCellsize)

Parameters

pQueryFilter IQueryFilter
pCellsize IPoint

Returns

ICursor

Serialize(IXMLSerializeData)

Serializes an object to XML.

virtual void Serialize(IXMLSerializeData data)

Parameters

data IXMLSerializeData

UnlockCellsize()

Unlocks LOD from the locked cellsize.

virtual void UnlockCellsize()

Update()

Updates using newly available information from bound object.

virtual void Update()

Valid

Indicates if this function is valid, e.g. bound to an object, and etc.

virtual bool Valid { get; }

Returns

bool

Viewpoint

The view point.

virtual IPoint Viewpoint { get; set; }

Returns

IPoint

WhereClause

The SQL selection where clause expression.

virtual string WhereClause { get; set; }

Returns

string