com.esri.arcgis.datasourcesraster
Class SegmentMeanShiftFunctionArguments

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.SegmentMeanShiftFunctionArguments
All Implemented Interfaces:
IRasterFunctionArguments, IRasterFunctionArguments2, ISegmentMeanShiftFunctionArguments, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class SegmentMeanShiftFunctionArguments
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterFunctionArguments2, ISegmentMeanShiftFunctionArguments, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable

COM Class 'SegmentMeanShiftFunctionArguments'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterFunctionArguments2
IID, IIDfd4f0d2d_1f81_4b2d_8ae5_90cef59c3cfe, xxDummy
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterFunctionArguments
IID04aa081e_28b0_47e4_b375_f367046da924
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.ISegmentMeanShiftFunctionArguments
IID, IID4e91d1ed_e61c_4bf9_aad9_0352a8fea4bd, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Fields inherited from interface com.esri.arcgis.system.IXMLSerialize
IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport
IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy
 
Constructor Summary
SegmentMeanShiftFunctionArguments()
          Constructs a SegmentMeanShiftFunctionArguments using ArcGIS Engine.
SegmentMeanShiftFunctionArguments(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SegmentMeanShiftFunctionArguments theSegmentMeanShiftFunctionArguments = (SegmentMeanShiftFunctionArguments) obj;
 
Method Summary
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean equals(java.lang.Object o)
          Compare this object with another
 void fromJSON(IJSONObject pJSON, IRasterFunctionTemplateMapper pOptRFTMapper)
          Loads raster function arguments from JSON.
 int getAddedFrameWidth()
          Width of safety frame added around pixel block, in pixel.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 IStringArray getFileList()
          The list of all files associated with the arguments.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getMinNamespaceSupported()
          The minimum namespace the class can serialize to (eg the 90 namespace).
 int getMinNumPixelsPerSegment()
          Segments smaller than this get merged with best fitting neighbor segment.
 IStringArray getNames()
          The list of all argument names.
 int getNumThreadsToUse()
          Number of threads to use.
 java.lang.Object getRaster()
          The input raster.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int getSpatialDetail()
          The spatial detail.
 int getSpatialRadius()
          The radius for mean computation, spatial part.
 double getSpectralDetail()
          The spectral detail.
 double getSpectralRadius()
          The radius for mean computation, spectral part.
 java.lang.Object getValue(java.lang.String name)
          Gets a named argument value.
 IVariantArray getValues()
          The list of all arguments.
 int hashCode()
          the hashcode for this object
 boolean isBoundariesOnly()
          Output segment boundaries only.
 void isDirty()
          isDirty
 void load(IStream pstm)
          load
 void putValue(java.lang.String name, java.lang.Object value)
          Puts a named argument value.
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a SegmentMeanShiftFunctionArguments.
 void remove(java.lang.String name)
          Removes a named argument value.
 void removeAll()
          Removes all argument values.
 void resolve(IRow pRow, IPropertySet pPropertySet)
          Resolves function variables using a row and set of properties.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setAddedFrameWidth(int pAddedFrameWidth)
          Width of safety frame added around pixel block, in pixel.
 void setBoundariesOnly(boolean pBoundaries)
          Output segment boundaries only.
 void setMinNumPixelsPerSegment(int pMinNumPixelsPerSegment)
          Segments smaller than this get merged with best fitting neighbor segment.
 void setNumThreadsToUse(int pNumThreads)
          Number of threads to use.
 void setRasterByRef(java.lang.Object ppImage)
          The input raster.
 void setSpatialDetail(int pDetail)
          The spatial detail.
 void setSpatialRadius(int pRadius)
          The radius for mean computation, spatial part.
 void setSpectralDetail(double pDetail)
          The spectral detail.
 void setSpectralRadius(double pRadius)
          The radius for mean computation, spectral part.
 IJSONObject toJSON()
          Saves raster function arguments to JSON.
 void update(IRow pRow, IPropertySet pPropertySet, IRasterFunctionArguments pTemplateArguments)
          Updates function variables using a row and set of properties.
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

SegmentMeanShiftFunctionArguments

public SegmentMeanShiftFunctionArguments()
                                  throws java.io.IOException,
                                         java.net.UnknownHostException
Constructs a SegmentMeanShiftFunctionArguments using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

SegmentMeanShiftFunctionArguments

public SegmentMeanShiftFunctionArguments(java.lang.Object obj)
                                  throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SegmentMeanShiftFunctionArguments theSegmentMeanShiftFunctionArguments = (SegmentMeanShiftFunctionArguments) obj;

Construct a SegmentMeanShiftFunctionArguments using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SegmentMeanShiftFunctionArguments.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a SegmentMeanShiftFunctionArguments.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

toJSON

public IJSONObject toJSON()
                   throws java.io.IOException,
                          AutomationException
Saves raster function arguments to JSON.

Specified by:
toJSON in interface IRasterFunctionArguments2
Returns:
A reference to a com.esri.arcgis.system.IJSONObject
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

fromJSON

public void fromJSON(IJSONObject pJSON,
                     IRasterFunctionTemplateMapper pOptRFTMapper)
              throws java.io.IOException,
                     AutomationException
Loads raster function arguments from JSON.

Specified by:
fromJSON in interface IRasterFunctionArguments2
Parameters:
pJSON - A reference to a com.esri.arcgis.system.IJSONObject (in)
pOptRFTMapper - A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionTemplateMapper (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValue

public java.lang.Object getValue(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException
Gets a named argument value.

Specified by:
getValue in interface IRasterFunctionArguments
Parameters:
name - The name (in)
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putValue

public void putValue(java.lang.String name,
                     java.lang.Object value)
              throws java.io.IOException,
                     AutomationException
Puts a named argument value.

Specified by:
putValue in interface IRasterFunctionArguments
Parameters:
name - The name (in)
value - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

remove

public void remove(java.lang.String name)
            throws java.io.IOException,
                   AutomationException
Removes a named argument value.

Specified by:
remove in interface IRasterFunctionArguments
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws java.io.IOException,
                      AutomationException
Removes all argument values.

Specified by:
removeAll in interface IRasterFunctionArguments
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNames

public IStringArray getNames()
                      throws java.io.IOException,
                             AutomationException
The list of all argument names.

Specified by:
getNames in interface IRasterFunctionArguments
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValues

public IVariantArray getValues()
                        throws java.io.IOException,
                               AutomationException
The list of all arguments.

Specified by:
getValues in interface IRasterFunctionArguments
Returns:
A reference to a com.esri.arcgis.system.IVariantArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFileList

public IStringArray getFileList()
                         throws java.io.IOException,
                                AutomationException
The list of all files associated with the arguments.

Specified by:
getFileList in interface IRasterFunctionArguments
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resolve

public void resolve(IRow pRow,
                    IPropertySet pPropertySet)
             throws java.io.IOException,
                    AutomationException
Resolves function variables using a row and set of properties.

Specified by:
resolve in interface IRasterFunctionArguments
Parameters:
pRow - A reference to a com.esri.arcgis.geodatabase.IRow (in)
pPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

update

public void update(IRow pRow,
                   IPropertySet pPropertySet,
                   IRasterFunctionArguments pTemplateArguments)
            throws java.io.IOException,
                   AutomationException
Updates function variables using a row and set of properties.

Specified by:
update in interface IRasterFunctionArguments
Parameters:
pRow - A reference to a com.esri.arcgis.geodatabase.IRow (in)
pPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
pTemplateArguments - A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionArguments (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRaster

public java.lang.Object getRaster()
                           throws java.io.IOException,
                                  AutomationException
The input raster. 3 bands (color) or 1 band (greyvalue), 8 bits per band.

Specified by:
getRaster in interface ISegmentMeanShiftFunctionArguments
Returns:
A reference to another Object (IUnknown)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterByRef

public void setRasterByRef(java.lang.Object ppImage)
                    throws java.io.IOException,
                           AutomationException
The input raster. 3 bands (color) or 1 band (greyvalue), 8 bits per band.

Specified by:
setRasterByRef in interface ISegmentMeanShiftFunctionArguments
Parameters:
ppImage - A reference to another Object (IUnknown) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpectralRadius

public double getSpectralRadius()
                         throws java.io.IOException,
                                AutomationException
The radius for mean computation, spectral part.

Specified by:
getSpectralRadius in interface ISegmentMeanShiftFunctionArguments
Returns:
The pRadius
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpectralRadius

public void setSpectralRadius(double pRadius)
                       throws java.io.IOException,
                              AutomationException
The radius for mean computation, spectral part.

Specified by:
setSpectralRadius in interface ISegmentMeanShiftFunctionArguments
Parameters:
pRadius - The pRadius (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpatialRadius

public int getSpatialRadius()
                     throws java.io.IOException,
                            AutomationException
The radius for mean computation, spatial part.

Specified by:
getSpatialRadius in interface ISegmentMeanShiftFunctionArguments
Returns:
The pRadius
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpatialRadius

public void setSpatialRadius(int pRadius)
                      throws java.io.IOException,
                             AutomationException
The radius for mean computation, spatial part.

Specified by:
setSpatialRadius in interface ISegmentMeanShiftFunctionArguments
Parameters:
pRadius - The pRadius (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpectralDetail

public double getSpectralDetail()
                         throws java.io.IOException,
                                AutomationException
The spectral detail. Range [1..20]. Radius = 22 - detail.

Specified by:
getSpectralDetail in interface ISegmentMeanShiftFunctionArguments
Returns:
The pDetail
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpectralDetail

public void setSpectralDetail(double pDetail)
                       throws java.io.IOException,
                              AutomationException
The spectral detail. Range [1..20]. Radius = 22 - detail.

Specified by:
setSpectralDetail in interface ISegmentMeanShiftFunctionArguments
Parameters:
pDetail - The pDetail (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpatialDetail

public int getSpatialDetail()
                     throws java.io.IOException,
                            AutomationException
The spatial detail. Range [1..20]. Radius = 22 - detail.

Specified by:
getSpatialDetail in interface ISegmentMeanShiftFunctionArguments
Returns:
The pDetail
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpatialDetail

public void setSpatialDetail(int pDetail)
                      throws java.io.IOException,
                             AutomationException
The spatial detail. Range [1..20]. Radius = 22 - detail.

Specified by:
setSpatialDetail in interface ISegmentMeanShiftFunctionArguments
Parameters:
pDetail - The pDetail (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinNumPixelsPerSegment

public int getMinNumPixelsPerSegment()
                              throws java.io.IOException,
                                     AutomationException
Segments smaller than this get merged with best fitting neighbor segment.

Specified by:
getMinNumPixelsPerSegment in interface ISegmentMeanShiftFunctionArguments
Returns:
The pMinNumPixelsPerSegment
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinNumPixelsPerSegment

public void setMinNumPixelsPerSegment(int pMinNumPixelsPerSegment)
                               throws java.io.IOException,
                                      AutomationException
Segments smaller than this get merged with best fitting neighbor segment.

Specified by:
setMinNumPixelsPerSegment in interface ISegmentMeanShiftFunctionArguments
Parameters:
pMinNumPixelsPerSegment - The pMinNumPixelsPerSegment (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAddedFrameWidth

public int getAddedFrameWidth()
                       throws java.io.IOException,
                              AutomationException
Width of safety frame added around pixel block, in pixel. Optional. Default is 128.

Specified by:
getAddedFrameWidth in interface ISegmentMeanShiftFunctionArguments
Returns:
The pAddedFrameWidth
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAddedFrameWidth

public void setAddedFrameWidth(int pAddedFrameWidth)
                        throws java.io.IOException,
                               AutomationException
Width of safety frame added around pixel block, in pixel. Optional. Default is 128.

Specified by:
setAddedFrameWidth in interface ISegmentMeanShiftFunctionArguments
Parameters:
pAddedFrameWidth - The pAddedFrameWidth (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isBoundariesOnly

public boolean isBoundariesOnly()
                         throws java.io.IOException,
                                AutomationException
Output segment boundaries only. All other pixel invalid.

Specified by:
isBoundariesOnly in interface ISegmentMeanShiftFunctionArguments
Returns:
The pBoundaries
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBoundariesOnly

public void setBoundariesOnly(boolean pBoundaries)
                       throws java.io.IOException,
                              AutomationException
Output segment boundaries only. All other pixel invalid.

Specified by:
setBoundariesOnly in interface ISegmentMeanShiftFunctionArguments
Parameters:
pBoundaries - The pBoundaries (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNumThreadsToUse

public int getNumThreadsToUse()
                       throws java.io.IOException,
                              AutomationException
Number of threads to use. Optional. Default is 50% of available cores.

Specified by:
getNumThreadsToUse in interface ISegmentMeanShiftFunctionArguments
Returns:
The pNumThreads
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNumThreadsToUse

public void setNumThreadsToUse(int pNumThreads)
                        throws java.io.IOException,
                               AutomationException
Number of threads to use. Optional. Default is 50% of available cores.

Specified by:
setNumThreadsToUse in interface ISegmentMeanShiftFunctionArguments
Parameters:
pNumThreads - The pNumThreads (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException
getClassID

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
isDirty

Specified by:
isDirty in interface IPersistStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException
save

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException
getSizeMax

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException
Serializes an object to XML.

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException
Deserializes an object from XML.

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public java.lang.String getMinNamespaceSupported()
                                          throws java.io.IOException,
                                                 AutomationException
The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:
getMinNamespaceSupported in interface IXMLVersionSupport
Returns:
The namespaceURI
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException