MyCaffe.db.image.DatasetExCollection Class Reference

The DatasetExCollection contains a list of DatasetEx objects. More...

Inheritance diagram for MyCaffe.db.image.DatasetExCollection:

Public Member Functions
	DatasetExCollection ()
	The DatasetExCollection constructor. More...
bool	RemoveDataset (DatasetEx ds)
	Remove the dataset specified. More...
void	RemoveCreatedDatasets ()
	Remove all dynamically created datasets. More...
bool	RemoveUser (Guid user)
	Removes a user from the list of users using the DatasetExCollection. More...
bool	SaveImageMean (int nSrcID, SimpleDatum sd, bool bUpdate)
	Saves the image mean in a SimpleDatum to the database for a data source. More...
SimpleDatum	QueryImageMean (int nSrcID)
	Returns the image mean for a data source. More...
DatasetExCollection	Clone ()
	Creates a copy of the entire DatasetExCollection. More...
void	Reset ()
	Resets the last image set used to null, thus clearing it. More...
void	Relabel (LabelMappingCollection col)
	Relabels all datasets using a label mapping collection. More...
void	EnableUsingTrainingSourcesForTesting (bool bEnable)
	Enable/disable the using of the training sources for testing on all datasets. More...
DatasetEx	FindDataset (int nDatasetID)
	Searches for the dataset with a dataset ID. More...
DatasetEx	FindDataset (string strDs)
	Searches for the dataset with the dataset name. More...
ImageSet	FindImageset (int nSourceID)
	Searches for the ImageSet with a given data source ID. More...
ImageSet	FindImageset (string strSource)
	Searches for the ImageSet with a given data source name. More...
void	Add (DatasetEx ds)
	Adds a DatasetEx to the collection. More...
void	Dispose ()
	Releases all resources used by the collection. More...
IEnumerator< DatasetEx >	GetEnumerator ()
	Returns the enumerator for the collection. More...

Protected Member Functions
virtual void	Dispose (bool bDisposing)
	Releases all resources used by the collection. More...

Properties
int	Count [get]
	Returns the number of datasets in the collection. More...
bool	UseTrainingSourcesForTesting [get]
	Returns whether or not the training sources are set to be used for testing. More...
DatasetEx	this[int nIdx] [get]
	Returns the dataset at a given index. More...

Detailed Description

The DatasetExCollection contains a list of DatasetEx objects.

Definition at line 12 of file DatasetExCollection.cs.

Constructor & Destructor Documentation

DatasetExCollection()

MyCaffe.db.image.DatasetExCollection.DatasetExCollection

(

)

The DatasetExCollection constructor.

Definition at line 22 of file DatasetExCollection.cs.

Member Function Documentation

Add()

void MyCaffe.db.image.DatasetExCollection.Add

(

DatasetEx

ds

)

Adds a DatasetEx to the collection.

Parameters

ds	Specifies the DatasetEx.

Definition at line 276 of file DatasetExCollection.cs.

Clone()

DatasetExCollection MyCaffe.db.image.DatasetExCollection.Clone

(

)

Creates a copy of the entire DatasetExCollection.

Returns

The new DatasetExCollection is returned.

Definition at line 112 of file DatasetExCollection.cs.

Dispose() [1/2]

void MyCaffe.db.image.DatasetExCollection.Dispose

(

)

Releases all resources used by the collection.

Definition at line 298 of file DatasetExCollection.cs.

Dispose() [2/2]

virtual void MyCaffe.db.image.DatasetExCollection.Dispose ( bool  bDisposing )

protectedvirtual

Releases all resources used by the collection.

Parameters

bDisposing

Set to true when called from Dispose().

Definition at line 285 of file DatasetExCollection.cs.

EnableUsingTrainingSourcesForTesting()

void MyCaffe.db.image.DatasetExCollection.EnableUsingTrainingSourcesForTesting

(

bool

bEnable

)

Enable/disable the using of the training sources for testing on all datasets.

Parameters

bEnable

Enable/disable the training sources for testing.

Definition at line 158 of file DatasetExCollection.cs.

FindDataset() [1/2]

DatasetEx MyCaffe.db.image.DatasetExCollection.FindDataset

(

int

nDatasetID

)

Searches for the dataset with a dataset ID.

Parameters

nDatasetID

Specifies the dataset ID.

Returns

If found, the DatasetEx is returned, otherwise null is returned.

Definition at line 191 of file DatasetExCollection.cs.

FindDataset() [2/2]

DatasetEx MyCaffe.db.image.DatasetExCollection.FindDataset

(

string

strDs

)

Searches for the dataset with the dataset name.

Parameters

strDs

Specifies the dataset name.

Returns

If found, the DatasetEx is returned, otherwise null is returned.

Definition at line 207 of file DatasetExCollection.cs.

FindImageset() [1/2]

ImageSet MyCaffe.db.image.DatasetExCollection.FindImageset

(

int

nSourceID

)

Searches for the ImageSet with a given data source ID.

Parameters

nSourceID

Specifies the ID of the data source.

Returns

If found, the ImageSet is returned, otherwise an Exception is thrown.

Definition at line 223 of file DatasetExCollection.cs.

FindImageset() [2/2]

ImageSet MyCaffe.db.image.DatasetExCollection.FindImageset

(

string

strSource

)

Searches for the ImageSet with a given data source name.

Parameters

strSource

Specifies the name of the data source.

Returns

If found, the ImageSet is returned, otherwise an Exception is thrown.

Definition at line 250 of file DatasetExCollection.cs.

GetEnumerator()

IEnumerator< DatasetEx > MyCaffe.db.image.DatasetExCollection.GetEnumerator

(

)

Returns the enumerator for the collection.

Returns

The collection's enumerator is returned.

Definition at line 307 of file DatasetExCollection.cs.

QueryImageMean()

SimpleDatum MyCaffe.db.image.DatasetExCollection.QueryImageMean

(

int

nSrcID

)

Returns the image mean for a data source.

Parameters

nSrcID

Specifies the ID of the data source.

Returns

The image mean queried is returned as a SimpleDatum.

Definition at line 96 of file DatasetExCollection.cs.

Relabel()

void MyCaffe.db.image.DatasetExCollection.Relabel

(

LabelMappingCollection

col

)

Relabels all datasets using a label mapping collection.

Parameters

col	Specifies the label mapping collection.

Definition at line 138 of file DatasetExCollection.cs.

RemoveCreatedDatasets()

void MyCaffe.db.image.DatasetExCollection.RemoveCreatedDatasets

(

)

Remove all dynamically created datasets.

Definition at line 39 of file DatasetExCollection.cs.

RemoveDataset()

bool MyCaffe.db.image.DatasetExCollection.RemoveDataset

(

DatasetEx

ds

)

Remove the dataset specified.

Parameters

ds	Specifies the dataset to remove.

Returns

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

Definition at line 31 of file DatasetExCollection.cs.

RemoveUser()

bool MyCaffe.db.image.DatasetExCollection.RemoveUser

(

Guid

user

)

Removes a user from the list of users using the DatasetExCollection.

Parameters

user	Specifies the unique user ID.

Returns

Returns true after all users are released from all datasets, false otherwise.

Definition at line 60 of file DatasetExCollection.cs.

Reset()

void MyCaffe.db.image.DatasetExCollection.Reset

(

)

Resets the last image set used to null, thus clearing it.

Definition at line 129 of file DatasetExCollection.cs.

SaveImageMean()

bool MyCaffe.db.image.DatasetExCollection.SaveImageMean	(	int	nSrcID,
		SimpleDatum	sd,
		bool	bUpdate
	)

Saves the image mean in a SimpleDatum to the database for a data source.

Parameters

nSrcID	Specifies the ID of the data source.
sd	Specifies the image mean data.
bUpdate	Specifies whether or not to update the mean image.

Returns

Returns true after a successful save, false otherwise.

Definition at line 80 of file DatasetExCollection.cs.

Property Documentation

Count

int MyCaffe.db.image.DatasetExCollection.Count

get

Returns the number of datasets in the collection.

Definition at line 149 of file DatasetExCollection.cs.

this[int nIdx]

DatasetEx MyCaffe.db.image.DatasetExCollection.this[int nIdx]

get

Returns the dataset at a given index.

Parameters

nIdx	Specifies the index.

Returns

The dataset at a the index is returned.

Definition at line 181 of file DatasetExCollection.cs.

UseTrainingSourcesForTesting

bool MyCaffe.db.image.DatasetExCollection.UseTrainingSourcesForTesting

get

Returns whether or not the training sources are set to be used for testing.

Definition at line 171 of file DatasetExCollection.cs.

---

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

• C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe.db.image/DatasetExCollection.cs