MyCaffe  1.12.2.41
Deep learning software for Windows C# programmers.
MyCaffe.db.image.DatasetExCollection2 Class Reference

[V2 Image Database] The DatasetExCollection2 contains a list of DatasetEx2 objects. More...

Inheritance diagram for MyCaffe.db.image.DatasetExCollection2:

Public Member Functions

 DatasetExCollection2 ()
 The DatasetExCollection2 constructor. More...
 
bool RemoveDataset (DatasetEx2 ds)
 Remove the dataset specified. 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...
 
void Reset ()
 Resets the last image set used to null, thus clearing it. More...
 
void ReloadIndexing (int nDsId)
 Reload the dataset's indexing. More...
 
void ReloadIndexing (string strDs)
 Reload the dataset's indexing. 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...
 
DatasetEx2 FindDataset (int nDatasetID)
 Searches for the dataset with a dataset ID. More...
 
DatasetEx2 FindDataset (string strDs)
 Searches for the dataset with the dataset name. More...
 
DatasetEx2 FindDatasetFromSource (int nSrcId)
 Searches for the dataset containing the given Source ID. More...
 
ImageSet2 FindImageset (int nSourceID)
 Searches for the ImageSet with a given data source ID. More...
 
ImageSet2 FindImageset (string strSource)
 Searches for the ImageSet with a given data source name. More...
 
bool WaitForDatasetToLoad (int nDsId, bool bTraining, bool bTesting, int nWait=int.MaxValue)
 Wait for the dataset loading to complete. More...
 
bool WaitForDatasetToLoad (string strDs, bool bTraining, bool bTesting, int nWait=int.MaxValue)
 Wait for the dataset loading to complete. More...
 
bool WaitForDatasetToRefresh (int nDsId, bool bTraining, bool bTesting, int nWait=int.MaxValue)
 Wait for the dataset refreshing to complete. More...
 
bool WaitForDatasetToRefresh (string strDs, bool bTraining, bool bTesting, int nWait=int.MaxValue)
 Wait for the dataset refreshing to complete. More...
 
bool IsRefreshRunning (int nDsId, bool bTraining, bool bTesting)
 Returns true if the refresh operation running. More...
 
bool IsRefreshRunning (string strDs, bool bTraining, bool bTesting)
 Returns true if the refresh operation running. More...
 
bool StartRefresh (string strDs, bool bTraining, bool bTesting, double dfReplacementPct)
 Start a refresh on the dataset by replacing a specified percentage of the images with images from the physical database. More...
 
bool StopRefresh (string strDs, bool bTraining, bool bTesting)
 Stop a refresh operation running on the dataset. More...
 
bool StartRefresh (int nDsID, bool bTraining, bool bTesting, double dfReplacementPct)
 Start a refresh on the dataset by replacing a specified percentage of the images with images from the physical database. More...
 
bool StopRefresh (int nDsID, bool bTraining, bool bTesting)
 Stop a refresh operation running on the dataset. More...
 
bool StartAutomaticRefreshSchedule (string strDs, bool bTraining, bool bTesting, int nPeriodInMs, double dfReplacementPct)
 Start the automatic refresh cycle to occur on specified period increments. More...
 
bool StopAutomaticRefreshSchedule (string strDs, bool bTraining, bool bTesting)
 Stop the automatic refresh schedule running on a dataset. More...
 
bool GetScheduledAutoRefreshInformation (string strDs, out int nPeriodInMs, out double dfReplacementPct, out int nTrainingRefreshCount, out int nTestingRefreshCount)
 Returns whether or not a scheduled refresh is running and if so at what period and replacement percent. More...
 
bool StartAutomaticRefreshSchedule (int nDsID, bool bTraining, bool bTesting, int nPeriodInMs, double dfReplacementPct)
 Start the automatic refresh cycle to occur on specified period increments. More...
 
bool StopAutomaticRefreshSchedule (int nDsID, bool bTraining, bool bTesting)
 Stop the automatic refresh schedule running on a dataset. More...
 
bool GetScheduledAutoRefreshInformation (int nDsID, out int nPeriodInMs, out double dfReplacementPct, out int nTrainingRefreshCount, out int nTestingRefreshCount)
 Returns whether or not a scheduled refresh is running and if so at what period and replacement percent. More...
 
long CreateQueryState (int nDsId, bool bUseUniqueLabelIndexes=true, bool bUseUniqueImageIndexes=true, IMGDB_SORT sort=IMGDB_SORT.NONE)
 Create a new query state, optionally with a certain sorting. More...
 
long CreateQueryState (string strDs, bool bUseUniqueLabelIndexes=true, bool bUseUniqueImageIndexes=true, IMGDB_SORT sort=IMGDB_SORT.NONE)
 Create a new query state, optionally with a certain sorting. More...
 
bool SetDefaultQueryState (int nDsId, long lQueryState)
 Set the default query state to the query state specified for the dataset specified. More...
 
bool SetDefaultQueryState (string strDs, long lQueryState)
 Set the default query state to the query state specified for the dataset specified. More...
 
bool FreeQueryState (int nDsId, long lHandle)
 Frees a query state from a given dataset. More...
 
bool FreeQueryState (string strDs, long lHandle)
 Frees a query state from a given dataset. More...
 
QueryState FindQueryState (long lQueryState, string strSource)
 Returns the query state based on the handle and data source where the dataset that owns the data source is first located and the query handle is then used to lookup the QueryState for that dataset. More...
 
QueryState FindQueryState (long lQueryState, int nSrcId)
 Returns the query state based on the handle and data source where the dataset that owns the data source is first located and the query handle is then used to lookup the QueryState for that dataset. More...
 
void Add (DatasetEx2 ds)
 Adds a DatasetEx to the collection. More...
 
void Dispose ()
 Releases all resources used by the collection. More...
 
IEnumerator< DatasetEx2GetEnumerator ()
 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...
 
DatasetEx2 this[int nIdx] [get]
 Returns the dataset at a given index. More...
 

Detailed Description

[V2 Image Database] The DatasetExCollection2 contains a list of DatasetEx2 objects.

Definition at line 13 of file DatasetExCollection2.cs.

Constructor & Destructor Documentation

◆ DatasetExCollection2()

MyCaffe.db.image.DatasetExCollection2.DatasetExCollection2 ( )

The DatasetExCollection2 constructor.

Definition at line 23 of file DatasetExCollection2.cs.

Member Function Documentation

◆ Add()

void MyCaffe.db.image.DatasetExCollection2.Add ( DatasetEx2  ds)

Adds a DatasetEx to the collection.

Parameters
dsSpecifies the DatasetEx.

Definition at line 848 of file DatasetExCollection2.cs.

◆ CreateQueryState() [1/2]

long MyCaffe.db.image.DatasetExCollection2.CreateQueryState ( int  nDsId,
bool  bUseUniqueLabelIndexes = true,
bool  bUseUniqueImageIndexes = true,
IMGDB_SORT  sort = IMGDB_SORT.NONE 
)

Create a new query state, optionally with a certain sorting.

Parameters
nDsIdSpecifies the dataset on which to create the query state.
bUseUniqueLabelIndexesOptionally, specifies to use unique label indexes which is slightly slower, but ensures each label is hit per epoch eually (default = true).
bUseUniqueImageIndexesOptionally, specifies to use unique image indexes which is slightly slower, but ensures each image is hit per epoch (default = true).
sortSpecifies the sorting method, if any.
Returns
The query state is returned.

Definition at line 682 of file DatasetExCollection2.cs.

◆ CreateQueryState() [2/2]

long MyCaffe.db.image.DatasetExCollection2.CreateQueryState ( string  strDs,
bool  bUseUniqueLabelIndexes = true,
bool  bUseUniqueImageIndexes = true,
IMGDB_SORT  sort = IMGDB_SORT.NONE 
)

Create a new query state, optionally with a certain sorting.

Parameters
strDsSpecifies the dataset on which to create the query state.
bUseUniqueLabelIndexesOptionally, specifies to use unique label indexes which is slightly slower, but ensures each label is hit per epoch (default = true).
bUseUniqueImageIndexesOptionally, specifies to use unique image indexes which is slightly slower, but ensures each image is hit per epoch (default = true).
sortSpecifies the sorting method, if any.
Returns
The query state is returned.

Definition at line 704 of file DatasetExCollection2.cs.

◆ Dispose() [1/2]

void MyCaffe.db.image.DatasetExCollection2.Dispose ( )

Releases all resources used by the collection.

Definition at line 870 of file DatasetExCollection2.cs.

◆ Dispose() [2/2]

virtual void MyCaffe.db.image.DatasetExCollection2.Dispose ( bool  bDisposing)
protectedvirtual

Releases all resources used by the collection.

Parameters
bDisposingSet to true when called from Dispose().

Definition at line 857 of file DatasetExCollection2.cs.

◆ EnableUsingTrainingSourcesForTesting()

void MyCaffe.db.image.DatasetExCollection2.EnableUsingTrainingSourcesForTesting ( bool  bEnable)

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

Parameters
bEnableEnable/disable the training sources for testing.

Definition at line 164 of file DatasetExCollection2.cs.

◆ FindDataset() [1/2]

DatasetEx2 MyCaffe.db.image.DatasetExCollection2.FindDataset ( int  nDatasetID)

Searches for the dataset with a dataset ID.

Parameters
nDatasetIDSpecifies the dataset ID.
Returns
If found, the DatasetEx is returned, otherwise null is returned.

Definition at line 197 of file DatasetExCollection2.cs.

◆ FindDataset() [2/2]

DatasetEx2 MyCaffe.db.image.DatasetExCollection2.FindDataset ( string  strDs)

Searches for the dataset with the dataset name.

Parameters
strDsSpecifies the dataset name.
Returns
If found, the DatasetEx is returned, otherwise null is returned.

Definition at line 213 of file DatasetExCollection2.cs.

◆ FindDatasetFromSource()

DatasetEx2 MyCaffe.db.image.DatasetExCollection2.FindDatasetFromSource ( int  nSrcId)

Searches for the dataset containing the given Source ID.

Parameters
nSrcIdSpecifies the source ID.
Returns
If found, the dataset is returned.

Definition at line 229 of file DatasetExCollection2.cs.

◆ FindImageset() [1/2]

ImageSet2 MyCaffe.db.image.DatasetExCollection2.FindImageset ( int  nSourceID)

Searches for the ImageSet with a given data source ID.

Parameters
nSourceIDSpecifies the ID of the data source.
Returns
If found, the ImageSet is returned, otherwise an Exception is thrown.

Definition at line 245 of file DatasetExCollection2.cs.

◆ FindImageset() [2/2]

ImageSet2 MyCaffe.db.image.DatasetExCollection2.FindImageset ( string  strSource)

Searches for the ImageSet with a given data source name.

Parameters
strSourceSpecifies the name of the data source.
Returns
If found, the ImageSet is returned, otherwise an Exception is thrown.

Definition at line 272 of file DatasetExCollection2.cs.

◆ FindQueryState() [1/2]

QueryState MyCaffe.db.image.DatasetExCollection2.FindQueryState ( long  lQueryState,
int  nSrcId 
)

Returns the query state based on the handle and data source where the dataset that owns the data source is first located and the query handle is then used to lookup the QueryState for that dataset.

Parameters
lQueryStateSpecifies the query state handle.
nSrcIdSpecifies the dataset source who's dataset is used.
Returns
The query state is returned.

Definition at line 828 of file DatasetExCollection2.cs.

◆ FindQueryState() [2/2]

QueryState MyCaffe.db.image.DatasetExCollection2.FindQueryState ( long  lQueryState,
string  strSource 
)

Returns the query state based on the handle and data source where the dataset that owns the data source is first located and the query handle is then used to lookup the QueryState for that dataset.

Parameters
lQueryStateSpecifies the query state handle.
strSourceSpecifies the dataset source who's dataset is used.
Returns
The query state is returned.

Definition at line 805 of file DatasetExCollection2.cs.

◆ FreeQueryState() [1/2]

bool MyCaffe.db.image.DatasetExCollection2.FreeQueryState ( int  nDsId,
long  lHandle 
)

Frees a query state from a given dataset.

Parameters
nDsIdSpecifies the dataset on which to free the query state.
lHandleSpecifies the handle to the query state to free.
Returns
If found and freed, true is returned, otherwise false.

Definition at line 764 of file DatasetExCollection2.cs.

◆ FreeQueryState() [2/2]

bool MyCaffe.db.image.DatasetExCollection2.FreeQueryState ( string  strDs,
long  lHandle 
)

Frees a query state from a given dataset.

Parameters
strDsSpecifies the dataset name on which to free the query state.
lHandleSpecifies the handle to the query state to free.
Returns
If found and freed, true is returned, otherwise false.

Definition at line 784 of file DatasetExCollection2.cs.

◆ GetEnumerator()

IEnumerator< DatasetEx2 > MyCaffe.db.image.DatasetExCollection2.GetEnumerator ( )

Returns the enumerator for the collection.

Returns
The collection's enumerator is returned.

Definition at line 879 of file DatasetExCollection2.cs.

◆ GetScheduledAutoRefreshInformation() [1/2]

bool MyCaffe.db.image.DatasetExCollection2.GetScheduledAutoRefreshInformation ( int  nDsID,
out int  nPeriodInMs,
out double  dfReplacementPct,
out int  nTrainingRefreshCount,
out int  nTestingRefreshCount 
)

Returns whether or not a scheduled refresh is running and if so at what period and replacement percent.

Parameters
nDsIDSpecifies the dataset name for which the automatic refresh cycle is to run.
nPeriodInMsReturns the period in milliseconds over which the auto refresh cycle is run.
dfReplacementPctReturns the percentage of replacement to use on each cycle.
nTrainingRefreshCountReturns the training refrsh count.
nTestingRefreshCountReturns the testing refresh count.
Returns
If the refresh schedule is running, true is returned, otherwise false.

Definition at line 655 of file DatasetExCollection2.cs.

◆ GetScheduledAutoRefreshInformation() [2/2]

bool MyCaffe.db.image.DatasetExCollection2.GetScheduledAutoRefreshInformation ( string  strDs,
out int  nPeriodInMs,
out double  dfReplacementPct,
out int  nTrainingRefreshCount,
out int  nTestingRefreshCount 
)

Returns whether or not a scheduled refresh is running and if so at what period and replacement percent.

Parameters
strDsSpecifies the dataset name for which the automatic refresh cycle is to run.
nPeriodInMsReturns the period in milliseconds over which the auto refresh cycle is run.
dfReplacementPctReturns the percentage of replacement to use on each cycle.
nTrainingRefreshCountReturns the training refrsh count.
nTestingRefreshCountReturns the testing refresh count.
Returns
If the refresh schedule is running, true is returned, otherwise false.

Definition at line 586 of file DatasetExCollection2.cs.

◆ IsRefreshRunning() [1/2]

bool MyCaffe.db.image.DatasetExCollection2.IsRefreshRunning ( int  nDsId,
bool  bTraining,
bool  bTesting 
)

Returns true if the refresh operation running.

Parameters
nDsIdSpecifies the dataset ID.
bTrainingSpecifies to check the training data source for refresh.
bTestingSpecifies to check the testing data source for refresh.
Returns
If the refresh is running, true is returned, otherwise false.

Definition at line 389 of file DatasetExCollection2.cs.

◆ IsRefreshRunning() [2/2]

bool MyCaffe.db.image.DatasetExCollection2.IsRefreshRunning ( string  strDs,
bool  bTraining,
bool  bTesting 
)

Returns true if the refresh operation running.

Parameters
strDsSpecifies the dataset name.
bTrainingSpecifies to check the training data source for refresh.
bTestingSpecifies to check the testing data source for refresh.
Returns
If the refresh is running, true is returned, otherwise false.

Definition at line 410 of file DatasetExCollection2.cs.

◆ QueryImageMean()

SimpleDatum MyCaffe.db.image.DatasetExCollection2.QueryImageMean ( int  nSrcID)

Returns the image mean for a data source.

Parameters
nSrcIDSpecifies the ID of the data source.
Returns
The image mean queried is returned as a SimpleDatum.

Definition at line 78 of file DatasetExCollection2.cs.

◆ Relabel()

void MyCaffe.db.image.DatasetExCollection2.Relabel ( LabelMappingCollection  col)

Relabels all datasets using a label mapping collection.

Parameters
colSpecifies the label mapping collection.

Definition at line 144 of file DatasetExCollection2.cs.

◆ ReloadIndexing() [1/2]

void MyCaffe.db.image.DatasetExCollection2.ReloadIndexing ( int  nDsId)

Reload the dataset's indexing.

Parameters
nDsIdSpecifies the dataset ID.

Definition at line 102 of file DatasetExCollection2.cs.

◆ ReloadIndexing() [2/2]

void MyCaffe.db.image.DatasetExCollection2.ReloadIndexing ( string  strDs)

Reload the dataset's indexing.

Parameters
strDsSpecifies the dataset name.

Definition at line 123 of file DatasetExCollection2.cs.

◆ RemoveDataset()

bool MyCaffe.db.image.DatasetExCollection2.RemoveDataset ( DatasetEx2  ds)

Remove the dataset specified.

Parameters
dsSpecifies the dataset to remove.
Returns
If the dataset is found and removed, true is returned, otherwise false is returned.

Definition at line 32 of file DatasetExCollection2.cs.

◆ RemoveUser()

bool MyCaffe.db.image.DatasetExCollection2.RemoveUser ( Guid  user)

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

Parameters
userSpecifies the unique user ID.
Returns
Returns true after all users are released from all datasets, false otherwise.

Definition at line 42 of file DatasetExCollection2.cs.

◆ Reset()

void MyCaffe.db.image.DatasetExCollection2.Reset ( )

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

Definition at line 93 of file DatasetExCollection2.cs.

◆ SaveImageMean()

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

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

Parameters
nSrcIDSpecifies the ID of the data source.
sdSpecifies the image mean data.
bUpdateSpecifies whether or not to update the mean image.
Returns
Returns true after a successful save, false otherwise.

Definition at line 62 of file DatasetExCollection2.cs.

◆ SetDefaultQueryState() [1/2]

bool MyCaffe.db.image.DatasetExCollection2.SetDefaultQueryState ( int  nDsId,
long  lQueryState 
)

Set the default query state to the query state specified for the dataset specified.

Parameters
nDsIdSpecifies the dataset ID.
lQueryStateSpecifies the query state to set.
Returns
Returns true on success, false on failure.

Definition at line 724 of file DatasetExCollection2.cs.

◆ SetDefaultQueryState() [2/2]

bool MyCaffe.db.image.DatasetExCollection2.SetDefaultQueryState ( string  strDs,
long  lQueryState 
)

Set the default query state to the query state specified for the dataset specified.

Parameters
strDsSpecifies the dataset name.
lQueryStateSpecifies the query state to set.
Returns
Returns true on success, false on failure.

Definition at line 744 of file DatasetExCollection2.cs.

◆ StartAutomaticRefreshSchedule() [1/2]

bool MyCaffe.db.image.DatasetExCollection2.StartAutomaticRefreshSchedule ( int  nDsID,
bool  bTraining,
bool  bTesting,
int  nPeriodInMs,
double  dfReplacementPct 
)

Start the automatic refresh cycle to occur on specified period increments.

Parameters
nDsIDSpecifies the dataset ID for which the automatic refresh cycle is to run.
bTrainingSpecifies to operate on the training data source.
bTestingSpecifies to operate on the testing data source.
nPeriodInMsSpecifies the period in milliseconds over which the auto refresh cycle is to run.
dfReplacementPctSpecifies the percentage of replacement to use on each cycle.
Returns
If successfully started, true is returned, otherwise false.

Definition at line 613 of file DatasetExCollection2.cs.

◆ StartAutomaticRefreshSchedule() [2/2]

bool MyCaffe.db.image.DatasetExCollection2.StartAutomaticRefreshSchedule ( string  strDs,
bool  bTraining,
bool  bTesting,
int  nPeriodInMs,
double  dfReplacementPct 
)

Start the automatic refresh cycle to occur on specified period increments.

Parameters
strDsSpecifies the dataset name for which the automatic refresh cycle is to run.
bTrainingSpecifies to operate on the training data source.
bTestingSpecifies to operate on the testing data source.
nPeriodInMsSpecifies the period in milliseconds over which the auto refresh cycle is to run.
dfReplacementPctSpecifies the percentage of replacement to use on each cycle.
Returns
If successfully started, true is returned, otherwise false.

Definition at line 544 of file DatasetExCollection2.cs.

◆ StartRefresh() [1/2]

bool MyCaffe.db.image.DatasetExCollection2.StartRefresh ( int  nDsID,
bool  bTraining,
bool  bTesting,
double  dfReplacementPct 
)

Start a refresh on the dataset by replacing a specified percentage of the images with images from the physical database.

Note, this method is only valid when initialized with LoadLimit > 0.

Parameters
nDsIDSpecifies the dataset ID.
bTrainingSpecifies the training data source to refresh.
bTestingSpecifies the testing data source to refresh.
dfReplacementPctOptionally, specifies the replacement percentage to use (default = 0.25 for 25%).
Returns
On succes, true is returned, otherwise false is returned.

Definition at line 491 of file DatasetExCollection2.cs.

◆ StartRefresh() [2/2]

bool MyCaffe.db.image.DatasetExCollection2.StartRefresh ( string  strDs,
bool  bTraining,
bool  bTesting,
double  dfReplacementPct 
)

Start a refresh on the dataset by replacing a specified percentage of the images with images from the physical database.

Note, this method is only valid when initialized with LoadLimit > 0.

Parameters
strDsSpecifies the dataset name.
bTrainingSpecifies the training data source to refresh.
bTestingSpecifies the testing data source to refresh.
dfReplacementPctOptionally, specifies the replacement percentage to use (default = 0.25 for 25%).
Returns
On succes, true is returned, otherwise false is returned.

Definition at line 436 of file DatasetExCollection2.cs.

◆ StopAutomaticRefreshSchedule() [1/2]

bool MyCaffe.db.image.DatasetExCollection2.StopAutomaticRefreshSchedule ( int  nDsID,
bool  bTraining,
bool  bTesting 
)

Stop the automatic refresh schedule running on a dataset.

Parameters
nDsIDSpecifies the dataset ID for which the automatic refresh cycle is to run.
bTrainingSpecifies to operate on the training data source.
bTestingSpecifies to operate on the testing data source.
Returns
If successfully stopped, true is returned, otherwise false.

Definition at line 633 of file DatasetExCollection2.cs.

◆ StopAutomaticRefreshSchedule() [2/2]

bool MyCaffe.db.image.DatasetExCollection2.StopAutomaticRefreshSchedule ( string  strDs,
bool  bTraining,
bool  bTesting 
)

Stop the automatic refresh schedule running on a dataset.

Parameters
strDsSpecifies the dataset name for which the automatic refresh cycle is to run.
bTrainingSpecifies to operate on the training data source.
bTestingSpecifies to operate on the testing data source.
Returns
If successfully stopped, true is returned, otherwise false.

Definition at line 564 of file DatasetExCollection2.cs.

◆ StopRefresh() [1/2]

bool MyCaffe.db.image.DatasetExCollection2.StopRefresh ( int  nDsID,
bool  bTraining,
bool  bTesting 
)

Stop a refresh operation running on the dataset.

Note, this method is only valid when initialized with LoadLimit > 0.

Parameters
nDsIDSpecifies the dataset ID.
bTrainingSpecifies the training data source to strop refreshing.
bTestingSpecifies the testing data source to stop refreshing.
Returns
On succes, true is returned, otherwise false is returned.

Definition at line 518 of file DatasetExCollection2.cs.

◆ StopRefresh() [2/2]

bool MyCaffe.db.image.DatasetExCollection2.StopRefresh ( string  strDs,
bool  bTraining,
bool  bTesting 
)

Stop a refresh operation running on the dataset.

Note, this method is only valid when initialized with LoadLimit > 0.

Parameters
strDsSpecifies the dataset name.
bTrainingSpecifies the training data source to strop refreshing.
bTestingSpecifies the testing data source to stop refreshing.
Returns
On succes, true is returned, otherwise false is returned.

Definition at line 463 of file DatasetExCollection2.cs.

◆ WaitForDatasetToLoad() [1/2]

bool MyCaffe.db.image.DatasetExCollection2.WaitForDatasetToLoad ( int  nDsId,
bool  bTraining,
bool  bTesting,
int  nWait = int.MaxValue 
)

Wait for the dataset loading to complete.

Parameters
nDsIdSpecifies the dataset ID.
bTrainingSpecifies to wait for the training data source to load.
bTestingSpecifies to wait for the testing data source to load.
nWaitSpecifies the amount of time to wait in ms. (default = int.MaxValue).
Returns
If the data source(s) complete loading, true is returned, otherwise false.

Definition at line 302 of file DatasetExCollection2.cs.

◆ WaitForDatasetToLoad() [2/2]

bool MyCaffe.db.image.DatasetExCollection2.WaitForDatasetToLoad ( string  strDs,
bool  bTraining,
bool  bTesting,
int  nWait = int.MaxValue 
)

Wait for the dataset loading to complete.

Parameters
strDsSpecifies the dataset name.
bTrainingSpecifies to wait for the training data source to load.
bTestingSpecifies to wait for the testing data source to load.
nWaitSpecifies the amount of time to wait in ms. (default = int.MaxValue).
Returns
If the data source(s) complete loading, true is returned, otherwise false.

Definition at line 324 of file DatasetExCollection2.cs.

◆ WaitForDatasetToRefresh() [1/2]

bool MyCaffe.db.image.DatasetExCollection2.WaitForDatasetToRefresh ( int  nDsId,
bool  bTraining,
bool  bTesting,
int  nWait = int.MaxValue 
)

Wait for the dataset refreshing to complete.

Parameters
nDsIdSpecifies the dataset ID.
bTrainingSpecifies to wait for the training data source to refresh.
bTestingSpecifies to wait for the testing data source to refresh.
nWaitSpecifies the amount of time to wait in ms. (default = int.MaxValue).
Returns
If the data source(s) complete refreshing, true is returned, otherwise false.

Definition at line 346 of file DatasetExCollection2.cs.

◆ WaitForDatasetToRefresh() [2/2]

bool MyCaffe.db.image.DatasetExCollection2.WaitForDatasetToRefresh ( string  strDs,
bool  bTraining,
bool  bTesting,
int  nWait = int.MaxValue 
)

Wait for the dataset refreshing to complete.

Parameters
strDsSpecifies the dataset name.
bTrainingSpecifies to wait for the training data source to refresh.
bTestingSpecifies to wait for the testing data source to refresh.
nWaitSpecifies the amount of time to wait in ms. (default = int.MaxValue).
Returns
If the data source(s) complete refreshing, true is returned, otherwise false.

Definition at line 368 of file DatasetExCollection2.cs.

Property Documentation

◆ Count

int MyCaffe.db.image.DatasetExCollection2.Count
get

Returns the number of datasets in the collection.

Definition at line 155 of file DatasetExCollection2.cs.

◆ this[int nIdx]

DatasetEx2 MyCaffe.db.image.DatasetExCollection2.this[int nIdx]
get

Returns the dataset at a given index.

Parameters
nIdxSpecifies the index.
Returns
The dataset at a the index is returned.

Definition at line 187 of file DatasetExCollection2.cs.

◆ UseTrainingSourcesForTesting

bool MyCaffe.db.image.DatasetExCollection2.UseTrainingSourcesForTesting
get

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

Definition at line 177 of file DatasetExCollection2.cs.


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