The IXImageDatabaseBase interface defines the general interface to the in-memory image database. More...

Inheritance diagram for MyCaffe.basecode.IXImageDatabaseBase:

Public Member Functions
string	GetBoostQueryHitPercentsAsTextFromSourceName (string strSource)
	Returns a string with the query hit percent for each boost (e.g. the percentage that each boost value has been queried). More...

string	GetLabelQueryHitPercentsAsTextFromSourceName (string strSource)
	Returns a string with the query hit percent for each label (e.g. the percentage that each label has been queried). More...

string	GetLabelQueryEpocsAsTextFromSourceName (string strSource)
	Returns a string with the query epoch counts for each label (e.g. the number of times all images with the label have been queried). More...

bool	ReloadImageSet (int nSrcId)
	Reloads the images of a data source. More...

List< LabelDescriptor >	GetLabels (int nSrcId)
	Returns a list of LabelDescriptors associated with the labels within a data source. More...

string	GetLabelName (int nSrcId, int nLabel)
	Returns the text name of a given label within a data source. More...

void	SetLabelMapping (int nSrcId, LabelMapping map)
	Sets the label mapping to the database for a given data source. More...

void	UpdateLabelMapping (int nSrcId, int nNewLabel, List< int > rgOriginalLabels)
	Updates the label mapping in the database for a given data source. More...

void	ResetLabels (int nProjectId, int nSrcId)
	Resets all labels within a data source, used by a project, to their original labels. More...

void	UpdateLabelCounts (int nProjectId, int nSrcId)
	Updates the number of images of each label within a data source. More...

Dictionary< int, int >	LoadLabelCounts (int nSrcId)
	Returns a label lookup of counts for a given data source. More...

string	GetLabelCountsAsTextFromSourceId (int nSrcId)
	Returns a string with all label counts for a data source. More...

string	GetLabelCountsAsTextFromSourceName (string strSource)
	Returns a string with all label counts for a data source. More...

Public Member Functions inherited from MyCaffe.basecode.IXDatabaseBase
void	SetConnection (ConnectInfo ci)
	Set the database connection to use. More...

bool	InitializeWithDsName1 (SettingsCaffe s, string strDs, string strEvtCancel=null, PropertySet prop=null)
	Initializes the image database. More...

bool	InitializeWithDs1 (SettingsCaffe s, DatasetDescriptor ds, string strEvtCancel=null, PropertySet prop=null)
	Initializes the image database. More...

bool	InitializeWithDsId1 (SettingsCaffe s, int nDataSetID, string strEvtCancel=null, int nPadW=0, int nPadH=0, PropertySet prop=null)
	Initializes the image database. More...

bool	LoadDatasetByID1 (int nDsId, string strEvtCancel=null)
	Load another, 'secondary' dataset. More...

bool	LoadDatasetByName1 (string strDs, string strEvtCancel=null)
	Load another, 'secondary' dataset. More...

void	CleanUp (int nDsId=0, bool bForce=false)
	Releases the image database, and if this is the last instance using the in-memory database, frees all memory used. More...

DB_VERSION	GetVersion ()
	Returns the version of the MyCaffe Image Database being used. More...

bool	GetLoadItemDataCriteria ()
	Returns whether or not the item data criteria is loaded with each item.

bool	GetLoadItemDebugData ()
	Returns whether or not the item debug data is loaded with each item.

double	GetDatasetLoadedPercentByName (string strDataset, out double dfTraining, out double dfTesting)
	Returns the percentage that a dataset is loaded into memory. More...

double	GetDatasetLoadedPercentById (int nDatasetID, out double dfTraining, out double dfTesting)
	Returns the percentage that a dataset is loaded into memory. More...

int	GetItemCount (int nSrcId, string strFilterVal=null, int? nBoostVal=null, bool bBoostValIsExact=false)
	Returns the number of items (e.g., images, or temporal items) in a given data source. More...

Tuple< DB_LABEL_SELECTION_METHOD, DB_ITEM_SELECTION_METHOD >	GetSelectionMethod ()
	Returns the label and image selection method used. More...

void	SetSelectionMethod (DB_LABEL_SELECTION_METHOD? lbl, DB_ITEM_SELECTION_METHOD? img)
	Sets the label and image selection methods. More...

SourceDescriptor	GetSourceById (int nSrcId)
	Returns the SourceDescriptor for a given data source ID. More...

SourceDescriptor	GetSourceByName (string strSrc)
	Returns the SourceDescriptor for a given data source name. More...

string	GetSourceName (int nSrcId)
	Returns a data source name given its ID. More...

int	GetSourceID (string strSrc)
	Returns a data source ID given its name. More...

DatasetDescriptor	GetDatasetById (int nDsId)
	Returns the DatasetDescriptor for a given data set ID. More...

DatasetDescriptor	GetDatasetByName (string strDs)
	Returns the DatasetDescriptor for a given data set name. More...

string	GetDatasetName (int nDsId)
	Returns a data set name given its ID. More...

int	GetDatasetID (string strDs)
	Returns a data set ID given its name. More...

bool	ReloadDataset (int nDsId)
	Reload a data set. More...

bool	UnloadDatasetByName (string strDataset)
	The UnloadDataset function unloads a given dataset from memory. More...

bool	UnloadDatasetById (int nDatasetID)
	The UnloadDataset function unloads a given dataset from memory. More...

SimpleDatum	QueryItem (int nSrcId, int nIdx, DB_LABEL_SELECTION_METHOD? labelSelectionOverride=null, DB_ITEM_SELECTION_METHOD? imageSelectionOverride=null, int? nLabel=null, bool bLoadDataCriteria=false, bool bLoadDebugData=false)
	Query an image in a given data source. More...

List< SimpleDatum >	GetItemsFromIndex (int nSrcId, int nStartIdx, int nQueryCount=int.MaxValue, string strFilterVal=null, int? nBoostVal=null, bool bBoostValIsExact=false, bool bAttemptDirectLoad=false)
	Returns the array of items (e.g., images or temporal items) in the item set, possibly filtered with the filtering parameters. More...

List< SimpleDatum >	GetItemsFromTime (int nSrcId, DateTime dtStart, int nQueryCount=int.MaxValue, string strFilterVal=null, int? nBoostVal=null, bool bBoostValIsExact=false)
	Returns the array of items (e.g., images or temporal items) in the item set, possibly filtered with the filtering parameters. More...

List< SimpleDatum >	GetItems (int nSrcId, int[] rgIdx, string strFilterVal=null, int? nBoostVal=null, bool bBoostValIsExact=false)
	Returns the array of items (e.g., images or temporal items) in the item set, possibly filtered with the filtering parameters. More...

SimpleDatum	GetItem (int nItemID, params int[] rgSrcId)
	Get the item (e.g., image or temporal item) with a given Raw Item ID. More...

int	FindItemIndex (int nSrcId, DateTime dt, string strDescription)
	Searches for the item (e.g., image or temporal item) index of an image within a data source matching a DateTime/description pattern. More...

SimpleDatum	QueryItemMean (int nSrcId)
	Queries the item (e.g., image or temporal item) mean for a data source from the database on disk. More...

SimpleDatum	QueryItemMeanFromDb (int nSrcId)
	Queries the item (e.g., image or temporal item) mean for a data source from the database on disk. More...

SimpleDatum	GetItemMean (int nSrcId)
	Returns the item (e.g., image or temporal item) mean for a data source. More...

SimpleDatum	QueryItemMeanFromDataset (int nDatasetId)
	Returns the item (e.g., image or temporal item) mean for the Training data source of a given data set. More...

Detailed Description

The IXImageDatabaseBase interface defines the general interface to the in-memory image database.

Definition at line 877 of file Interfaces.cs.

Member Function Documentation

◆ GetBoostQueryHitPercentsAsTextFromSourceName()

string MyCaffe.basecode.IXImageDatabaseBase.GetBoostQueryHitPercentsAsTextFromSourceName ( string strSource )

Returns a string with the query hit percent for each boost (e.g. the percentage that each boost value has been queried).

Parameters

strSource Specifies the data source who's hit percentages are to be retrieved.

Returns: A string representing the query hit percentages is returned.

◆ GetLabelCountsAsTextFromSourceId()

string MyCaffe.basecode.IXImageDatabaseBase.GetLabelCountsAsTextFromSourceId ( int nSrcId )

Returns a string with all label counts for a data source.

Parameters

nSrcId Specifies the ID of the data source.

Returns: A string containing all label counts is returned.

◆ GetLabelCountsAsTextFromSourceName()

string MyCaffe.basecode.IXImageDatabaseBase.GetLabelCountsAsTextFromSourceName ( string strSource )

Returns a string with all label counts for a data source.

Parameters

strSource Specifies the name of the data source.

Returns: A string containing all label counts is returned.

◆ GetLabelName()

string MyCaffe.basecode.IXImageDatabaseBase.GetLabelName	(	int	nSrcId,
		int	nLabel
	)

Returns the text name of a given label within a data source.

Parameters

nSrcId	Specifies the data source ID.
nLabel	Specifies the label.

Returns: The laben name is returned as a string.

◆ GetLabelQueryEpocsAsTextFromSourceName()

string MyCaffe.basecode.IXImageDatabaseBase.GetLabelQueryEpocsAsTextFromSourceName ( string strSource )

Returns a string with the query epoch counts for each label (e.g. the number of times all images with the label have been queried).

Parameters

strSource Specifies the data source who's query epochs are to be retrieved.

Returns: A string representing the query epoch counts is returned.

◆ GetLabelQueryHitPercentsAsTextFromSourceName()

string MyCaffe.basecode.IXImageDatabaseBase.GetLabelQueryHitPercentsAsTextFromSourceName ( string strSource )

Returns a string with the query hit percent for each label (e.g. the percentage that each label has been queried).

Parameters

strSource Specifies the data source who's hit percentages are to be retrieved.

Returns: A string representing the query hit percentages is returned.

◆ GetLabels()

List< LabelDescriptor > MyCaffe.basecode.IXImageDatabaseBase.GetLabels ( int nSrcId )

Returns a list of LabelDescriptors associated with the labels within a data source.

Parameters

nSrcId Specifies the data source ID.

Returns: The list of LabelDescriptors is returned.

◆ LoadLabelCounts()

Dictionary< int, int > MyCaffe.basecode.IXImageDatabaseBase.LoadLabelCounts ( int nSrcId )

Returns a label lookup of counts for a given data source.

Parameters

nSrcId Specifies the ID of the data source.

Returns: A dictionary containing label,count pairs is returned.

◆ ReloadImageSet()

bool MyCaffe.basecode.IXImageDatabaseBase.ReloadImageSet ( int nSrcId )

Reloads the images of a data source.

Parameters

nSrcId Specifies the ID of the data source.

Returns: If the data source is found, true is returned, otherwise false is returned.

◆ ResetLabels()

void MyCaffe.basecode.IXImageDatabaseBase.ResetLabels	(	int	nProjectId,
		int	nSrcId
	)

Resets all labels within a data source, used by a project, to their original labels.

Parameters

nProjectId	Specifies the ID of the project.
nSrcId	Specifies the ID of the data source.

◆ SetLabelMapping()

void MyCaffe.basecode.IXImageDatabaseBase.SetLabelMapping	(	int	nSrcId,
		LabelMapping	map
	)

Sets the label mapping to the database for a given data source.

Parameters

nSrcId	Specifies the ID of the data source.
map	Specifies the label mapping to set.

◆ UpdateLabelCounts()

void MyCaffe.basecode.IXImageDatabaseBase.UpdateLabelCounts	(	int	nProjectId,
		int	nSrcId
	)

Updates the number of images of each label within a data source.

Parameters

nProjectId	Specifies a project ID.
nSrcId	Specifies the ID of the data source.

◆ UpdateLabelMapping()

void MyCaffe.basecode.IXImageDatabaseBase.UpdateLabelMapping	(	int	nSrcId,
		int	nNewLabel,
		List< int >	rgOriginalLabels
	)

Updates the label mapping in the database for a given data source.

Parameters

nSrcId	Specifies the ID of the data source.
nNewLabel	Specifies a new label.
rgOriginalLabels	Specifies the original lables that are mapped to the new label.

The documentation for this interface was generated from the following file:

C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe.basecode/Interfaces.cs

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetBoostQueryHitPercentsAsTextFromSourceName()

◆ GetLabelCountsAsTextFromSourceId()

◆ GetLabelCountsAsTextFromSourceName()

◆ GetLabelName()

◆ GetLabelQueryEpocsAsTextFromSourceName()

◆ GetLabelQueryHitPercentsAsTextFromSourceName()

◆ GetLabels()

◆ LoadLabelCounts()

◆ ReloadImageSet()

◆ ResetLabels()

◆ SetLabelMapping()

◆ UpdateLabelCounts()

◆ UpdateLabelMapping()