Teh IXTemporalDatabaseBase interface defines the general interface to the in-memory temporal database. More...

Inheritance diagram for MyCaffe.basecode.IXTemporalDatabaseBase:

Public Member Functions
void	SetInitializationProperties (PropertySet prop)
	The SetInitializationProperties method is used to set the initialization properties of the database. More...

int	GetTotalSize (int nDsId, Phase phase, int nHistoricalSteps, int nFutureSteps)
	Returns the total number of blocks in the database where one block is a set of (historical and future steps). More...

SimpleTemporalDatumCollection	QueryTemporalItem (int nQueryIdx, int nSrcId, ref int? nItemIdx, ref int? nValueIdx, DB_LABEL_SELECTION_METHOD? itemSelectionOverride=null, DB_ITEM_SELECTION_METHOD? valueSelectionOverride=null, bool bEnableDebug=false, string strDebugPath=null)
	Returns a block of static, observed and known data from the database where one block is a set of (historical and future steps). More...

void	Reset ()
	Reset the database indexes. 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

Teh IXTemporalDatabaseBase interface defines the general interface to the in-memory temporal database.

Definition at line 826 of file Interfaces.cs.

Member Function Documentation

◆ GetTotalSize()

int MyCaffe.basecode.IXTemporalDatabaseBase.GetTotalSize	(	int	nDsId,
		Phase	phase,
		int	nHistoricalSteps,
		int	nFutureSteps
	)

Returns the total number of blocks in the database where one block is a set of (historical and future steps).

Parameters

nDsId	Specifies the dataset ID.
phase	Specifies the phase who's data size is to be returned.
nHistoricalSteps	Specifies the number of historical steps.
nFutureSteps	Specifies the number of future steps.

Returns: The total number of blocks is returned.

Implemented in MyCaffe.db.temporal.MyCaffeTemporalDatabase.

◆ QueryTemporalItem()

SimpleTemporalDatumCollection MyCaffe.basecode.IXTemporalDatabaseBase.QueryTemporalItem	(	int	nQueryIdx,
		int	nSrcId,
		ref int?	nItemIdx,
		ref int?	nValueIdx,
		DB_LABEL_SELECTION_METHOD?	itemSelectionOverride = `null`,
		DB_ITEM_SELECTION_METHOD?	valueSelectionOverride = `null`,
		bool	bEnableDebug = `false`,
		string	strDebugPath = `null`
	)

Returns a block of static, observed and known data from the database where one block is a set of (historical and future steps).

Parameters

nQueryIdx	Specifies the index of the query within a batch.
nSrcId	Specifies the source ID of the data source.
nItemIdx	Specifies the item index override when not null, returns the item index used.
nValueIdx	Specifies the value index override when not null, returns the index used with in the item.
itemSelectionOverride	Optionally, specifies the item selection method used to select the item (e.g., customer, station, stock symbol)
valueSelectionOverride	Optionally, specifies the value selection method used to select the index within the temporal data of the selected item.
bEnableDebug	Optionally, specifies to enable debug output (default = false).
strDebugPath	Optionally, specifies the debug path where debug images are placed when 'EnableDebug' = true.

Returns: An collection of SimpleTemporalDatum containing the static num, statuc cat, historical num, historical cat, future num, future cat, target and target hist data is returned. If one of the value types are not produced, null is filled in the array slot.

Implemented in MyCaffe.db.temporal.MyCaffeTemporalDatabase.

◆ Reset()

void MyCaffe.basecode.IXTemporalDatabaseBase.Reset ( )

Reset the database indexes.

This method is only used when using sequential selection.

Implemented in MyCaffe.db.temporal.MyCaffeTemporalDatabase.

◆ SetInitializationProperties()

void MyCaffe.basecode.IXTemporalDatabaseBase.SetInitializationProperties ( PropertySet prop )

The SetInitializationProperties method is used to set the initialization properties of the database.

Parameters

prop	Specifies the initialization properties.

This method must be called before any other initialization methods.

Implemented in MyCaffe.db.temporal.MyCaffeTemporalDatabase.

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

◆ GetTotalSize()

◆ QueryTemporalItem()

◆ Reset()

◆ SetInitializationProperties()