Class PansharpeningFilterClass

Namespace
ESRI.ArcGIS.DatasourcesRaster
Assembly
ESRI.Server.DatasourcesRaster.dll
[Guid("B58B1271-E6FB-4B27-8417-2B8D62D654B0")]
[ClassInterface(ClassInterfaceType.None)]
public class PansharpeningFilterClass : PansharpeningFilter, IPixelFilter, IPixelFilter2, IPixelFilter3, IPansharpeningFilter2, IPansharpeningFilter, IPersistStream, IPersist, IDocumentVersionSupportGEN, IXMLVersionSupport
Inheritance
PansharpeningFilterClass
Implements
Inherited Members

Constructors

PansharpeningFilterClass()

public PansharpeningFilterClass()

Explicit Interface Implementations

ConvertToSupportedObject(esriArcGISVersion)

Convert the object to another object that is supported.

virtual object ConvertToSupportedObject(esriArcGISVersion docVersion)

Parameters

docVersion esriArcGISVersion

Returns

object

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE.  Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version.  Not all objects will return a supported object; in these cases a null pointer will be returned.

Filter(IPixelBlock)

Filters a pixel block.

virtual void Filter(IPixelBlock pBlock)

Parameters

pBlock IPixelBlock

GetCenterPosition(ref int, ref int)

Gets center position of the filter.

virtual void GetCenterPosition(ref int atColumn, ref int atRow)

Parameters

atColumn int
atRow int

GetClassID(out Guid)

virtual void GetClassID(out Guid pClassID)

Parameters

pClassID Guid

GetSize(ref int, ref int)

Gets dimension of the filter.

virtual void GetSize(ref int Columns, ref int Rows)

Parameters

Columns int
Rows int

GetSizeMax(out _ULARGE_INTEGER)

virtual void GetSizeMax(out _ULARGE_INTEGER pcbSize)

Parameters

pcbSize _ULARGE_INTEGER

IPansharpeningFilter2_InfraredImage

virtual IRaster IPansharpeningFilter2_InfraredImage { get; set; }

Returns

IRaster

IPansharpeningFilter2_PanImage

virtual IRaster IPansharpeningFilter2_PanImage { get; set; }

Returns

IRaster

IPansharpeningFilter2_PansharpeningType

virtual esriPansharpeningType IPansharpeningFilter2_PansharpeningType { get; set; }

Returns

esriPansharpeningType

IPansharpeningFilter2_PutWeights(double, double, double, double)

virtual void IPansharpeningFilter2_PutWeights(double RW, double GW, double BW, double IW)

Parameters

RW double
GW double
BW double
IW double

IPansharpeningFilter2_QueryWeights(out double, out double, out double, out double)

virtual void IPansharpeningFilter2_QueryWeights(out double pRW, out double pGW, out double pBW, out double pIW)

Parameters

pRW double
pGW double
pBW double
pIW double

InfraredImage

The optional infrared image.

virtual IRaster InfraredImage { get; set; }

Returns

IRaster

Remarks

It is optional. If not set, Infrared band will not be used in the pan sharpening operation.

Init(int, int, IEnvelope)

Initializes this filter for a given area of interest.

virtual void Init(int nCols, int nRows, IEnvelope pExtent)

Parameters

nCols int
nRows int
pExtent IEnvelope

InitBlock(IPnt, int, int)

Initialize this filter for a given pixel block.

virtual void InitBlock(IPnt pTopLeft, int nBlkCols, int nBlkRows)

Parameters

pTopLeft IPnt
nBlkCols int
nBlkRows int

IsDirty()

virtual void IsDirty()

IsSupportedAtVersion(esriArcGISVersion)

Is this object valid at the given document version.

virtual bool IsSupportedAtVersion(esriArcGISVersion docVersion)

Parameters

docVersion esriArcGISVersion

Returns

bool

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream.  This result is based on the esriArcGISVersion enumeration.  In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Load(IStream)

virtual void Load(IStream pstm)

Parameters

pstm IStream

MaximumPansharpeningCellsize

The maximum cellsize, in Pan image's SR, below which pansharpening will be applied.

virtual double MaximumPansharpeningCellsize { get; set; }

Returns

double

MinNamespaceSupported

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

virtual string MinNamespaceSupported { get; }

Returns

string

PanImage

The panchromatic image.

virtual IRaster PanImage { get; set; }

Returns

IRaster

PansharpeningType

The current pansharpening type.

virtual esriPansharpeningType PansharpeningType { get; set; }

Returns

esriPansharpeningType

PutWeights(double, double, double, double)

Puts the Red, Green, Blue, and Infrared weights contributing to panchromatic image.

virtual void PutWeights(double RW, double GW, double BW, double IW)

Parameters

RW double
GW double
BW double
IW double

QueryWeights(out double, out double, out double, out double)

Gets the Red, Green, Blue, and Infrared weights contributing to panchromatic image.

virtual void QueryWeights(out double pRW, out double pGW, out double pBW, out double pIW)

Parameters

pRW double
pGW double
pBW double
pIW double

Save(IStream, int)

virtual void Save(IStream pstm, int fClearDirty)

Parameters

pstm IStream
fClearDirty int

Sharpen(double, ref double, ref double, ref double, ref double)

Applies pansharpening to a pixel (R, G, B, I).

virtual void Sharpen(double P, ref double R, ref double G, ref double b, ref double I)

Parameters

P double
R double
G double
b double
I double

Synchronize(IRaster)

Synchronizes this filter when raster properties are changed.

virtual void Synchronize(IRaster pRaster)

Parameters

pRaster IRaster