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

Inheritance diagram for MyCaffe.basecode.IXImageDatabaseBase:

Public Member Functions
void	SetConnection (ConnectInfo ci)
	Set the database connection to use. More...

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

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

bool	InitializeWithDsId1 (SettingsCaffe s, int nDataSetID, string strEvtCancel=null, int nPadW=0, int nPadH=0)
	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...

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

bool	GetLoadImageDataCriteria ()
	Returns whether or not the image data criteria is loaded with each image.

bool	GetLoadImageDebugData ()
	Returns whether or not the image debug data is loaded with each image.

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

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

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...

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...

int	GetImageCount (int nSrcId, string strFilterVal=null, int? nBoostVal=null, bool bBoostValIsExact=false)
	Returns the number of images in a given data source. 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	ReloadImageSet (int nSrcId)
	Reloads the images of a data source. 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	QueryImage (int nSrcId, int nIdx, IMGDB_LABEL_SELECTION_METHOD? labelSelectionOverride=null, IMGDB_IMAGE_SELECTION_METHOD? imageSelectionOverride=null, int? nLabel=null, bool bLoadDataCriteria=false, bool bLoadDebugData=false)
	Query an image in a given data source. More...

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

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

List< SimpleDatum >	GetImages (int nSrcId, int[] rgIdx, string strFilterVal=null, int? nBoostVal=null, bool bBoostValIsExact=false)
	Returns the array of images in the image set, possibly filtered with the filtering parameters. More...

SimpleDatum	GetImage (int nImageID, params int[] rgSrcId)
	Get the image with a given Raw Image ID. More...

int	FindImageIndex (int nSrcId, DateTime dt, string strDescription)
	Searches for the image index of an image within a data source matching a DateTime/description pattern. More...

SimpleDatum	QueryImageMean (int nSrcId)
	Queries the image mean for a data source from the database on disk. More...

SimpleDatum	QueryImageMeanFromDb (int nSrcId)
	Queries the image mean for a data source from the database on disk. More...

SimpleDatum	GetImageMean (int nSrcId)
	Returns the image mean for a data source. More...

SimpleDatum	QueryImageMeanFromDataset (int nDatasetId)
	Returns the image mean for the Training data source of a given data set. 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...

Detailed Description

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

Definition at line 414 of file Interfaces.cs.

Member Function Documentation

◆ CleanUp()

void MyCaffe.basecode.IXImageDatabaseBase.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.

Parameters

nDsId	Optionally, specifies the dataset previously used.
bForce	Optionally, force the cleanup even if other users are using the database.

◆ FindImageIndex()

int MyCaffe.basecode.IXImageDatabaseBase.FindImageIndex	(	int	nSrcId,
		DateTime	dt,
		string	strDescription
	)

Searches for the image index of an image within a data source matching a DateTime/description pattern.

Optionally, images may have a time-stamp and/or description associated with each image. In such cases searching by the time-stamp + description can be useful in some instances.

Parameters

nSrcId	Specifies the data source ID of the data source to be searched.
dt	Specifies the time-stamp to search for.
strDescription	Specifies the description to search for.

Returns: If found the zero-based index of the image is returned, otherwise -1 is returned.

◆ 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.

◆ GetDatasetById()

DatasetDescriptor MyCaffe.basecode.IXImageDatabaseBase.GetDatasetById ( int nDsId )

Returns the DatasetDescriptor for a given data set ID.

Parameters

nDsId Specifies the data set ID.

Returns: The dataset Descriptor is returned.

◆ GetDatasetByName()

DatasetDescriptor MyCaffe.basecode.IXImageDatabaseBase.GetDatasetByName ( string strDs )

Returns the DatasetDescriptor for a given data set name.

Parameters

strDs Specifies the data set name.

Returns: The dataset Descriptor is returned.

◆ GetDatasetID()

int MyCaffe.basecode.IXImageDatabaseBase.GetDatasetID ( string strDs )

Returns a data set ID given its name.

Parameters

strDs Specifies the data set name.

Returns: The data set ID is returned.

◆ GetDatasetLoadedPercentById()

double MyCaffe.basecode.IXImageDatabaseBase.GetDatasetLoadedPercentById	(	int	nDatasetID,
		out double	dfTraining,
		out double	dfTesting
	)

Returns the percentage that a dataset is loaded into memory.

Parameters

nDatasetID	Specifies the ID of the dataset.
dfTraining	Specifies the percent of training images that are loaded.
dfTesting	Specifies the percent of testing images that are loaded.

Returns: The current image load percent for the dataset is returned..

◆ GetDatasetLoadedPercentByName()

double MyCaffe.basecode.IXImageDatabaseBase.GetDatasetLoadedPercentByName	(	string	strDataset,
		out double	dfTraining,
		out double	dfTesting
	)

Returns the percentage that a dataset is loaded into memory.

Parameters

strDataset	Specifies the name of the dataset.
dfTraining	Specifies the percent of training images that are loaded.
dfTesting	Specifies the percent of testing images that are loaded.

Returns: The current image load percent for the dataset is returned..

◆ GetDatasetName()

string MyCaffe.basecode.IXImageDatabaseBase.GetDatasetName ( int nDsId )

Returns a data set name given its ID.

Parameters

nDsId Specifies the data set ID.

Returns: The data set name is returned.

◆ GetImage()

SimpleDatum MyCaffe.basecode.IXImageDatabaseBase.GetImage	(	int	nImageID,
		params int[]	rgSrcId
	)

Get the image with a given Raw Image ID.

Parameters

nImageID	Specifies the Raw Image ID of the image to get.
rgSrcId	Specifies a list of Source ID's to search for the image.

Returns: The SimpleDatum of the image is returned.

◆ GetImageCount()

int MyCaffe.basecode.IXImageDatabaseBase.GetImageCount	(	int	nSrcId,
		string	strFilterVal = `null`,
		int?	nBoostVal = `null`,
		bool	bBoostValIsExact = `false`
	)

Returns the number of images in a given data source.

Parameters

nSrcId	Specifies the data source ID.
strFilterVal	Optionally, specifies the filter value that the description must match (default = null, which ignores this parameter).
nBoostVal	Optionally, specifies the boost value that the boost must match (default = null, which ignores this parameter).
bBoostValIsExact	Optionally, specifies whether or the boost value (if specified) is to be used literally (exact = true), or as a minimum boost value.

Returns: The number of images is returned.

When using the 'nBoostValue' negative values are used to test the exact match of the boost value with the absolute value of the 'nBoostValue', ande positive values are used to test for boost values that are greater than or equal to the 'nBoostValue'.

◆ GetImageMean()

SimpleDatum MyCaffe.basecode.IXImageDatabaseBase.GetImageMean ( int nSrcId )

Returns the image mean for a data source.

Parameters

nSrcId Specifies the ID of the data source.

Returns: The image mean is returned as a SimpleDatum.

◆ GetImages()

List< SimpleDatum > MyCaffe.basecode.IXImageDatabaseBase.GetImages	(	int	nSrcId,
		int[]	rgIdx,
		string	strFilterVal = `null`,
		int?	nBoostVal = `null`,
		bool	bBoostValIsExact = `false`
	)

Returns the array of images in the image set, possibly filtered with the filtering parameters.

Parameters

nSrcId	Specifies the data source ID.
rgIdx	Specifies an array of indexes to query.
strFilterVal	Optionally, specifies the filter value that the description must match (default = null, which ignores this parameter).
nBoostVal	Optionally, specifies the boost value that the boost must match (default = null, which ignores this parameter).
bBoostValIsExact	Optionally, specifies whether or the boost value (if specified) is to be used literally (exact = true), or as a minimum boost value.

Returns: The list of images is returned.

When using the 'nBoostValue' negative values are used to test the exact match of the boost value with the absolute value of the 'nBoostValue', ande positive values are used to test for boost values that are greater than or equal to the 'nBoostValue'.

◆ GetImagesFromIndex()

List< SimpleDatum > MyCaffe.basecode.IXImageDatabaseBase.GetImagesFromIndex	(	int	nSrcId,
		int	nStartIdx,
		int	nQueryCount = `int.MaxValue`,
		string	strFilterVal = `null`,
		int?	nBoostVal = `null`,
		bool	bBoostValIsExact = `false`,
		bool	bAttemptDirectLoad = `false`
	)

Returns the array of images in the image set, possibly filtered with the filtering parameters.

Parameters

nSrcId	Specifies the data source ID.
nStartIdx	Specifies a starting index from which the query is to start within the set of images.
nQueryCount	Optionally, specifies a number of images to retrieve within the set (default = int.MaxValue).
strFilterVal	Optionally, specifies the filter value that the description must match (default = null, which ignores this parameter).
nBoostVal	Optionally, specifies the boost value that the boost must match (default = null, which ignores this parameter).
bBoostValIsExact	Optionally, specifies whether or the boost value (if specified) is to be used literally (exact = true), or as a minimum boost value.
bAttemptDirectLoad	Optionaly, specifies to directly load all images not already loaded.

Returns: The list of images is returned.

When using the 'nBoostValue' negative values are used to test the exact match of the boost value with the absolute value of the 'nBoostValue', ande positive values are used to test for boost values that are greater than or equal to the 'nBoostValue'.

◆ GetImagesFromTime()

List< SimpleDatum > MyCaffe.basecode.IXImageDatabaseBase.GetImagesFromTime	(	int	nSrcId,
		DateTime	dtStart,
		int	nQueryCount = `int.MaxValue`,
		string	strFilterVal = `null`,
		int?	nBoostVal = `null`,
		bool	bBoostValIsExact = `false`
	)

Returns the array of images in the image set, possibly filtered with the filtering parameters.

Parameters

nSrcId	Specifies the data source ID.
dtStart	Specifies a starting time from which the query is to start within the set of images.
nQueryCount	Optionally, specifies a number of images to retrieve within the set (default = int.MaxValue).
strFilterVal	Optionally, specifies the filter value that the description must match (default = null, which ignores this parameter).
nBoostVal	Optionally, specifies the boost value that the boost must match (default = null, which ignores this parameter).
bBoostValIsExact	Optionally, specifies whether or the boost value (if specified) is to be used literally (exact = true), or as a minimum boost value.

Returns: The list of images is returned.

When using the 'nBoostValue' negative values are used to test the exact match of the boost value with the absolute value of the 'nBoostValue', ande positive values are used to test for boost values that are greater than or equal to the 'nBoostValue'.

◆ 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.

◆ GetSelectionMethod()

Tuple< IMGDB_LABEL_SELECTION_METHOD, IMGDB_IMAGE_SELECTION_METHOD > MyCaffe.basecode.IXImageDatabaseBase.GetSelectionMethod ( )

Returns the label and image selection method used.

Returns: A tuple containing the Label and Image selection method.

◆ GetSourceById()

SourceDescriptor MyCaffe.basecode.IXImageDatabaseBase.GetSourceById ( int nSrcId )

Returns the SourceDescriptor for a given data source ID.

Parameters

nSrcId Specifies the data source ID.

Returns: The SourceDescriptor is returned.

◆ GetSourceByName()

SourceDescriptor MyCaffe.basecode.IXImageDatabaseBase.GetSourceByName ( string strSrc )

Returns the SourceDescriptor for a given data source name.

Parameters

strSrc Specifies the data source name.

Returns: The SourceDescriptor is returned.

◆ GetSourceID()

int MyCaffe.basecode.IXImageDatabaseBase.GetSourceID ( string strSrc )

Returns a data source ID given its name.

Parameters

strSrc Specifies the data source name.

Returns: The data source ID is returned.

◆ GetSourceName()

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

Returns a data source name given its ID.

Parameters

nSrcId Specifies the data source ID.

Returns: The data source name is returned.

◆ GetVersion()

IMGDB_VERSION MyCaffe.basecode.IXImageDatabaseBase.GetVersion ( )

Returns the version of the MyCaffe Image Database being used.

Returns: Returns the version.

◆ InitializeWithDs1()

bool MyCaffe.basecode.IXImageDatabaseBase.InitializeWithDs1	(	SettingsCaffe	s,
		DatasetDescriptor	ds,
		string	strEvtCancel = `null`
	)

Initializes the image database.

Parameters

s	Specifies the caffe settings.
ds	Specifies the data set to load.
strEvtCancel	Specifies the name of the CancelEvent used to cancel load operations.

Returns: Returns true on success, false otherwise.

◆ InitializeWithDsId1()

bool MyCaffe.basecode.IXImageDatabaseBase.InitializeWithDsId1	(	SettingsCaffe	s,
		int	nDataSetID,
		string	strEvtCancel = `null`,
		int	nPadW = `0`,
		int	nPadH = `0`
	)

Initializes the image database.

Parameters

s	Specifies the caffe settings.
nDataSetID	Specifies the database ID of the data set to load.
strEvtCancel	Specifies the name of the CancelEvent used to cancel load operations.
nPadW	Specifies the padding to add to each image width (default = 0).
nPadH	Specifies the padding to add to each image height (default = 0).

Returns: Returns true on success, false otherwise.

◆ InitializeWithDsName1()

bool MyCaffe.basecode.IXImageDatabaseBase.InitializeWithDsName1	(	SettingsCaffe	s,
		string	strDs,
		string	strEvtCancel = `null`
	)

Initializes the image database.

Parameters

s	Specifies the caffe settings.
strDs	Specifies the data set to load.
strEvtCancel	Specifies the name of the CancelEvent used to cancel load operations.

Returns: Returns true on success, false otherwise.

◆ LoadDatasetByID1()

bool MyCaffe.basecode.IXImageDatabaseBase.LoadDatasetByID1	(	int	nDsId,
		string	strEvtCancel = `null`
	)

Load another, 'secondary' dataset.

The primary dataset should be loaded using one of the 'Initialize' methods. This method is provided to allow for loading multiple datasets.

Parameters

nDsId	Specifies the ID of the data set.
strEvtCancel	Specifies the name of the CancelEvent used to cancel load operations.

Returns: When loaded, the handle to the default query state is returned, otherwise 0 is returned.

◆ LoadDatasetByName1()

bool MyCaffe.basecode.IXImageDatabaseBase.LoadDatasetByName1	(	string	strDs,
		string	strEvtCancel = `null`
	)

Load another, 'secondary' dataset.

The primary dataset should be loaded using one of the 'Initialize' methods. This method is provided to allow for loading multiple datasets.

Parameters

strDs	Specifies the name of the data set.
strEvtCancel	Specifies the name of the CancelEvent used to cancel load operations.

Returns: When loaded, the handle to the default query state is returned, otherwise 0 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.

◆ QueryImage()

SimpleDatum MyCaffe.basecode.IXImageDatabaseBase.QueryImage	(	int	nSrcId,
		int	nIdx,
		IMGDB_LABEL_SELECTION_METHOD?	labelSelectionOverride = `null`,
		IMGDB_IMAGE_SELECTION_METHOD?	imageSelectionOverride = `null`,
		int?	nLabel = `null`,
		bool	bLoadDataCriteria = `false`,
		bool	bLoadDebugData = `false`
	)

Query an image in a given data source.

Parameters

nSrcId	Specifies the databse ID of the data source.
nIdx	Specifies the image index to query. Note, the index is only used in non-random image queries.
labelSelectionOverride	Optionally, specifies the label selection method override. The default = null, which directs the method to use the label selection method specified during Initialization.
imageSelectionOverride	Optionally, specifies the image selection method override. The default = null, which directs the method to use the image selection method specified during Initialization.
nLabel	Optionally, specifies a label set to use for the image selection. When specified only images of this label are returned using the image selection method.
bLoadDataCriteria	Specifies to load the data criteria data (default = false).
bLoadDebugData	Specifies to load the debug data (default = false).

Returns: The image SimpleDatum is returned.

◆ QueryImageMean()

SimpleDatum MyCaffe.basecode.IXImageDatabaseBase.QueryImageMean ( int nSrcId )

Queries the image mean for a data source from the database on disk.

Parameters

nSrcId Specifies the ID of the data source.

Returns: The image mean is returned as a SimpleDatum.

◆ QueryImageMeanFromDataset()

SimpleDatum MyCaffe.basecode.IXImageDatabaseBase.QueryImageMeanFromDataset ( int nDatasetId )

Returns the image mean for the Training data source of a given data set.

Parameters

nDatasetId Specifies the data set to use.

Returns: The image mean is returned as a SimpleDatum.

◆ QueryImageMeanFromDb()

SimpleDatum MyCaffe.basecode.IXImageDatabaseBase.QueryImageMeanFromDb ( int nSrcId )

Queries the image mean for a data source from the database on disk.

If the image mean does not exist in the database, one is created, saved and then returned.

Parameters

nSrcId Specifies the ID of the data source.

Returns: The image mean is returned as a SimpleDatum.

◆ ReloadDataset()

bool MyCaffe.basecode.IXImageDatabaseBase.ReloadDataset ( int nDsId )

Reload a data set.

Parameters

nDsId Specifies the ID of the data set.

Returns: If the data set is found, true is returned, otherwise false 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.

◆ SetConnection()

void MyCaffe.basecode.IXImageDatabaseBase.SetConnection ( ConnectInfo ci )

Set the database connection to use.

Parameters

ci	Specifies the connection information.

◆ 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.

◆ SetSelectionMethod()

void MyCaffe.basecode.IXImageDatabaseBase.SetSelectionMethod	(	IMGDB_LABEL_SELECTION_METHOD?	lbl,
		IMGDB_IMAGE_SELECTION_METHOD?	img
	)

Sets the label and image selection methods.

Parameters

lbl	Specifies the label selection method or null to ignore.
img	Specifies the image selection method or null to ignore.

◆ UnloadDatasetById()

bool MyCaffe.basecode.IXImageDatabaseBase.UnloadDatasetById ( int nDatasetID )

The UnloadDataset function unloads a given dataset from memory.

Parameters

nDatasetID Specifies the ID of the dataset to unload.

Specifiying a dataset ID of -1 directs the UnloadDatasetById to unload ALL datasets loaded.

Returns: If the dataset is found and removed, true is returned, otherwise false is returned.

◆ UnloadDatasetByName()

bool MyCaffe.basecode.IXImageDatabaseBase.UnloadDatasetByName ( string strDataset )

The UnloadDataset function unloads a given dataset from memory.

Parameters

strDataset Specifies the name of the dataset to unload.

Returns: If the dataset is found and removed, true is returned, otherwise false is returned.

◆ 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

◆ CleanUp()

◆ FindImageIndex()

◆ GetBoostQueryHitPercentsAsTextFromSourceName()

◆ GetDatasetById()

◆ GetDatasetByName()

◆ GetDatasetID()

◆ GetDatasetLoadedPercentById()

◆ GetDatasetLoadedPercentByName()

◆ GetDatasetName()

◆ GetImage()

◆ GetImageCount()

◆ GetImageMean()

◆ GetImages()

◆ GetImagesFromIndex()

◆ GetImagesFromTime()

◆ GetLabelCountsAsTextFromSourceId()

◆ GetLabelCountsAsTextFromSourceName()

◆ GetLabelName()

◆ GetLabelQueryEpocsAsTextFromSourceName()

◆ GetLabelQueryHitPercentsAsTextFromSourceName()

◆ GetLabels()

◆ GetSelectionMethod()

◆ GetSourceById()

◆ GetSourceByName()

◆ GetSourceID()

◆ GetSourceName()

◆ GetVersion()

◆ InitializeWithDs1()

◆ InitializeWithDsId1()

◆ InitializeWithDsName1()

◆ LoadDatasetByID1()

◆ LoadDatasetByName1()

◆ LoadLabelCounts()

◆ QueryImage()

◆ QueryImageMean()

◆ QueryImageMeanFromDataset()

◆ QueryImageMeanFromDb()

◆ ReloadDataset()

◆ ReloadImageSet()

◆ ResetLabels()

◆ SetConnection()

◆ SetLabelMapping()

◆ SetSelectionMethod()

◆ UnloadDatasetById()

◆ UnloadDatasetByName()

◆ UpdateLabelCounts()

◆ UpdateLabelMapping()