The following table summarizes the interfaces and methods available in the low-level API.
|
Interface |
Description |
|
Analysis |
|
|
Analyze |
Provides the following methods to perform analysis on a particular MediaObject.
analyze
Analyzes a given
setContext Sets the context of the analysis. If you are using only one database, you likely do not need to use this method. However, if you are using more than one database, you need to use an EveContext object to enable the system to find the MediaObject you wish to analyze.
|
|
Distance |
Provides the distance method for calculating the distance between the vectors of two EDFs. |
|
EveContext |
Provides the capability to override default eVe environment settings. |
|
FrameGrabber |
Allows you to extract information from video files using the following methods:
close Closes the video file.
getControlComponent Retrieves the controls (such as volume settings) of the appropriate video player, if available.
getMediaObject Converts the specified frame from a video file into a MediaObject.
getTotalDistance Determines the visual similarity between the current and previous frame. If the visual similarity between frames is greater than the value defined for the frameGrabberMinimumDistance parameter in the eve.properties file, then the current frame is considered a keyframe.
getTotalFrames Determines the total number of frames within a video file.
getVisualComponent Retrieves the component of the appropriate video player that reads and plays the current video file.
gotKeyFrame Determines the visual similarity between the specified frame and the previous frame in a video file. If the visual similarity is greater than the value defined for the frameGrabberMinimumDistance parameter in the eve.properties file, then the current frame is considered a keyframe.
open Opens the video file stored in the specified location.
play Uses the JavaTM Media Framework API (JMF) to read the video file.
setContext Sets the FrameGrabbers context information
skip Jumps to the specified frame within the video file. |
|
ImageManager |
Provides the following methods for manipulating images and converting between image formats.
getImage Retrieves an image from the buffer.
getImage (MediaObject) Retrieves the image (.jpg) stored within a MediaObject.
getSegmentationMask Retrieves a MediaObject's segmentation mask.
getSegmentationMaskIcon Retrieves a MediaObjects segmentation mask. The segmentation mask is retrieved as an icon and can be used within an application.
loadImage Loads an image into eVe for processing.
newMediaObject Creates a new MediaObject. This is useful, for example, if you wish to generate a query image on-the-fly.
resize
Resizes an image to
saveImage Saves an image to disk.
setContext Sets the ImageManager's context information.
supportedImageTypes Returns the list of image types that ImageManager can process. ImageManager currently supports 68 different image file formats. |
|
Storage and Indexing |
|
|
EvePatch |
Unsupported. For eVision internal use only. |
|
MediaCollection |
Provides the following methods for opening, closing, and manipulating MediaCollections and their component MediaObjects.
add Adds a MediaObject to the MediaCollection.
close Closes the current MediaCollection.
create Creates a new MediaCollection in the specified location.
delete (MediaObject) Removes a MediaObject from the MediaCollection.
delete (long) Removes a MediaObject from the MediaCollection.
getCollectionName Returns the name of the MediaCollection.
getKeys Gets all the MediaObject keys in the MediaCollection.
getMediaObject (long) Retrieves the MediaObject with the given key.
getMediaObject (long[]) Retrieves the MediaObjects with the given keys.
getMediaObject (SearchResults)
Retrieves the MediaObject referenced by the
getMediaObject (SearchResults[]) Retrieves the MediaObjects referenced by the SearchResults objects.
getMetadataKeys Returns all the unique metadata keys in the MediaCollection.
getMetadataValues Returns all the unique values for the key you specify in the MediaCollection.
getProperties Returns all the properties associated with the MediaCollection. Currently the only property set is the MediaCollection's name, but you can set any serializable object as a property.
getProperty Retrieves a property object from the MediaCollection. Because MediaCollections may contain multiple property items with the same key, as long as the values are different, getProperty() returns an object that may contain multiple items.
metadataFind (String) Finds metadata items with a particular key in all of the MediaObjects in the MediaCollection.
metadataFind (String, String) Finds all MediaObjects containing a particular key-value pair in the MediaCollection.
open
Opens the MediaCollection contained in the directory stored in
reorganize Optimizes the data structures within the MediaCollection to allow for faster searching.
save Saves changes to the current MediaCollection.
search (MediaObject, SearchParameters) Performs a search against the MediaCollection using the given MediaObject as a source.
search (MediaObject, SearchParameters, SearchResults[]) Performs a search against a set of search results using the given MediaObject and search parameters.
search (MediaObject, SearchParameters, MediaObject[]) Performs a search against a list of MediaObjects, using the given MediaObject and search parameters.
setCollectionName
Sets the name of the MediaCollection to
setContext Sets the context information for the MediaCollection.
setProperty Sets a property in a MediaCollection.
size Reports the number of MediaObjects in the MediaCollection.
update Replaces a MediaObject in the MediaCollection with a new MediaObject of the same name.
|
|
MediaObject |
Provides the following methods for opening, closing, and manipulating MediaObjects.
addMetadata Adds a metadata item to the MediaObject.
applyPatch Applies an EvePatch to the MediaObject.
deleteMetadata (String) Removes a metadata item from the MediaObject.
deleteMetadata (String, String) Removes a metadata item from the MediaObject.
getBlueChannel Retrieves the contents of the image's blue channel as an array of pixel values.
getCollectionName Retrieves the name of the MediaCollection in which the MediaObject is stored.
getGreenChannel Retrieves the contents of the image's green channel as an array of pixel values.
getHeight Retrieves the height of the MediaObject's image.
getIndex Retrieves the image's index signature of the requested type from the MediaObject.
getKey Retrieves the MediaObject's index key.
getMetadata Retrieves all of the MediaObject's metadata.
getMetadata (String, String) Retrieves the specified metadata item, if it exists.
getProperties Retrieves all of a MediaObject's properties.
getProperty Retrieves a property from the MediaObject.
getRedChannel Retrieves the contents of the image's red channel as an array of pixel values.
getWidth Retrieves the width of the MediaObject's image.
loadFrom Loads a MediaObject from an EDF file on disk.
loadImage Loads an image into the MediaObject.
makeArray Creates a single-dimensional array of MediaObjects of the specified length.
purge
Cleans up a MediaObject. The
saveTo Writes the MediaObject to an EDF file on disk to support serialization.
setCollectionName Sets the name of the MediaCollection in which the MediaObject is stored.
setColorPlanes Allows you to manually create an image by specifying pixel maps for each of its three color planes.
setContext Sets the context information for the MediaObject.
setHeight Sets the height of the MediaObject's image.
setIndex Sets an index directly within the MediaObject.
setKey Sets the MediaObject's index key.
setProperty Sets the given property for the MediaObject.
setWidth Sets the width of the MediaObject's image.
updateMetadata Assigns a new value to an existing metadata item.
|
|
Metadata |
Provides the following methods for adding and manipulating metadata.
getCollectionName Gets the name of the MediaCollection in which the metadata is stored.
getID Gets the unique ID of the metadata item.
getKey Gets the key of the metadata item.
getValue Gets the value of the metadata item.
setCollectionName Sets the name of the MediaCollection in which the metadata item is stored.
setID Sets the unique ID of the metadata item.
setKey Sets the key of the metadata item.
setValue Sets the value of the metadata item. |
|
Search and Retrieval |
|
|
SearchParameters |
Provides the following methods for setting and manipulating search parameters.
getAscending Reports whether search results will be ordered in ascending or descending order. Normally, results are returned in descending order.
getSearch Determines if a particular type of search is enabled.
getWeight Reports the weighting of a particular search type, such as region or texture.
setAscending Instructs the search to order results in ascending or descending order.
setSearch (int, boolean, double) Sets the search options for the SearchParameters object.
setSearch (int, double) Sets the search options for the SearchParameters object. |
|
SearchResults |
Provides the following methods for getting and manipulating search results.
and Performs a logical AND operation on two arrays of SearchResults objects.
append Concatenates two arrays of SearchResults.
chop Truncates the array of SearchResults to the given length.
distanceSort Takes an unordered array of SearchResults objects and sorts it according to distance.
getCollectionName Gets the name of the MediaCollection being searched.
getDistance Gets the current result's distance from the target image.
getKey Gets the key of the MediaObject to which the SearchResults object refers.
getRank Retrieves the current result's rank relative to the other results of the search.
getSimilarity Returns the similarity score of the search result against the target image.
makeArray (int) Creates a one-dimensional array of SearchResults objects of the specified length.
makeArray (long[]) Creates a one-dimensional array of SearchResults objects and populates it with the given objects.
normalize Normalizes a set of SearchResults and its associated parameters.
not Performs a logical NOT operation on two arrays of SearchResults objects.
or Performs a logical OR operation on two arrays of SearchResults objects.
rank Assigns a ranking to each member of the given array of SearchResults objects.
rankSort Sorts the given array of ranked (but unordered) SearchResults objects and populates it with the given SearchResults objects, ordered according to their rankings.
setCollectionName Sets the name of the MediaCollection being searched.
setContext Sets the context of the search results.
setDistance Sets the current result's distance from the target image.
setKey Sets the key of the SearchResults object.
setRank Sets the rank of the current result relative to the other results of the search.
setSimilarity Sets the degree of similarity between the search result and the target image.
similaritySort Takes the given array of unordered SearchResults objects and sorts it according to the objects' similarity scores.
|
|
Vocabulary |
create(MediaCollection, long[], SearchParameters, double, int) Use this method to generate a Visual Vocabulary for a specific location/folder based on the values defined for the parameters.
create(MediaCollection, SearchParameters, double, int) Use this method to generate a Visual Vocabulary for a database of images based on the values defined for the parameters.
setContext Sets the Vocabularys context information. |
|
EveException |
Provides exception handling to eVe programs.
This is an extension of the Java |